From e500f48783c218bc4993987dc033e80d933f5535 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 16:16:12 +0200 Subject: [PATCH 01/11] Drive CLI codegen from a checked-in cli.json Generate the workspace and account command stubs from a checked-in .codegen/cli.json instead of reflecting over an external API spec, so codegen is reproducible from data committed to this repo. - internal/cligen: a self-contained, data-driven generator (model, templates, name/casing derivation) that renders the command stubs from cli.json - bundle/internal/schema: read API annotations (descriptions, enums, field behaviors) directly from cli.json; drop the OpenAPI pseudo-spec reconstruction and the raw-spec environment path - Taskfile: wire the cli.json-based generators into `task generate` - regenerate the committed codegen artifacts from cli.json Co-authored-by: Isaac --- .codegen/.gitattributes | 1 + .codegen/cli.json | 191065 +++++++++++++++ .golangci.yaml | 1 + Taskfile.yml | 110 +- .../direct/dresources/resources.generated.yml | 5 - bundle/direct/tools/generate_apitypes.py | 10 +- bundle/direct/tools/generate_resources.py | 24 +- bundle/docsgen/output/resources.md | 43 + bundle/internal/schema/annotations.go | 2 +- .../internal/schema/annotations_openapi.yml | 234 - bundle/internal/schema/cli_json.go | 54 + bundle/internal/schema/main.go | 21 +- bundle/internal/schema/main_test.go | 2 +- bundle/internal/schema/parser.go | 88 +- bundle/schema/jsonschema.json | 143 +- bundle/schema/jsonschema_for_docs.json | 139 +- internal/cligen/cli_json_test.go | 142 + internal/cligen/cligen.go | 151 + internal/cligen/comment.go | 96 + internal/cligen/model.go | 330 + internal/cligen/names.go | 151 + internal/cligen/names_test.go | 55 + internal/cligen/render.go | 80 + internal/cligen/render_test.go | 26 + .../cligen/templates/cmds-account.go.tmpl | 32 + .../cligen/templates/cmds-workspace.go.tmpl | 36 + .../cligen/templates/groups-account.go.tmpl | 18 + .../cligen/templates/groups-workspace.go.tmpl | 18 + internal/cligen/templates/service.go.tmpl | 618 + .../bundles/catalogs/_models/privilege.py | 38 - .../jobs/_models/hardware_accelerator_type.py | 3 +- .../file_ingestion_options_file_format.py | 5 +- ..._drive_options_google_drive_entity_type.py | 6 +- ...arepoint_options_sharepoint_entity_type.py | 11 +- .../pipelines/_models/transformer_format.py | 6 +- .../bundles/schemas/_models/privilege.py | 38 - .../bundles/volumes/_models/privilege.py | 38 - tools/go.mod | 1 + 38 files changed, 193076 insertions(+), 765 deletions(-) create mode 100644 .codegen/.gitattributes create mode 100644 .codegen/cli.json create mode 100644 bundle/internal/schema/cli_json.go create mode 100644 internal/cligen/cli_json_test.go create mode 100644 internal/cligen/cligen.go create mode 100644 internal/cligen/comment.go create mode 100644 internal/cligen/model.go create mode 100644 internal/cligen/names.go create mode 100644 internal/cligen/names_test.go create mode 100644 internal/cligen/render.go create mode 100644 internal/cligen/render_test.go create mode 100644 internal/cligen/templates/cmds-account.go.tmpl create mode 100644 internal/cligen/templates/cmds-workspace.go.tmpl create mode 100644 internal/cligen/templates/groups-account.go.tmpl create mode 100644 internal/cligen/templates/groups-workspace.go.tmpl create mode 100644 internal/cligen/templates/service.go.tmpl diff --git a/.codegen/.gitattributes b/.codegen/.gitattributes new file mode 100644 index 00000000000..00da4383df4 --- /dev/null +++ b/.codegen/.gitattributes @@ -0,0 +1 @@ +cli.json linguist-generated=true diff --git a/.codegen/cli.json b/.codegen/cli.json new file mode 100644 index 00000000000..3d78487bcb3 --- /dev/null +++ b/.codegen/cli.json @@ -0,0 +1,191065 @@ +{ + "metadata": { + "openapi_sha": "c68a27fa9c9d838e839c584be8018eb3b68377d5", + "generator_version": "cliv1" + }, + "schemas": { + "agentbricks.CancelCustomLlmOptimizationRunRequest": {}, + "agentbricks.CreateCustomLlmRequest": { + "fields": { + "agent_artifact_path": { + "description": "This will soon be deprecated!!\nOptional: UC path for agent artifacts. If you are using a dataset that you only have read permissions,\nplease provide a destination path where you have write permissions. Please provide this in catalog.schema format.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "datasets": { + "description": "Datasets used for training and evaluating the model, not for inference.\nCurrently, only 1 dataset is accepted.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "guidelines": { + "description": "Guidelines for the custom LLM to adhere to", + "launch_stage": "PRIVATE_PREVIEW" + }, + "instructions": { + "description": "Instructions for the custom LLM to follow", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "Name of the custom LLM. Only alphanumeric characters and dashes allowed.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "agentbricks.CustomLlm": { + "fields": { + "agent_artifact_path": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "creation_time": { + "description": "Creation timestamp of the custom LLM", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "creator": { + "description": "Creator of the custom LLM", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "datasets": { + "description": "Datasets used for training and evaluating the model, not for inference", + "launch_stage": "PRIVATE_PREVIEW" + }, + "endpoint_name": { + "description": "Name of the endpoint that will be used to serve the custom LLM", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "guidelines": { + "description": "Guidelines for the custom LLM to adhere to", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "instructions": { + "description": "Instructions for the custom LLM to follow", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "Name of the custom LLM", + "launch_stage": "PRIVATE_PREVIEW" + }, + "optimization_state": { + "description": "If optimization is kicked off, tracks the state of the custom LLM", + "ref": "agentbricks.State", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "agentbricks.Dataset": { + "fields": { + "table": { + "ref": "agentbricks.Table", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "agentbricks.StartCustomLlmOptimizationRunRequest": {}, + "agentbricks.State": { + "description": "States of Custom LLM optimization lifecycle.", + "enum": [ + "CREATED", + "RUNNING", + "COMPLETED", + "FAILED", + "PENDING", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "PRIVATE_PREVIEW", + "COMPLETED": "PRIVATE_PREVIEW", + "CREATED": "PRIVATE_PREVIEW", + "FAILED": "PRIVATE_PREVIEW", + "PENDING": "PRIVATE_PREVIEW", + "RUNNING": "PRIVATE_PREVIEW" + } + }, + "agentbricks.Table": { + "fields": { + "request_col": { + "description": "Name of the request column", + "launch_stage": "PRIVATE_PREVIEW" + }, + "response_col": { + "description": "Optional: Name of the response column if the data is labeled", + "launch_stage": "PRIVATE_PREVIEW" + }, + "table_path": { + "description": "Full UC table path in catalog.schema.table_name format", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "agentbricks.UpdateCustomLlmRequest": { + "fields": { + "custom_llm": { + "description": "The CustomLlm containing the fields which should be updated.", + "ref": "agentbricks.CustomLlm", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.App": { + "fields": { + "active_deployment": { + "description": "The active deployment of the app. A deployment is considered active when it has been deployed\nto the app compute.", + "ref": "apps.AppDeployment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "app_status": { + "ref": "apps.ApplicationStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "budget_policy_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "compute_max_instances": { + "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "compute_min_instances": { + "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "compute_size": { + "ref": "apps.ComputeSize", + "launch_stage": "GA" + }, + "compute_status": { + "ref": "apps.ComputeStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "create_time": { + "description": "The creation time of the app. Formatted timestamp in ISO 6801.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The email of the user that created the app.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "default_source_code_path": { + "description": "The default workspace file system path of the source code from which app deployment are\ncreated. This field tracks the workspace source code path of the last active deployment.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "The description of the app.", + "launch_stage": "GA" + }, + "effective_budget_policy_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_usage_policy_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_user_api_scopes": { + "description": "The effective api scopes granted to the user access token.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "git_repository": { + "description": "Git repository configuration for app deployments. When specified, deployments can\nreference code from this repository by providing only the git reference (branch, tag, or commit).", + "ref": "apps.GitRepository", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the app.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "launch_stage": "GA" + }, + "oauth2_app_client_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "oauth2_app_integration_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pending_deployment": { + "description": "The pending deployment of the app. A deployment is considered pending when it is being prepared\nfor deployment to the app compute.", + "ref": "apps.AppDeployment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "resources": { + "description": "Resources for the app.", + "launch_stage": "GA" + }, + "service_principal_client_id": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "service_principal_id": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "service_principal_name": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "space": { + "description": "Name of the space this app belongs to.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "telemetry_export_destinations": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "thumbnail_url": { + "description": "The URL of the thumbnail image for the app.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "The update time of the app. Formatted timestamp in ISO 6801.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updater": { + "description": "The email of the user that last updated the app.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "url": { + "description": "The URL of the app once it is deployed.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_api_scopes": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "apps.AppAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "apps.AppPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "apps.AppAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "apps.AppDeployment": { + "fields": { + "command": { + "description": "The command with which to run the app. This will override the command specified in the app.yaml file.", + "launch_stage": "GA" + }, + "create_time": { + "description": "The creation time of the deployment. Formatted timestamp in ISO 6801.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The email of the user creates the deployment.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "deployment_artifacts": { + "description": "The deployment artifacts for an app.", + "ref": "apps.AppDeploymentArtifacts", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "deployment_id": { + "description": "The unique id of the deployment.", + "launch_stage": "GA" + }, + "env_vars": { + "description": "The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.", + "launch_stage": "GA" + }, + "git_source": { + "description": "Git repository to use as the source for the app deployment.", + "ref": "apps.GitSource", + "launch_stage": "GA" + }, + "mode": { + "description": "The mode of which the deployment will manage the source code.", + "ref": "apps.AppDeploymentMode", + "launch_stage": "GA" + }, + "source_code_path": { + "description": "The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.", + "launch_stage": "GA" + }, + "status": { + "description": "Status and status message of the deployment", + "ref": "apps.AppDeploymentStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "The update time of the deployment. Formatted timestamp in ISO 6801.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.AppDeploymentArtifacts": { + "fields": { + "source_code_path": { + "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", + "launch_stage": "GA" + } + } + }, + "apps.AppDeploymentMode": { + "enum": [ + "SNAPSHOT", + "AUTO_SYNC" + ], + "enum_launch_stages": { + "AUTO_SYNC": "GA", + "SNAPSHOT": "GA" + } + }, + "apps.AppDeploymentState": { + "enum": [ + "SUCCEEDED", + "FAILED", + "IN_PROGRESS", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "GA", + "FAILED": "GA", + "IN_PROGRESS": "GA", + "SUCCEEDED": "GA" + } + }, + "apps.AppDeploymentStatus": { + "fields": { + "message": { + "description": "Message corresponding with the deployment state.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "State of the deployment.", + "ref": "apps.AppDeploymentState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.AppManifest": { + "description": "App manifest definition", + "fields": { + "description": { + "description": "Description of the app defined by manifest author / publisher", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name of the app defined by manifest author / publisher", + "launch_stage": "PRIVATE_PREVIEW" + }, + "resource_specs": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "version": { + "description": "The manifest schema version, for now only 1 is allowed", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceExperimentSpec": { + "fields": { + "permission": { + "ref": "apps.AppManifestAppResourceExperimentSpecExperimentPermission", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceExperimentSpecExperimentPermission": { + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_READ" + ], + "enum_launch_stages": { + "CAN_EDIT": "PRIVATE_PREVIEW", + "CAN_MANAGE": "PRIVATE_PREVIEW", + "CAN_READ": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceJobSpec": { + "fields": { + "permission": { + "description": "Permissions to grant on the Job. Supported permissions are: \"CAN_MANAGE\", \"IS_OWNER\", \"CAN_MANAGE_RUN\", \"CAN_VIEW\".", + "ref": "apps.AppManifestAppResourceJobSpecJobPermission", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceJobSpecJobPermission": { + "enum": [ + "CAN_MANAGE", + "IS_OWNER", + "CAN_MANAGE_RUN", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_MANAGE": "PRIVATE_PREVIEW", + "CAN_MANAGE_RUN": "PRIVATE_PREVIEW", + "CAN_VIEW": "PRIVATE_PREVIEW", + "IS_OWNER": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceSecretSpec": { + "fields": { + "permission": { + "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: \"READ\", \"WRITE\", \"MANAGE\".", + "ref": "apps.AppManifestAppResourceSecretSpecSecretPermission", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceSecretSpecSecretPermission": { + "description": "Permission to grant on the secret scope. Supported permissions are: \"READ\", \"WRITE\", \"MANAGE\".", + "enum": [ + "READ", + "WRITE", + "MANAGE" + ], + "enum_launch_stages": { + "MANAGE": "PRIVATE_PREVIEW", + "READ": "PRIVATE_PREVIEW", + "WRITE": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceServingEndpointSpec": { + "fields": { + "permission": { + "description": "Permission to grant on the serving endpoint. Supported permissions are: \"CAN_MANAGE\", \"CAN_QUERY\", \"CAN_VIEW\".", + "ref": "apps.AppManifestAppResourceServingEndpointSpecServingEndpointPermission", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceServingEndpointSpecServingEndpointPermission": { + "enum": [ + "CAN_MANAGE", + "CAN_QUERY", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_MANAGE": "PRIVATE_PREVIEW", + "CAN_QUERY": "PRIVATE_PREVIEW", + "CAN_VIEW": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceSpec": { + "description": "AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. name, id, key, scope, etc.)", + "fields": { + "description": { + "description": "Description of the App Resource.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "experiment_spec": { + "ref": "apps.AppManifestAppResourceExperimentSpec", + "launch_stage": "PRIVATE_PREVIEW" + }, + "job_spec": { + "ref": "apps.AppManifestAppResourceJobSpec", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "Name of the App Resource.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "secret_spec": { + "ref": "apps.AppManifestAppResourceSecretSpec", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serving_endpoint_spec": { + "ref": "apps.AppManifestAppResourceServingEndpointSpec", + "launch_stage": "PRIVATE_PREVIEW" + }, + "sql_warehouse_spec": { + "ref": "apps.AppManifestAppResourceSqlWarehouseSpec", + "launch_stage": "PRIVATE_PREVIEW" + }, + "uc_securable_spec": { + "ref": "apps.AppManifestAppResourceUcSecurableSpec", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceSqlWarehouseSpec": { + "fields": { + "permission": { + "description": "Permission to grant on the SQL warehouse. Supported permissions are: \"CAN_MANAGE\", \"CAN_USE\", \"IS_OWNER\".", + "ref": "apps.AppManifestAppResourceSqlWarehouseSpecSqlWarehousePermission", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceSqlWarehouseSpecSqlWarehousePermission": { + "enum": [ + "CAN_MANAGE", + "CAN_USE", + "IS_OWNER" + ], + "enum_launch_stages": { + "CAN_MANAGE": "PRIVATE_PREVIEW", + "CAN_USE": "PRIVATE_PREVIEW", + "IS_OWNER": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceUcSecurableSpec": { + "fields": { + "permission": { + "ref": "apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission", + "launch_stage": "PRIVATE_PREVIEW" + }, + "securable_type": { + "ref": "apps.AppManifestAppResourceUcSecurableSpecUcSecurableType", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.AppManifestAppResourceUcSecurableSpecUcSecurablePermission": { + "enum": [ + "READ_VOLUME", + "WRITE_VOLUME", + "MANAGE", + "SELECT", + "EXECUTE", + "USE_CONNECTION" + ], + "enum_launch_stages": { + "EXECUTE": "PRIVATE_PREVIEW", + "MANAGE": "PRIVATE_PREVIEW", + "READ_VOLUME": "PRIVATE_PREVIEW", + "SELECT": "PRIVATE_PREVIEW", + "USE_CONNECTION": "PRIVATE_PREVIEW", + "WRITE_VOLUME": "PRIVATE_PREVIEW" + } + }, + "apps.AppManifestAppResourceUcSecurableSpecUcSecurableType": { + "enum": [ + "VOLUME", + "TABLE", + "FUNCTION", + "CONNECTION" + ], + "enum_launch_stages": { + "CONNECTION": "PRIVATE_PREVIEW", + "FUNCTION": "PRIVATE_PREVIEW", + "TABLE": "PRIVATE_PREVIEW", + "VOLUME": "PRIVATE_PREVIEW" + } + }, + "apps.AppPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "apps.AppPermissionLevel", + "launch_stage": "GA" + } + } + }, + "apps.AppPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_USE" + ] + }, + "apps.AppPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "apps.AppPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "apps.AppPermissionLevel", + "launch_stage": "GA" + } + } + }, + "apps.AppPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "apps.AppResource": { + "fields": { + "app": { + "ref": "apps.AppResourceApp", + "launch_stage": "GA" + }, + "database": { + "ref": "apps.AppResourceDatabase", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the App Resource.", + "launch_stage": "GA" + }, + "experiment": { + "ref": "apps.AppResourceExperiment", + "launch_stage": "GA" + }, + "genie_space": { + "ref": "apps.AppResourceGenieSpace", + "launch_stage": "GA" + }, + "job": { + "ref": "apps.AppResourceJob", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the App Resource.", + "launch_stage": "GA" + }, + "postgres": { + "ref": "apps.AppResourcePostgres", + "launch_stage": "GA" + }, + "secret": { + "ref": "apps.AppResourceSecret", + "launch_stage": "GA" + }, + "serving_endpoint": { + "ref": "apps.AppResourceServingEndpoint", + "launch_stage": "GA" + }, + "sql_warehouse": { + "ref": "apps.AppResourceSqlWarehouse", + "launch_stage": "GA" + }, + "uc_securable": { + "ref": "apps.AppResourceUcSecurable", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceApp": { + "fields": { + "name": { + "launch_stage": "GA" + }, + "permission": { + "ref": "apps.AppResourceAppAppPermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceAppAppPermission": { + "enum": [ + "CAN_USE" + ], + "enum_launch_stages": { + "CAN_USE": "GA" + } + }, + "apps.AppResourceDatabase": { + "fields": { + "database_name": { + "launch_stage": "GA" + }, + "instance_name": { + "launch_stage": "GA" + }, + "permission": { + "ref": "apps.AppResourceDatabaseDatabasePermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceDatabaseDatabasePermission": { + "enum": [ + "CAN_CONNECT_AND_CREATE" + ], + "enum_launch_stages": { + "CAN_CONNECT_AND_CREATE": "GA" + } + }, + "apps.AppResourceExperiment": { + "fields": { + "experiment_id": { + "launch_stage": "GA" + }, + "permission": { + "ref": "apps.AppResourceExperimentExperimentPermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceExperimentExperimentPermission": { + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_READ" + ], + "enum_launch_stages": { + "CAN_EDIT": "GA", + "CAN_MANAGE": "GA", + "CAN_READ": "GA" + } + }, + "apps.AppResourceGenieSpace": { + "fields": { + "name": { + "launch_stage": "GA" + }, + "permission": { + "ref": "apps.AppResourceGenieSpaceGenieSpacePermission", + "launch_stage": "GA" + }, + "space_id": { + "launch_stage": "GA" + } + } + }, + "apps.AppResourceGenieSpaceGenieSpacePermission": { + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_RUN", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_EDIT": "GA", + "CAN_MANAGE": "GA", + "CAN_RUN": "GA", + "CAN_VIEW": "GA" + } + }, + "apps.AppResourceJob": { + "fields": { + "id": { + "description": "Id of the job to grant permission on.", + "launch_stage": "GA" + }, + "permission": { + "description": "Permissions to grant on the Job. Supported permissions are: \"CAN_MANAGE\", \"IS_OWNER\", \"CAN_MANAGE_RUN\", \"CAN_VIEW\".", + "ref": "apps.AppResourceJobJobPermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceJobJobPermission": { + "enum": [ + "CAN_MANAGE", + "IS_OWNER", + "CAN_MANAGE_RUN", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_MANAGE": "GA", + "CAN_MANAGE_RUN": "GA", + "CAN_VIEW": "GA", + "IS_OWNER": "GA" + } + }, + "apps.AppResourcePostgres": { + "fields": { + "branch": { + "launch_stage": "GA" + }, + "database": { + "launch_stage": "GA" + }, + "permission": { + "ref": "apps.AppResourcePostgresPostgresPermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourcePostgresPostgresPermission": { + "enum": [ + "CAN_CONNECT_AND_CREATE" + ], + "enum_launch_stages": { + "CAN_CONNECT_AND_CREATE": "GA" + } + }, + "apps.AppResourceSecret": { + "fields": { + "key": { + "description": "Key of the secret to grant permission on.", + "launch_stage": "GA" + }, + "permission": { + "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: \"READ\", \"WRITE\", \"MANAGE\".", + "ref": "apps.AppResourceSecretSecretPermission", + "launch_stage": "GA" + }, + "scope": { + "description": "Scope of the secret to grant permission on.", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceSecretSecretPermission": { + "description": "Permission to grant on the secret scope. Supported permissions are: \"READ\", \"WRITE\", \"MANAGE\".", + "enum": [ + "READ", + "WRITE", + "MANAGE" + ], + "enum_launch_stages": { + "MANAGE": "GA", + "READ": "GA", + "WRITE": "GA" + } + }, + "apps.AppResourceServingEndpoint": { + "fields": { + "name": { + "description": "Name of the serving endpoint to grant permission on.", + "launch_stage": "GA" + }, + "permission": { + "description": "Permission to grant on the serving endpoint. Supported permissions are: \"CAN_MANAGE\", \"CAN_QUERY\", \"CAN_VIEW\".", + "ref": "apps.AppResourceServingEndpointServingEndpointPermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceServingEndpointServingEndpointPermission": { + "enum": [ + "CAN_MANAGE", + "CAN_QUERY", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_MANAGE": "GA", + "CAN_QUERY": "GA", + "CAN_VIEW": "GA" + } + }, + "apps.AppResourceSqlWarehouse": { + "fields": { + "id": { + "description": "Id of the SQL warehouse to grant permission on.", + "launch_stage": "GA" + }, + "permission": { + "description": "Permission to grant on the SQL warehouse. Supported permissions are: \"CAN_MANAGE\", \"CAN_USE\", \"IS_OWNER\".", + "ref": "apps.AppResourceSqlWarehouseSqlWarehousePermission", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceSqlWarehouseSqlWarehousePermission": { + "enum": [ + "CAN_MANAGE", + "CAN_USE", + "IS_OWNER" + ], + "enum_launch_stages": { + "CAN_MANAGE": "GA", + "CAN_USE": "GA", + "IS_OWNER": "GA" + } + }, + "apps.AppResourceUcSecurable": { + "fields": { + "permission": { + "ref": "apps.AppResourceUcSecurableUcSecurablePermission", + "launch_stage": "GA" + }, + "securable_full_name": { + "launch_stage": "GA" + }, + "securable_kind": { + "description": "The securable kind from Unity Catalog.\nSee https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "securable_type": { + "ref": "apps.AppResourceUcSecurableUcSecurableType", + "launch_stage": "GA" + } + } + }, + "apps.AppResourceUcSecurableUcSecurablePermission": { + "enum": [ + "READ_VOLUME", + "WRITE_VOLUME", + "SELECT", + "EXECUTE", + "USE_CONNECTION", + "MODIFY" + ], + "enum_launch_stages": { + "EXECUTE": "GA", + "MODIFY": "GA", + "READ_VOLUME": "GA", + "SELECT": "GA", + "USE_CONNECTION": "GA", + "WRITE_VOLUME": "GA" + } + }, + "apps.AppResourceUcSecurableUcSecurableType": { + "enum": [ + "VOLUME", + "TABLE", + "FUNCTION", + "CONNECTION" + ], + "enum_launch_stages": { + "CONNECTION": "GA", + "FUNCTION": "GA", + "TABLE": "GA", + "VOLUME": "GA" + } + }, + "apps.AppThumbnail": { + "description": "The thumbnail for an app.", + "fields": { + "thumbnail": { + "description": "The thumbnail image bytes.", + "launch_stage": "GA" + } + } + }, + "apps.AppUpdate": { + "fields": { + "budget_policy_id": { + "launch_stage": "GA" + }, + "compute_max_instances": { + "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "compute_min_instances": { + "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "compute_size": { + "ref": "apps.ComputeSize", + "launch_stage": "GA" + }, + "description": { + "launch_stage": "GA" + }, + "git_repository": { + "ref": "apps.GitRepository", + "launch_stage": "GA" + }, + "resources": { + "launch_stage": "GA" + }, + "status": { + "ref": "apps.AppUpdateUpdateStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "launch_stage": "GA" + }, + "user_api_scopes": { + "launch_stage": "GA" + } + } + }, + "apps.AppUpdateUpdateStatus": { + "fields": { + "message": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "ref": "apps.AppUpdateUpdateStatusUpdateState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.AppUpdateUpdateStatusUpdateState": { + "enum": [ + "NOT_UPDATED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enum_launch_stages": { + "FAILED": "GA", + "IN_PROGRESS": "GA", + "NOT_UPDATED": "GA", + "SUCCEEDED": "GA" + } + }, + "apps.ApplicationState": { + "enum": [ + "DEPLOYING", + "RUNNING", + "CRASHED", + "UNAVAILABLE" + ], + "enum_launch_stages": { + "CRASHED": "GA", + "DEPLOYING": "GA", + "RUNNING": "GA", + "UNAVAILABLE": "GA" + } + }, + "apps.ApplicationStatus": { + "fields": { + "message": { + "description": "Application status message", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "State of the application.", + "ref": "apps.ApplicationState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.AsyncUpdateAppRequest": { + "fields": { + "app": { + "ref": "apps.App", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "apps.ComputeSize": { + "enum": [ + "MEDIUM", + "LARGE" + ], + "enum_launch_stages": { + "LARGE": "GA", + "MEDIUM": "GA" + } + }, + "apps.ComputeState": { + "enum": [ + "ERROR", + "DELETING", + "STARTING", + "STOPPING", + "UPDATING", + "STOPPED", + "ACTIVE" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "DELETING": "GA", + "ERROR": "GA", + "STARTING": "GA", + "STOPPED": "GA", + "STOPPING": "GA", + "UPDATING": "GA" + } + }, + "apps.ComputeStatus": { + "fields": { + "active_instances": { + "description": "The number of compute instances currently serving requests for this\napplication. An instance is considered active if it is reachable and ready\nto handle requests.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "Compute status message", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "State of the app compute.", + "ref": "apps.ComputeState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.CustomTemplate": { + "fields": { + "creator": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "The description of the template.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "git_provider": { + "description": "The Git provider of the template.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "git_repo": { + "description": "The Git repository URL that the template resides in.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "manifest": { + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "ref": "apps.AppManifest", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "path": { + "description": "The path to the template within the Git repository.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.DatabricksServiceExceptionWithDetailsProto": { + "description": "Databricks Error that is returned by all Databricks APIs.", + "fields": { + "details": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "error_code": { + "ref": "apps.ErrorCode", + "launch_stage": "PRIVATE_PREVIEW" + }, + "message": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "stack_trace": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.EnvVar": { + "fields": { + "name": { + "description": "The name of the environment variable.", + "launch_stage": "GA" + }, + "value": { + "description": "The value for the environment variable.", + "launch_stage": "GA" + }, + "value_from": { + "description": "The name of an external Databricks resource that contains the value, such as a secret or a database table.", + "launch_stage": "GA" + } + } + }, + "apps.ErrorCode": { + "description": "Error codes returned by Databricks APIs to indicate specific failure conditions.", + "enum": [ + "UNKNOWN", + "INTERNAL_ERROR", + "TEMPORARILY_UNAVAILABLE", + "IO_ERROR", + "BAD_REQUEST", + "SERVICE_UNDER_MAINTENANCE", + "WORKSPACE_TEMPORARILY_UNAVAILABLE", + "DEADLINE_EXCEEDED", + "CANCELLED", + "RESOURCE_EXHAUSTED", + "ABORTED", + "NOT_FOUND", + "ALREADY_EXISTS", + "UNAUTHENTICATED", + "UNAVAILABLE", + "INVALID_PARAMETER_VALUE", + "ENDPOINT_NOT_FOUND", + "MALFORMED_REQUEST", + "INVALID_STATE", + "PERMISSION_DENIED", + "FEATURE_DISABLED", + "CUSTOMER_UNAUTHORIZED", + "REQUEST_LIMIT_EXCEEDED", + "RESOURCE_CONFLICT", + "UNPARSEABLE_HTTP_ERROR", + "NOT_IMPLEMENTED", + "DATA_LOSS", + "INVALID_STATE_TRANSITION", + "COULD_NOT_ACQUIRE_LOCK", + "RESOURCE_ALREADY_EXISTS", + "RESOURCE_DOES_NOT_EXIST", + "QUOTA_EXCEEDED", + "MAX_BLOCK_SIZE_EXCEEDED", + "MAX_READ_SIZE_EXCEEDED", + "PARTIAL_DELETE", + "MAX_LIST_SIZE_EXCEEDED", + "DRY_RUN_FAILED", + "RESOURCE_LIMIT_EXCEEDED", + "DIRECTORY_NOT_EMPTY", + "DIRECTORY_PROTECTED", + "MAX_NOTEBOOK_SIZE_EXCEEDED", + "MAX_CHILD_NODE_SIZE_EXCEEDED", + "SEARCH_QUERY_TOO_LONG", + "SEARCH_QUERY_TOO_SHORT", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST", + "PERMISSION_NOT_PROPAGATED", + "DEPLOYMENT_TIMEOUT", + "GIT_CONFLICT", + "GIT_UNKNOWN_REF", + "GIT_SENSITIVE_TOKEN_DETECTED", + "GIT_URL_NOT_ON_ALLOW_LIST", + "GIT_REMOTE_ERROR", + "PROJECTS_OPERATION_TIMEOUT", + "IPYNB_FILE_IN_REPO", + "INSECURE_PARTNER_RESPONSE", + "MALFORMED_PARTNER_RESPONSE", + "METASTORE_DOES_NOT_EXIST", + "DAC_DOES_NOT_EXIST", + "CATALOG_DOES_NOT_EXIST", + "SCHEMA_DOES_NOT_EXIST", + "TABLE_DOES_NOT_EXIST", + "SHARE_DOES_NOT_EXIST", + "RECIPIENT_DOES_NOT_EXIST", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST", + "EXTERNAL_LOCATION_DOES_NOT_EXIST", + "PRINCIPAL_DOES_NOT_EXIST", + "PROVIDER_DOES_NOT_EXIST", + "METASTORE_ALREADY_EXISTS", + "DAC_ALREADY_EXISTS", + "CATALOG_ALREADY_EXISTS", + "SCHEMA_ALREADY_EXISTS", + "TABLE_ALREADY_EXISTS", + "SHARE_ALREADY_EXISTS", + "RECIPIENT_ALREADY_EXISTS", + "STORAGE_CREDENTIAL_ALREADY_EXISTS", + "EXTERNAL_LOCATION_ALREADY_EXISTS", + "PROVIDER_ALREADY_EXISTS", + "CATALOG_NOT_EMPTY", + "SCHEMA_NOT_EMPTY", + "METASTORE_NOT_EMPTY", + "PROVIDER_SHARE_NOT_ACCESSIBLE" + ], + "enum_launch_stages": { + "ABORTED": "PRIVATE_PREVIEW", + "ALREADY_EXISTS": "PRIVATE_PREVIEW", + "BAD_REQUEST": "PRIVATE_PREVIEW", + "CANCELLED": "PRIVATE_PREVIEW", + "CATALOG_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "CATALOG_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "CATALOG_NOT_EMPTY": "PRIVATE_PREVIEW", + "COULD_NOT_ACQUIRE_LOCK": "PRIVATE_PREVIEW", + "CUSTOMER_UNAUTHORIZED": "PRIVATE_PREVIEW", + "DAC_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "DAC_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "DATA_LOSS": "PRIVATE_PREVIEW", + "DEADLINE_EXCEEDED": "PRIVATE_PREVIEW", + "DEPLOYMENT_TIMEOUT": "PRIVATE_PREVIEW", + "DIRECTORY_NOT_EMPTY": "PRIVATE_PREVIEW", + "DIRECTORY_PROTECTED": "PRIVATE_PREVIEW", + "DRY_RUN_FAILED": "PRIVATE_PREVIEW", + "ENDPOINT_NOT_FOUND": "PRIVATE_PREVIEW", + "EXTERNAL_LOCATION_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "EXTERNAL_LOCATION_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "FEATURE_DISABLED": "PRIVATE_PREVIEW", + "GIT_CONFLICT": "PRIVATE_PREVIEW", + "GIT_REMOTE_ERROR": "PRIVATE_PREVIEW", + "GIT_SENSITIVE_TOKEN_DETECTED": "PRIVATE_PREVIEW", + "GIT_UNKNOWN_REF": "PRIVATE_PREVIEW", + "GIT_URL_NOT_ON_ALLOW_LIST": "PRIVATE_PREVIEW", + "INSECURE_PARTNER_RESPONSE": "PRIVATE_PREVIEW", + "INTERNAL_ERROR": "PRIVATE_PREVIEW", + "INVALID_PARAMETER_VALUE": "PRIVATE_PREVIEW", + "INVALID_STATE": "PRIVATE_PREVIEW", + "INVALID_STATE_TRANSITION": "PRIVATE_PREVIEW", + "IO_ERROR": "PRIVATE_PREVIEW", + "IPYNB_FILE_IN_REPO": "PRIVATE_PREVIEW", + "MALFORMED_PARTNER_RESPONSE": "PRIVATE_PREVIEW", + "MALFORMED_REQUEST": "PRIVATE_PREVIEW", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "MAX_BLOCK_SIZE_EXCEEDED": "PRIVATE_PREVIEW", + "MAX_CHILD_NODE_SIZE_EXCEEDED": "PRIVATE_PREVIEW", + "MAX_LIST_SIZE_EXCEEDED": "PRIVATE_PREVIEW", + "MAX_NOTEBOOK_SIZE_EXCEEDED": "PRIVATE_PREVIEW", + "MAX_READ_SIZE_EXCEEDED": "PRIVATE_PREVIEW", + "METASTORE_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "METASTORE_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "METASTORE_NOT_EMPTY": "PRIVATE_PREVIEW", + "NOT_FOUND": "PRIVATE_PREVIEW", + "NOT_IMPLEMENTED": "PRIVATE_PREVIEW", + "PARTIAL_DELETE": "PRIVATE_PREVIEW", + "PERMISSION_DENIED": "PRIVATE_PREVIEW", + "PERMISSION_NOT_PROPAGATED": "PRIVATE_PREVIEW", + "PRINCIPAL_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "PROJECTS_OPERATION_TIMEOUT": "PRIVATE_PREVIEW", + "PROVIDER_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "PROVIDER_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "PROVIDER_SHARE_NOT_ACCESSIBLE": "PRIVATE_PREVIEW", + "QUOTA_EXCEEDED": "PRIVATE_PREVIEW", + "RECIPIENT_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "RECIPIENT_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "REQUEST_LIMIT_EXCEEDED": "PRIVATE_PREVIEW", + "RESOURCE_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "RESOURCE_CONFLICT": "PRIVATE_PREVIEW", + "RESOURCE_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "RESOURCE_EXHAUSTED": "PRIVATE_PREVIEW", + "RESOURCE_LIMIT_EXCEEDED": "PRIVATE_PREVIEW", + "SCHEMA_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "SCHEMA_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "SCHEMA_NOT_EMPTY": "PRIVATE_PREVIEW", + "SEARCH_QUERY_TOO_LONG": "PRIVATE_PREVIEW", + "SEARCH_QUERY_TOO_SHORT": "PRIVATE_PREVIEW", + "SERVICE_UNDER_MAINTENANCE": "PRIVATE_PREVIEW", + "SHARE_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "SHARE_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "STORAGE_CREDENTIAL_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "TABLE_ALREADY_EXISTS": "PRIVATE_PREVIEW", + "TABLE_DOES_NOT_EXIST": "PRIVATE_PREVIEW", + "TEMPORARILY_UNAVAILABLE": "PRIVATE_PREVIEW", + "UNAUTHENTICATED": "PRIVATE_PREVIEW", + "UNAVAILABLE": "PRIVATE_PREVIEW", + "UNKNOWN": "PRIVATE_PREVIEW", + "UNPARSEABLE_HTTP_ERROR": "PRIVATE_PREVIEW", + "WORKSPACE_TEMPORARILY_UNAVAILABLE": "PRIVATE_PREVIEW" + } + }, + "apps.GetAppPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "apps.GitRepository": { + "description": "Git repository configuration specifying the location of the repository.", + "fields": { + "provider": { + "description": "Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud,\nbitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the Git repository.", + "launch_stage": "GA" + } + } + }, + "apps.GitSource": { + "description": "Complete git source specification including repository location and reference.", + "fields": { + "branch": { + "description": "Git branch to checkout.", + "launch_stage": "GA" + }, + "commit": { + "description": "Git commit SHA to checkout.", + "launch_stage": "GA" + }, + "git_repository": { + "description": "Git repository configuration. Populated from the app's git_repository configuration.", + "ref": "apps.GitRepository", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "resolved_commit": { + "description": "The resolved commit SHA that was actually used for the deployment. This is populated by the\nsystem after resolving the reference (branch, tag, or commit). If commit is specified\ndirectly, this will match commit. If a branch or tag is specified, this contains the\ncommit SHA that the branch or tag pointed to at deployment time.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_code_path": { + "description": "Relative path to the app source code within the Git repository. If not specified, the root\nof the repository is used.", + "launch_stage": "GA" + }, + "tag": { + "description": "Git tag to checkout.", + "launch_stage": "GA" + } + } + }, + "apps.ListAppDeploymentsResponse": { + "fields": { + "app_deployments": { + "description": "Deployment history of the app.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Pagination token to request the next page of apps.", + "launch_stage": "GA" + } + } + }, + "apps.ListAppsResponse": { + "fields": { + "apps": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Pagination token to request the next page of apps.", + "launch_stage": "GA" + } + } + }, + "apps.ListCustomTemplatesResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of custom templates.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "templates": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.ListSpacesResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of app spaces.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "spaces": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "fields": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "ref": "apps.DatabricksServiceExceptionWithDetailsProto", + "launch_stage": "PRIVATE_PREVIEW" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "response": { + "description": "The normal, successful response of the operation.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.Space": { + "fields": { + "create_time": { + "description": "The creation time of the app space. Formatted timestamp in ISO 6801.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The email of the user that created the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "The description of the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_usage_policy_id": { + "description": "The effective usage policy ID used by apps in the space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_user_api_scopes": { + "description": "The effective api scopes granted to the user access token.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "The unique identifier of the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "resources": { + "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "service_principal_client_id": { + "description": "The service principal client ID for the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "service_principal_id": { + "description": "The service principal ID for the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "service_principal_name": { + "description": "The service principal name for the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "status": { + "description": "The status of the app space.", + "ref": "apps.SpaceStatus", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "The update time of the app space. Formatted timestamp in ISO 6801.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updater": { + "description": "The email of the user that last updated the app space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "description": "The usage policy ID for managing cost at the space level.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "user_api_scopes": { + "description": "OAuth scopes for apps in the space.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "apps.SpaceStatus": { + "fields": { + "message": { + "description": "Message providing context about the current state.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "The state of the app space.", + "ref": "apps.SpaceStatusSpaceState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.SpaceStatusSpaceState": { + "enum": [ + "SPACE_CREATING", + "SPACE_ACTIVE", + "SPACE_ERROR", + "SPACE_DELETING", + "SPACE_DELETED", + "SPACE_UPDATING" + ], + "enum_launch_stages": { + "SPACE_ACTIVE": "PRIVATE_PREVIEW", + "SPACE_CREATING": "PRIVATE_PREVIEW", + "SPACE_DELETED": "PRIVATE_PREVIEW", + "SPACE_DELETING": "PRIVATE_PREVIEW", + "SPACE_ERROR": "PRIVATE_PREVIEW", + "SPACE_UPDATING": "PRIVATE_PREVIEW" + } + }, + "apps.SpaceUpdate": { + "description": "Tracks app space update information.", + "fields": { + "description": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "resources": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "status": { + "ref": "apps.SpaceUpdateStatus", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "user_api_scopes": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.SpaceUpdateState": { + "enum": [ + "NOT_UPDATED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "enum_launch_stages": { + "FAILED": "PRIVATE_PREVIEW", + "IN_PROGRESS": "PRIVATE_PREVIEW", + "NOT_UPDATED": "PRIVATE_PREVIEW", + "SUCCEEDED": "PRIVATE_PREVIEW" + } + }, + "apps.SpaceUpdateStatus": { + "description": "Status of an app space update operation", + "fields": { + "message": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "ref": "apps.SpaceUpdateState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "apps.StartAppRequest": {}, + "apps.StopAppRequest": {}, + "apps.TelemetryExportDestination": { + "description": "A single telemetry export destination with its configuration and status.", + "fields": { + "unity_catalog": { + "ref": "apps.UnityCatalog", + "launch_stage": "GA" + } + } + }, + "apps.UnityCatalog": { + "description": "Unity Catalog Destinations for OTEL telemetry export.", + "fields": { + "logs_table": { + "description": "Unity Catalog table for OTEL logs.", + "launch_stage": "GA" + }, + "metrics_table": { + "description": "Unity Catalog table for OTEL metrics.", + "launch_stage": "GA" + }, + "traces_table": { + "description": "Unity Catalog table for OTEL traces (spans).", + "launch_stage": "GA" + } + } + }, + "apps.UpdateAppThumbnailRequest": { + "fields": { + "app_thumbnail": { + "description": "The app thumbnail to set.", + "ref": "apps.AppThumbnail", + "launch_stage": "GA" + } + } + }, + "billing.ActionConfiguration": { + "fields": { + "action_configuration_id": { + "description": "Databricks action configuration ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "action_type": { + "description": "The type of the action.", + "ref": "billing.ActionConfigurationType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "target": { + "description": "Target for the action. For example, an email address.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.ActionConfigurationType": { + "description": "Type of action that a budget alert executes when its threshold is crossed.", + "enum": [ + "EMAIL_NOTIFICATION" + ], + "enum_launch_stages": { + "EMAIL_NOTIFICATION": "PUBLIC_PREVIEW" + } + }, + "billing.AlertConfiguration": { + "fields": { + "action_configurations": { + "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "alert_configuration_id": { + "description": "Databricks alert configuration ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "quantity_threshold": { + "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "quantity_type": { + "description": "The way to calculate cost for this budget alert. This is what `quantity_threshold` is measured in.", + "ref": "billing.AlertConfigurationQuantityType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "time_period": { + "description": "The time window of usage data for the budget.", + "ref": "billing.AlertConfigurationTimePeriod", + "launch_stage": "PUBLIC_PREVIEW" + }, + "trigger_type": { + "description": "The evaluation method to determine when this budget alert is in a triggered state.", + "ref": "billing.AlertConfigurationTriggerType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.AlertConfigurationQuantityType": { + "enum": [ + "LIST_PRICE_DOLLARS_USD" + ], + "enum_launch_stages": { + "LIST_PRICE_DOLLARS_USD": "PUBLIC_PREVIEW" + } + }, + "billing.AlertConfigurationTimePeriod": { + "enum": [ + "MONTH" + ], + "enum_launch_stages": { + "MONTH": "PUBLIC_PREVIEW" + } + }, + "billing.AlertConfigurationTriggerType": { + "enum": [ + "CUMULATIVE_SPENDING_EXCEEDED" + ], + "enum_launch_stages": { + "CUMULATIVE_SPENDING_EXCEEDED": "PUBLIC_PREVIEW" + } + }, + "billing.BudgetConfiguration": { + "fields": { + "account_id": { + "description": "Databricks account ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "alert_configurations": { + "description": "Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "budget_configuration_id": { + "description": "Databricks budget configuration ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "create_time": { + "description": "Creation time of this budget configuration.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Human-readable name of budget configuration. Max Length: 128", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "ref": "billing.BudgetConfigurationFilter", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_time": { + "description": "Update time of this budget configuration.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.BudgetConfigurationFilter": { + "fields": { + "tags": { + "description": "A list of tag keys and values that will limit the budget to usage that includes those specific custom tags.\nTags are case-sensitive and should be entered exactly as they appear in your usage data.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "workspace_id": { + "description": "If provided, usage must match with the provided Databricks workspace IDs.", + "ref": "billing.BudgetConfigurationFilterWorkspaceIdClause", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.BudgetConfigurationFilterClause": { + "fields": { + "operator": { + "ref": "billing.BudgetConfigurationFilterOperator", + "launch_stage": "PUBLIC_PREVIEW" + }, + "values": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.BudgetConfigurationFilterOperator": { + "enum": [ + "IN" + ], + "enum_launch_stages": { + "IN": "PUBLIC_PREVIEW" + } + }, + "billing.BudgetConfigurationFilterTagClause": { + "fields": { + "key": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "value": { + "ref": "billing.BudgetConfigurationFilterClause", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.BudgetConfigurationFilterWorkspaceIdClause": { + "fields": { + "operator": { + "ref": "billing.BudgetConfigurationFilterOperator", + "launch_stage": "PUBLIC_PREVIEW" + }, + "values": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.BudgetPolicy": { + "description": "Contains the BudgetPolicy details.", + "fields": { + "binding_workspace_ids": { + "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_tags": { + "description": "A list of tags defined by the customer. At most 20 entries are allowed per policy.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy_id": { + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy_name": { + "description": "The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "billing.CreateBillingUsageDashboardRequest": { + "fields": { + "dashboard_type": { + "description": "Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.", + "ref": "billing.UsageDashboardType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "major_version": { + "description": "The major version of the usage dashboard template to use. Defaults to VERSION_1.", + "ref": "billing.UsageDashboardMajorVersion", + "launch_stage": "PUBLIC_PREVIEW" + }, + "workspace_id": { + "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBillingUsageDashboardResponse": { + "fields": { + "dashboard_id": { + "description": "The unique id of the usage dashboard.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetConfigurationBudget": { + "fields": { + "account_id": { + "description": "Databricks account ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "alert_configurations": { + "description": "Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Human-readable name of budget configuration. Max Length: 128", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "ref": "billing.BudgetConfigurationFilter", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetConfigurationBudgetActionConfigurations": { + "fields": { + "action_type": { + "description": "The type of the action.", + "ref": "billing.ActionConfigurationType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "target": { + "description": "Target for the action. For example, an email address.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetConfigurationBudgetAlertConfigurations": { + "fields": { + "action_configurations": { + "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "quantity_threshold": { + "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "quantity_type": { + "description": "The way to calculate cost for this budget alert. This is what `quantity_threshold` is measured in.", + "ref": "billing.AlertConfigurationQuantityType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "time_period": { + "description": "The time window of usage data for the budget.", + "ref": "billing.AlertConfigurationTimePeriod", + "launch_stage": "PUBLIC_PREVIEW" + }, + "trigger_type": { + "description": "The evaluation method to determine when this budget alert is in a triggered state.", + "ref": "billing.AlertConfigurationTriggerType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetConfigurationRequest": { + "fields": { + "budget": { + "description": "Properties of the new budget configuration.", + "ref": "billing.CreateBudgetConfigurationBudget", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetConfigurationResponse": { + "fields": { + "budget": { + "description": "The created budget configuration.", + "ref": "billing.BudgetConfiguration", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.CreateBudgetPolicyRequest": { + "description": "A request to create a BudgetPolicy.", + "fields": { + "policy": { + "description": "The policy to create. `policy_id` needs to be empty as it will be generated\n`policy_name` must be provided, custom_tags may need to be provided\ndepending on the cloud provider. All other fields are optional.", + "ref": "billing.BudgetPolicy", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "request_id": { + "description": "A unique identifier for this request. Restricted to 36 ASCII characters.\nA random UUID is recommended.\nThis request is only idempotent if a `request_id` is provided.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "billing.CreateLogDeliveryConfigurationParams": { + "description": "*\nLog Delivery Configuration", + "fields": { + "config_name": { + "description": "The optional human-readable name of the log delivery configuration. Defaults to empty.", + "launch_stage": "GA" + }, + "credentials_id": { + "description": "The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).", + "launch_stage": "GA" + }, + "delivery_path_prefix": { + "description": "The optional delivery path prefix within Amazon S3 storage. Defaults to empty, which means that logs are delivered to the root of the bucket. This must be a valid S3 object key. This must not start or end with a slash character.", + "launch_stage": "GA" + }, + "delivery_start_time": { + "description": "This field applies only if log_type is BILLABLE_USAGE. This is the optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. BILLABLE_USAGE logs are not available for usage before March 2019 (2019-03).", + "launch_stage": "GA" + }, + "log_type": { + "description": "Log delivery type. Supported values are:\n* `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html).\n* `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html)", + "ref": "billing.LogType", + "launch_stage": "GA" + }, + "output_format": { + "description": "The file type of log delivery.\n* If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html)\n* If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).", + "ref": "billing.OutputFormat", + "launch_stage": "GA" + }, + "status": { + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "ref": "billing.LogDeliveryConfigStatus", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).", + "launch_stage": "GA" + }, + "workspace_ids_filter": { + "description": "Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of Databricks deployments there is only one workspace per account ID, so this field is unnecessary.", + "launch_stage": "GA" + } + } + }, + "billing.DeleteBudgetConfigurationResponse": {}, + "billing.DeliveryStatus": { + "description": "*\nThe status string for log delivery. Possible values are:\n`CREATED`: There were no log delivery attempts since the config was created.\n`SUCCEEDED`: The latest attempt of log delivery has succeeded completely.\n`USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage.\n`SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an Databricks internal error. Contact support if it doesn't go away soon.\n`NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account.", + "enum": [ + "CREATED", + "SUCCEEDED", + "USER_FAILURE", + "SYSTEM_FAILURE", + "NOT_FOUND" + ], + "enum_launch_stages": { + "CREATED": "GA", + "NOT_FOUND": "GA", + "SUCCEEDED": "GA", + "SYSTEM_FAILURE": "GA", + "USER_FAILURE": "GA" + } + }, + "billing.Filter": { + "description": "Structured representation of a filter to be applied to a list of policies. All specified filters\nwill be applied in conjunction.", + "fields": { + "creator_user_id": { + "description": "The policy creator user id to be filtered on.\nIf unspecified, all policies will be returned.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "creator_user_name": { + "description": "The policy creator user name to be filtered on.\nIf unspecified, all policies will be returned.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy_name": { + "description": "The partial name of policies to be filtered on.\nIf unspecified, all policies will be returned.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "billing.GetBillingUsageDashboardResponse": { + "fields": { + "dashboard_id": { + "description": "The unique id of the usage dashboard.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "dashboard_url": { + "description": "The URL of the usage dashboard.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.GetBudgetConfigurationResponse": { + "fields": { + "budget": { + "ref": "billing.BudgetConfiguration", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.GetLogDeliveryConfigurationResponse": { + "fields": { + "log_delivery_configuration": { + "description": "The fetched log delivery configuration", + "ref": "billing.LogDeliveryConfiguration", + "launch_stage": "GA" + } + } + }, + "billing.LimitConfig": { + "description": "The limit configuration of the policy.\nLimit configuration provide a budget policy level cost control by enforcing the limit." + }, + "billing.ListBudgetConfigurationsResponse": { + "fields": { + "budgets": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "description": "Token which can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no subsequent budgets.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.ListBudgetPoliciesResponse": { + "description": "A list of policies.", + "fields": { + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "policies": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "previous_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the previous page.\nIn this field is omitted, there are no previous pages.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.LogDeliveryConfigStatus": { + "description": "*\nLog Delivery Status\n\n`ENABLED`: All dependencies have executed and succeeded\n`DISABLED`: At least one dependency has succeeded", + "enum": [ + "ENABLED", + "DISABLED" + ], + "enum_launch_stages": { + "DISABLED": "GA", + "ENABLED": "GA" + } + }, + "billing.LogDeliveryConfiguration": { + "description": "*\nLog Delivery Configuration", + "fields": { + "account_id": { + "description": "Databricks account ID.", + "launch_stage": "GA" + }, + "config_id": { + "description": "The unique UUID of log delivery configuration", + "launch_stage": "GA" + }, + "config_name": { + "description": "The optional human-readable name of the log delivery configuration. Defaults to empty.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when the log delivery configuration was created.", + "launch_stage": "GA" + }, + "credentials_id": { + "description": "The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).", + "launch_stage": "GA" + }, + "delivery_path_prefix": { + "description": "The optional delivery path prefix within Amazon S3 storage. Defaults to empty, which means that logs are delivered to the root of the bucket. This must be a valid S3 object key. This must not start or end with a slash character.", + "launch_stage": "GA" + }, + "delivery_start_time": { + "description": "This field applies only if log_type is BILLABLE_USAGE. This is the optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. BILLABLE_USAGE logs are not available for usage before March 2019 (2019-03).", + "launch_stage": "GA" + }, + "log_delivery_status": { + "description": "The LogDeliveryStatus of this log delivery configuration", + "ref": "billing.LogDeliveryStatus", + "launch_stage": "GA" + }, + "log_type": { + "description": "Log delivery type. Supported values are:\n* `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html).\n* `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html)", + "ref": "billing.LogType", + "launch_stage": "GA" + }, + "output_format": { + "description": "The file type of log delivery.\n* If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html)\n* If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).", + "ref": "billing.OutputFormat", + "launch_stage": "GA" + }, + "status": { + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "ref": "billing.LogDeliveryConfigStatus", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html).", + "launch_stage": "GA" + }, + "update_time": { + "description": "Time in epoch milliseconds when the log delivery configuration was updated.", + "launch_stage": "GA" + }, + "workspace_ids_filter": { + "description": "Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of Databricks deployments there is only one workspace per account ID, so this field is unnecessary.", + "launch_stage": "GA" + } + } + }, + "billing.LogDeliveryStatus": { + "fields": { + "last_attempt_time": { + "description": "The UTC time for the latest log delivery attempt.", + "launch_stage": "GA" + }, + "last_successful_attempt_time": { + "description": "The UTC time for the latest successful log delivery.", + "launch_stage": "GA" + }, + "message": { + "description": "Informative message about the latest log delivery attempt. If the log delivery fails with USER_FAILURE, error details will be provided for fixing misconfigurations in cloud permissions.", + "launch_stage": "GA" + }, + "status": { + "description": "Enum that describes the status. Possible values are:\n* `CREATED`: There were no log delivery attempts since the config was created.\n* `SUCCEEDED`: The latest attempt of log delivery has succeeded completely.\n* `USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage.\n* `SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an Databricks internal error. Contact support if it doesn't go away soon.\n* `NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account.", + "ref": "billing.DeliveryStatus", + "launch_stage": "GA" + } + } + }, + "billing.LogType": { + "description": "*\nLog Delivery Type", + "enum": [ + "BILLABLE_USAGE", + "AUDIT_LOGS" + ], + "enum_launch_stages": { + "AUDIT_LOGS": "GA", + "BILLABLE_USAGE": "GA" + } + }, + "billing.OutputFormat": { + "description": "*\nLog Delivery Output Format", + "enum": [ + "CSV", + "JSON" + ], + "enum_launch_stages": { + "CSV": "GA", + "JSON": "GA" + } + }, + "billing.PatchStatusResponse": {}, + "billing.SortSpec": { + "fields": { + "descending": { + "description": "Whether to sort in descending order.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "field": { + "description": "The filed to sort by", + "ref": "billing.SortSpecField", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "billing.SortSpecField": { + "enum": [ + "POLICY_NAME" + ], + "enum_launch_stages": { + "POLICY_NAME": "PUBLIC_PREVIEW" + } + }, + "billing.UpdateBudgetConfigurationBudget": { + "fields": { + "account_id": { + "description": "Databricks account ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "alert_configurations": { + "description": "Alerts to configure when this budget is in a triggered state. Budgets must have exactly one alert configuration.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "budget_configuration_id": { + "description": "Databricks budget configuration ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Human-readable name of budget configuration. Max Length: 128", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "ref": "billing.BudgetConfigurationFilter", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.UpdateBudgetConfigurationRequest": { + "fields": { + "budget": { + "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "ref": "billing.UpdateBudgetConfigurationBudget", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.UpdateBudgetConfigurationResponse": { + "fields": { + "budget": { + "description": "The updated budget.", + "ref": "billing.BudgetConfiguration", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "billing.UpdateLogDeliveryConfigurationStatusRequest": { + "description": "*\nUpdate Log Delivery Configuration", + "fields": { + "status": { + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "ref": "billing.LogDeliveryConfigStatus", + "launch_stage": "GA" + } + } + }, + "billing.UsageDashboardMajorVersion": { + "enum": [ + "USAGE_DASHBOARD_MAJOR_VERSION_1", + "USAGE_DASHBOARD_MAJOR_VERSION_2" + ], + "enum_launch_stages": { + "USAGE_DASHBOARD_MAJOR_VERSION_1": "PUBLIC_PREVIEW", + "USAGE_DASHBOARD_MAJOR_VERSION_2": "PUBLIC_PREVIEW" + } + }, + "billing.UsageDashboardType": { + "enum": [ + "USAGE_DASHBOARD_TYPE_WORKSPACE", + "USAGE_DASHBOARD_TYPE_GLOBAL" + ], + "enum_launch_stages": { + "USAGE_DASHBOARD_TYPE_GLOBAL": "PUBLIC_PREVIEW", + "USAGE_DASHBOARD_TYPE_WORKSPACE": "PUBLIC_PREVIEW" + } + }, + "billing.WrappedCreateLogDeliveryConfiguration": { + "description": "*\nProperties of the new log delivery configuration.", + "fields": { + "log_delivery_configuration": { + "ref": "billing.CreateLogDeliveryConfigurationParams", + "launch_stage": "GA" + } + } + }, + "billing.WrappedLogDeliveryConfiguration": { + "fields": { + "log_delivery_configuration": { + "description": "The created log delivery configuration", + "ref": "billing.LogDeliveryConfiguration", + "launch_stage": "GA" + } + } + }, + "billing.WrappedLogDeliveryConfigurations": { + "fields": { + "log_delivery_configurations": { + "description": "Log delivery configurations were returned successfully.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Token which can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no subsequent budgets.", + "launch_stage": "GA" + } + } + }, + "bundle.CompleteVersionRequest": { + "description": "A request to complete a Version.", + "fields": { + "completion_reason": { + "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", + "ref": "bundle.VersionComplete", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "force": { + "description": "If true, force-completes the version even if the caller is not the\noriginal creator. The completion_reason must be\nVERSION_COMPLETE_FORCE_ABORT when force is true.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "bundle.Deployment": { + "description": "A bundle deployment registered with the control plane.", + "fields": { + "create_time": { + "description": "When the deployment was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The user who created the deployment (email or principal name).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "deployment_mode": { + "description": "Bundle target deployment mode (development or production), derived from the\nmost recent version's mode.", + "ref": "bundle.DeploymentMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "destroy_time": { + "description": "When the deployment was destroyed (i.e. `bundle destroy` completed).\nUnset if the deployment has not been destroyed.\nNamed destroy_time (not delete_time) because this tracks the\n`databricks bundle destroy` command, not the API-level deletion.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "destroyed_by": { + "description": "The user who destroyed the deployment (email or principal name).\nUnset if the deployment has not been destroyed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "Human-readable name for the deployment.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "last_version_id": { + "description": "The version_id of the most recent deployment version.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name of the deployment.\nFormat: deployments/{deployment_id}", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "status": { + "description": "Current status of the deployment.", + "ref": "bundle.DeploymentStatus", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "target_name": { + "description": "The bundle target name associated with this deployment.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "When the deployment was last updated.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "bundle.DeploymentMode": { + "description": "Bundle target deployment mode. Mirrors the `mode` field on a bundle target\nin `databricks.yml` (see https://docs.databricks.com/dev-tools/bundles/deployment-modes).", + "enum": [ + "DEPLOYMENT_MODE_DEVELOPMENT", + "DEPLOYMENT_MODE_PRODUCTION" + ], + "enum_launch_stages": { + "DEPLOYMENT_MODE_DEVELOPMENT": "PRIVATE_PREVIEW", + "DEPLOYMENT_MODE_PRODUCTION": "PRIVATE_PREVIEW" + } + }, + "bundle.DeploymentResourceType": { + "description": "Type of a deployment resource.", + "enum": [ + "DEPLOYMENT_RESOURCE_TYPE_JOB", + "DEPLOYMENT_RESOURCE_TYPE_PIPELINE", + "DEPLOYMENT_RESOURCE_TYPE_MODEL", + "DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL", + "DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT", + "DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT", + "DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR", + "DEPLOYMENT_RESOURCE_TYPE_SCHEMA", + "DEPLOYMENT_RESOURCE_TYPE_VOLUME", + "DEPLOYMENT_RESOURCE_TYPE_CLUSTER", + "DEPLOYMENT_RESOURCE_TYPE_DASHBOARD", + "DEPLOYMENT_RESOURCE_TYPE_APP", + "DEPLOYMENT_RESOURCE_TYPE_CATALOG", + "DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION", + "DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE", + "DEPLOYMENT_RESOURCE_TYPE_ALERT", + "DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE", + "DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE", + "DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG", + "DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT" + ], + "enum_launch_stages": { + "DEPLOYMENT_RESOURCE_TYPE_ALERT": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_APP": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_CATALOG": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_CLUSTER": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_DASHBOARD": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_JOB": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_MODEL": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_PIPELINE": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_SCHEMA": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE": "PRIVATE_PREVIEW", + "DEPLOYMENT_RESOURCE_TYPE_VOLUME": "PRIVATE_PREVIEW" + } + }, + "bundle.DeploymentStatus": { + "description": "Status of a deployment.", + "enum": [ + "DEPLOYMENT_STATUS_ACTIVE", + "DEPLOYMENT_STATUS_FAILED", + "DEPLOYMENT_STATUS_IN_PROGRESS", + "DEPLOYMENT_STATUS_DELETED" + ], + "enum_launch_stages": { + "DEPLOYMENT_STATUS_ACTIVE": "PRIVATE_PREVIEW", + "DEPLOYMENT_STATUS_DELETED": "PRIVATE_PREVIEW", + "DEPLOYMENT_STATUS_FAILED": "PRIVATE_PREVIEW", + "DEPLOYMENT_STATUS_IN_PROGRESS": "PRIVATE_PREVIEW" + } + }, + "bundle.HeartbeatRequest": { + "description": "A request to send a heartbeat for a Version." + }, + "bundle.HeartbeatResponse": { + "description": "Response for Heartbeat.", + "fields": { + "expire_time": { + "description": "The new lock expiry time after renewal.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "bundle.ListDeploymentsResponse": { + "description": "Response for ListDeployments.", + "fields": { + "deployments": { + "description": "The deployments from the queried workspace.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "bundle.ListOperationsResponse": { + "description": "Response for ListOperations.", + "fields": { + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "operations": { + "description": "The resource operations under the specified version.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.ListResourcesResponse": { + "description": "Response for ListResources.", + "fields": { + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "resources": { + "description": "The resources under the specified deployment.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.ListVersionsResponse": { + "description": "Response for ListVersions.", + "fields": { + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "versions": { + "description": "The versions under the specified deployment.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.Operation": { + "description": "An operation on a single resource performed during a version.\nOperations are append-only and record the result of applying a resource\nchange to the workspace.", + "fields": { + "action_type": { + "description": "The type of operation performed on this resource.", + "ref": "bundle.OperationActionType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "create_time": { + "description": "When the operation was recorded.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "error_message": { + "description": "Error message if the operation failed. Set when status is\nOPERATION_STATUS_FAILED. Captures the error encountered while\napplying the resource to the workspace.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "name": { + "description": "Resource name of the operation.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "resource_id": { + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "resource_key": { + "description": "Resource identifier within the bundle (e.g. \"jobs.foo\",\n\"pipelines.bar\", \"jobs.foo.permissions\", \"files.\u003crel-path\u003e\").\nCan be an arbitrary UTF-8 encoded string key. This key links the\noperation to the corresponding deployment-level Resource.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "resource_type": { + "description": "The type of the deployment resource this operation applies to. Derived\nfrom the `resource_key` prefix (e.g. \"jobs\" → JOB); the caller does not\nset this field.", + "ref": "bundle.DeploymentResourceType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "Serialized local config state after the operation.\nShould be unset for delete operations.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "status": { + "description": "Whether the operation succeeded or failed.", + "ref": "bundle.OperationStatus", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + } + } + }, + "bundle.OperationActionType": { + "description": "Type of action performed on a resource during a deployment.", + "enum": [ + "OPERATION_ACTION_TYPE_RESIZE", + "OPERATION_ACTION_TYPE_UPDATE", + "OPERATION_ACTION_TYPE_UPDATE_WITH_ID", + "OPERATION_ACTION_TYPE_CREATE", + "OPERATION_ACTION_TYPE_RECREATE", + "OPERATION_ACTION_TYPE_DELETE", + "OPERATION_ACTION_TYPE_BIND", + "OPERATION_ACTION_TYPE_BIND_AND_UPDATE", + "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + ], + "enum_launch_stages": { + "OPERATION_ACTION_TYPE_BIND": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_BIND_AND_UPDATE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_CREATE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_DELETE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_INITIAL_REGISTER": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_RECREATE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_RESIZE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_UPDATE": "PRIVATE_PREVIEW", + "OPERATION_ACTION_TYPE_UPDATE_WITH_ID": "PRIVATE_PREVIEW" + } + }, + "bundle.OperationStatus": { + "description": "Status of a resource operation.", + "enum": [ + "OPERATION_STATUS_SUCCEEDED", + "OPERATION_STATUS_FAILED" + ], + "enum_launch_stages": { + "OPERATION_STATUS_FAILED": "PRIVATE_PREVIEW", + "OPERATION_STATUS_SUCCEEDED": "PRIVATE_PREVIEW" + } + }, + "bundle.Resource": { + "description": "A resource managed by a deployment. Resources are implicitly created,\nupdated, or deleted when operations are recorded on a version.", + "fields": { + "last_action_type": { + "description": "The action performed on this resource during the last version.", + "ref": "bundle.OperationActionType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_version_id": { + "description": "The version_id of the last version where this resource was updated.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name.\nFormat: deployments/{deployment_id}/resources/{resource_key}", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "resource_id": { + "description": "ID that references the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "resource_key": { + "description": "Resource identifier within the bundle (e.g. \"jobs.foo\",\n\"pipelines.bar\", \"jobs.foo.permissions\").", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "resource_type": { + "description": "The type of the deployment resource.", + "ref": "bundle.DeploymentResourceType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "state": { + "description": "Serialized local config state (what the CLI deployed).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "bundle.Version": { + "description": "A single invocation of a deploy or destroy command against a deployment.\nCreating a version acquires an exclusive lock on the parent deployment.", + "fields": { + "cli_version": { + "description": "CLI version used to initiate the version.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "complete_time": { + "description": "When the version completed. Unset while the version is in progress.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "completed_by": { + "description": "The user who completed the version (email or principal name).\nMay differ from `created_by` when another user force-completes\nthe version.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "completion_reason": { + "description": "Why the version was completed. Unset while in progress.\nSet when status transitions to COMPLETED.", + "ref": "bundle.VersionComplete", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "create_time": { + "description": "When the version was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The user who created the version (email or principal name).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "deployment_mode": { + "description": "Bundle target deployment mode (development or production), captured at the\ntime of this version.", + "ref": "bundle.DeploymentMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "display_name": { + "description": "Display name for the deployment, captured at the time of this version.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "name": { + "description": "Resource name of the version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "status": { + "description": "Status of the version: IN_PROGRESS or COMPLETED.", + "ref": "bundle.VersionStatus", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "target_name": { + "description": "Target name of the deployment, captured at the time of this version.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "version_id": { + "description": "Monotonically increasing version identifier within the parent\ndeployment. Assigned by the client on creation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "version_type": { + "description": "Type of version (deploy or destroy).", + "ref": "bundle.VersionType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + } + } + }, + "bundle.VersionComplete": { + "description": "Reason why a version was completed.", + "enum": [ + "VERSION_COMPLETE_SUCCESS", + "VERSION_COMPLETE_FAILURE", + "VERSION_COMPLETE_FORCE_ABORT", + "VERSION_COMPLETE_LEASE_EXPIRED" + ], + "enum_launch_stages": { + "VERSION_COMPLETE_FAILURE": "PRIVATE_PREVIEW", + "VERSION_COMPLETE_FORCE_ABORT": "PRIVATE_PREVIEW", + "VERSION_COMPLETE_LEASE_EXPIRED": "PRIVATE_PREVIEW", + "VERSION_COMPLETE_SUCCESS": "PRIVATE_PREVIEW" + } + }, + "bundle.VersionStatus": { + "description": "Status of a version.", + "enum": [ + "VERSION_STATUS_IN_PROGRESS", + "VERSION_STATUS_COMPLETED" + ], + "enum_launch_stages": { + "VERSION_STATUS_COMPLETED": "PRIVATE_PREVIEW", + "VERSION_STATUS_IN_PROGRESS": "PRIVATE_PREVIEW" + } + }, + "bundle.VersionType": { + "description": "Type of version.", + "enum": [ + "VERSION_TYPE_DEPLOY", + "VERSION_TYPE_DESTROY" + ], + "enum_launch_stages": { + "VERSION_TYPE_DEPLOY": "PRIVATE_PREVIEW", + "VERSION_TYPE_DESTROY": "PRIVATE_PREVIEW" + } + }, + "catalog.AccessRequestDestinations": { + "fields": { + "are_any_destinations_hidden": { + "description": "Indicates whether any destinations are hidden from the caller due to a lack of permissions.\nThis value is true if the caller does not have permission to see all destinations.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "destination_source_securable": { + "description": "The source securable from which the destinations are inherited. Either the same value as securable (if destination\nis set directly on the securable) or the nearest parent securable with destinations set.", + "ref": "catalog.Securable", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "destinations": { + "description": "The access request destinations for the securable.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "UNORDERED_LIST" + ] + }, + "full_name": { + "description": "The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "securable": { + "description": "The securable for which the access request destinations are being modified or read.", + "ref": "catalog.Securable", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "securable_type": { + "description": "The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.AccountsCreateMetastore": { + "description": "Properties of the new metastore.", + "fields": { + "metastore_info": { + "ref": "catalog.CreateAccountsMetastore", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsCreateMetastoreAssignment": { + "description": "The mapping from workspace to metastore.", + "fields": { + "metastore_assignment": { + "ref": "catalog.CreateMetastoreAssignment", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsCreateMetastoreAssignmentResponse": { + "description": "The metastore assignment was successfully created." + }, + "catalog.AccountsCreateMetastoreResponse": { + "fields": { + "metastore_info": { + "ref": "catalog.MetastoreInfo", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsCreateStorageCredential": { + "fields": { + "credential_info": { + "ref": "catalog.CreateAccountsStorageCredential", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Optional, default false.\nSupplying true to this argument skips validation of the created set of credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsCreateStorageCredentialInfo": { + "fields": { + "credential_info": { + "ref": "catalog.StorageCredentialInfo", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsDeleteMetastoreAssignmentResponse": { + "description": "The metastore assignment was successfully deleted." + }, + "catalog.AccountsDeleteMetastoreResponse": { + "description": "The metastore was successfully deleted." + }, + "catalog.AccountsDeleteStorageCredentialResponse": { + "description": "The storage credential was successfully deleted." + }, + "catalog.AccountsGetMetastoreResponse": { + "description": "The metastore was successfully returned.", + "fields": { + "metastore_info": { + "ref": "catalog.MetastoreInfo", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsListMetastoresResponse": { + "description": "Metastores were returned successfully.", + "fields": { + "metastores": { + "description": "An array of metastore information objects.", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsMetastoreAssignment": { + "description": "The workspace metastore assignment was successfully returned.", + "fields": { + "metastore_assignment": { + "ref": "catalog.MetastoreAssignment", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsStorageCredentialInfo": { + "description": "The storage credential was successfully retrieved.", + "fields": { + "credential_info": { + "ref": "catalog.StorageCredentialInfo", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsUpdateMetastore": { + "description": "Properties of the metastore to change.", + "fields": { + "metastore_info": { + "description": "Properties of the metastore to change.", + "ref": "catalog.UpdateAccountsMetastore", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsUpdateMetastoreAssignment": { + "description": "The metastore assignment to update.", + "fields": { + "metastore_assignment": { + "ref": "catalog.UpdateMetastoreAssignment", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsUpdateMetastoreAssignmentResponse": { + "description": "The metastore assignment was successfully updated." + }, + "catalog.AccountsUpdateMetastoreResponse": { + "description": "The metastore update request succeeded.", + "fields": { + "metastore_info": { + "ref": "catalog.MetastoreInfo", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsUpdateStorageCredential": { + "description": "The storage credential to update.", + "fields": { + "credential_info": { + "ref": "catalog.UpdateAccountsStorageCredential", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Optional. Supplying true to this argument skips validation of the updated set of credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.AccountsUpdateStorageCredentialResponse": { + "description": "The storage credential was successfully updated.", + "fields": { + "credential_info": { + "ref": "catalog.StorageCredentialInfo", + "launch_stage": "GA" + } + } + }, + "catalog.ArtifactAllowlistInfo": { + "fields": { + "artifact_matchers": { + "description": "A list of allowed artifact match patterns.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this artifact allowlist was set, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of the user who set the artifact allowlist.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.ArtifactMatcher": { + "fields": { + "artifact": { + "description": "The artifact path or maven coordinate", + "launch_stage": "GA" + }, + "match_type": { + "description": "The pattern matching type of the artifact", + "ref": "catalog.MatchType", + "launch_stage": "GA" + } + } + }, + "catalog.ArtifactType": { + "description": "The artifact type", + "enum": [ + "INIT_SCRIPT", + "LIBRARY_JAR", + "LIBRARY_MAVEN" + ], + "enum_launch_stages": { + "INIT_SCRIPT": "GA", + "LIBRARY_JAR": "GA", + "LIBRARY_MAVEN": "GA" + } + }, + "catalog.AssignResponse": {}, + "catalog.AwsCredentials": { + "description": "AWS temporary credentials for API authentication.\nRead more at https://docs.aws.amazon.com/STS/latest/APIReference/API_Credentials.html.", + "fields": { + "access_key_id": { + "description": "The access key ID that identifies the temporary credentials.", + "launch_stage": "GA" + }, + "access_point": { + "description": "The Amazon Resource Name (ARN) of the S3 access point for\ntemporary credentials related the external location.", + "launch_stage": "GA" + }, + "secret_access_key": { + "description": "The secret access key that can be used to sign AWS API requests.", + "launch_stage": "GA" + }, + "session_token": { + "description": "The token that users must pass to AWS API to use the temporary credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.AwsIamRole": { + "description": "The AWS IAM role configuration", + "fields": { + "external_id": { + "description": "The external ID used in role assumption to prevent the confused deputy problem.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "role_arn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.", + "launch_stage": "GA" + }, + "unity_catalog_iam_arn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks.\nThis is the identity that is going to assume the AWS IAM role.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.AwsIamRoleRequest": { + "description": "The AWS IAM role configuration", + "fields": { + "role_arn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.AwsIamRoleResponse": { + "description": "The AWS IAM role configuration", + "fields": { + "external_id": { + "description": "The external ID used in role assumption to prevent the confused deputy problem.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "role_arn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials.", + "launch_stage": "GA" + }, + "unity_catalog_iam_arn": { + "description": "The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks.\nThis is the identity that is going to assume the AWS IAM role.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.AwsSqsQueue": { + "fields": { + "managed_resource_id": { + "description": "Unique identifier included in the name of file events managed cloud resources.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "queue_url": { + "description": "The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.\nOnly required for provided_sqs.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureActiveDirectoryToken": { + "description": "Azure Active Directory token, essentially the Oauth token for Azure Service Principal or Managed\nIdentity.\nRead more at https://learn.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/aad/service-prin-aad-token", + "fields": { + "aad_token": { + "description": "Opaque token that contains claims that you can use in Azure Active Directory to access cloud services.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureEncryptionSettings": { + "fields": { + "azure_cmk_access_connector_id": { + "launch_stage": "GA" + }, + "azure_cmk_managed_identity_id": { + "launch_stage": "GA" + }, + "azure_tenant_id": { + "launch_stage": "GA" + } + } + }, + "catalog.AzureManagedIdentity": { + "description": "The Azure managed identity configuration.", + "fields": { + "access_connector_id": { + "description": "The Azure resource ID of the Azure Databricks Access Connector. Use the format\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.", + "launch_stage": "GA" + }, + "credential_id": { + "description": "The Databricks internal ID that represents this managed identity.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "managed_identity_id": { + "description": "The Azure resource ID of the managed identity. Use the format,\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`\nThis is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity.\nIf this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureManagedIdentityRequest": { + "description": "The Azure managed identity configuration.", + "fields": { + "access_connector_id": { + "description": "The Azure resource ID of the Azure Databricks Access Connector. Use the format\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.", + "launch_stage": "GA" + }, + "managed_identity_id": { + "description": "The Azure resource ID of the managed identity. Use the format,\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`\nThis is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity.\nIf this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureManagedIdentityResponse": { + "description": "The Azure managed identity configuration.", + "fields": { + "access_connector_id": { + "description": "The Azure resource ID of the Azure Databricks Access Connector. Use the format\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`.", + "launch_stage": "GA" + }, + "credential_id": { + "description": "The Databricks internal ID that represents this managed identity.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "managed_identity_id": { + "description": "The Azure resource ID of the managed identity. Use the format,\n`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`\nThis is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity.\nIf this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureQueueStorage": { + "fields": { + "managed_resource_id": { + "description": "Unique identifier included in the name of file events managed cloud resources.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "queue_url": { + "description": "The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}\nOnly required for provided_aqs.", + "launch_stage": "GA" + }, + "resource_group": { + "description": "Optional resource group for the queue, event grid subscription, and external location storage\naccount.\nOnly required for locations with a service principal storage credential", + "launch_stage": "GA" + }, + "subscription_id": { + "description": "Optional subscription id for the queue, event grid subscription, and external location storage\naccount.\nRequired for locations with a service principal storage credential", + "launch_stage": "GA" + } + } + }, + "catalog.AzureServicePrincipal": { + "description": "The Azure service principal configuration. Only applicable when purpose is **STORAGE**.", + "fields": { + "application_id": { + "description": "The application ID of the application registration within the referenced AAD tenant.", + "launch_stage": "GA" + }, + "client_secret": { + "description": "The client secret generated for the above app ID in AAD.", + "launch_stage": "GA" + }, + "directory_id": { + "description": "The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application.", + "launch_stage": "GA" + } + } + }, + "catalog.AzureUserDelegationSAS": { + "description": "Azure temporary credentials for API authentication.\nRead more at https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas", + "fields": { + "sas_token": { + "description": "The signed URI (SAS Token) used to access blob services for a given path", + "launch_stage": "GA" + } + } + }, + "catalog.BatchCreateAccessRequestsRequest": { + "fields": { + "requests": { + "description": "A list of individual access requests, where each request corresponds to\na set of permissions being requested on a list of securables for a specified principal.\n\nAt most 30 requests per API call.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.BatchCreateAccessRequestsResponse": { + "fields": { + "responses": { + "description": "The access request destinations for each securable object the principal requested.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.CancelRefreshResponse": {}, + "catalog.CatalogInfo": { + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_type": { + "ref": "catalog.CatalogType", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "connection_name": { + "description": "The name of the connection to an external data source.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this catalog was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of catalog creator.", + "launch_stage": "GA" + }, + "effective_predictive_optimization_flag": { + "ref": "catalog.EffectivePredictiveOptimizationFlag", + "launch_stage": "GA" + }, + "enable_predictive_optimization": { + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + }, + "full_name": { + "description": "The full name of the catalog. Corresponds with the name field.", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a specific set of workspaces.", + "ref": "catalog.CatalogIsolationMode", + "launch_stage": "GA" + }, + "managed_encryption_settings": { + "description": "Control CMK encryption for managed catalog data", + "ref": "catalog.EncryptionSettings", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of catalog.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of catalog.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "provider_name": { + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", + "launch_stage": "GA" + }, + "provisioning_info": { + "ref": "catalog.ProvisioningInfo", + "launch_stage": "GA" + }, + "securable_type": { + "ref": "catalog.SecurableType", + "launch_stage": "GA" + }, + "share_name": { + "description": "The name of the share under the share provider.", + "launch_stage": "GA" + }, + "storage_location": { + "description": "Storage Location URL (full path) for managed tables within catalog.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for managed tables within catalog.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this catalog was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified catalog.", + "launch_stage": "GA" + } + } + }, + "catalog.CatalogIsolationMode": { + "enum": [ + "OPEN", + "ISOLATED" + ], + "enum_launch_stages": { + "ISOLATED": "GA", + "OPEN": "GA" + } + }, + "catalog.CatalogType": { + "description": "The type of the catalog.", + "enum": [ + "MANAGED_CATALOG", + "DELTASHARING_CATALOG", + "SYSTEM_CATALOG", + "INTERNAL_CATALOG", + "FOREIGN_CATALOG", + "MANAGED_ONLINE_CATALOG" + ], + "enum_launch_stages": { + "DELTASHARING_CATALOG": "GA", + "FOREIGN_CATALOG": "GA", + "INTERNAL_CATALOG": "GA", + "MANAGED_CATALOG": "GA", + "MANAGED_ONLINE_CATALOG": "GA", + "SYSTEM_CATALOG": "GA" + } + }, + "catalog.CloudflareApiToken": { + "description": "The Cloudflare API token configuration.\nRead more at https://developers.cloudflare.com/r2/api/s3/tokens/", + "fields": { + "access_key_id": { + "description": "The access key ID associated with the API token.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "account_id": { + "description": "The ID of the account associated with the API token.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "secret_access_key": { + "description": "The secret access token generated for the above access key ID.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.ColumnInfo": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "mask": { + "ref": "catalog.ColumnMask", + "launch_stage": "GA" + }, + "name": { + "description": "Name of Column.", + "launch_stage": "GA" + }, + "nullable": { + "description": "Whether field may be Null (default: true).", + "launch_stage": "GA" + }, + "partition_index": { + "description": "Partition index for column.", + "launch_stage": "GA" + }, + "position": { + "description": "Ordinal position of column (starting at position 0).", + "launch_stage": "GA" + }, + "type_interval_type": { + "description": "Format of IntervalType.", + "launch_stage": "GA" + }, + "type_json": { + "description": "Full data type specification, JSON-serialized.", + "launch_stage": "GA" + }, + "type_name": { + "ref": "catalog.ColumnTypeName", + "launch_stage": "GA" + }, + "type_precision": { + "description": "Digits of precision; required for DecimalTypes.", + "launch_stage": "GA" + }, + "type_scale": { + "description": "Digits to right of decimal; Required for DecimalTypes.", + "launch_stage": "GA" + }, + "type_text": { + "description": "Full data type specification as SQL/catalogString text.", + "launch_stage": "GA" + } + } + }, + "catalog.ColumnMask": { + "fields": { + "function_name": { + "description": "The full name of the column mask SQL UDF.", + "launch_stage": "GA" + }, + "using_arguments": { + "description": "The list of additional table columns or literals to be passed as additional arguments to\na column mask function. This is the replacement of the deprecated using_column_names field and\ncarries information about the types (alias or constant) of the arguments to the mask function.", + "launch_stage": "GA" + }, + "using_column_names": { + "description": "The list of additional table columns to be passed as input to the column mask function. The\nfirst arg of the mask function should be of the type of the column being masked and the\ntypes of the rest of the args should match the types of columns in 'using_column_names'.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "catalog.ColumnMaskOptions": { + "fields": { + "function_name": { + "description": "The fully qualified name of the column mask function.\nThe function is called on each row of the target table.\nThe function's first argument and its return type should match the type of the masked column.\nRequired on create and update.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "on_column": { + "description": "The alias of the column to be masked. The alias must refer to one of matched columns.\nThe values of the column is passed to the column mask function as the first argument.\nRequired on create and update.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "using": { + "description": "Optional list of column aliases or constant literals to be passed as additional arguments to the column mask function.\nThe type of each column should match the positional argument of the column mask function.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.ColumnRelationship": { + "fields": { + "source": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "target": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ColumnTypeName": { + "enum": [ + "BOOLEAN", + "BYTE", + "SHORT", + "INT", + "LONG", + "FLOAT", + "DOUBLE", + "DATE", + "TIMESTAMP", + "STRING", + "BINARY", + "DECIMAL", + "INTERVAL", + "ARRAY", + "STRUCT", + "MAP", + "CHAR", + "NULL", + "USER_DEFINED_TYPE", + "TIMESTAMP_NTZ", + "VARIANT", + "GEOMETRY", + "GEOGRAPHY", + "TABLE_TYPE" + ], + "enum_launch_stages": { + "ARRAY": "GA", + "BINARY": "GA", + "BOOLEAN": "GA", + "BYTE": "GA", + "CHAR": "GA", + "DATE": "GA", + "DECIMAL": "GA", + "DOUBLE": "GA", + "FLOAT": "GA", + "GEOGRAPHY": "GA", + "GEOMETRY": "GA", + "INT": "GA", + "INTERVAL": "GA", + "LONG": "GA", + "MAP": "GA", + "NULL": "GA", + "SHORT": "GA", + "STRING": "GA", + "STRUCT": "GA", + "TABLE_TYPE": "GA", + "TIMESTAMP": "GA", + "TIMESTAMP_NTZ": "GA", + "USER_DEFINED_TYPE": "GA", + "VARIANT": "GA" + } + }, + "catalog.ConnectionDependency": { + "description": "A connection that is dependent on a SQL object.", + "fields": { + "connection_name": { + "description": "Full name of the dependent connection, in the form of __connection_name__.", + "launch_stage": "GA" + } + } + }, + "catalog.ConnectionInfo": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "connection_id": { + "description": "Unique identifier of the Connection.", + "launch_stage": "GA" + }, + "connection_type": { + "description": "The type of connection.", + "ref": "catalog.ConnectionType", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this connection was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of connection creator.", + "launch_stage": "GA" + }, + "credential_type": { + "description": "The type of credential.", + "ref": "catalog.CredentialType", + "launch_stage": "GA" + }, + "full_name": { + "description": "Full name of connection.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the connection.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of the connection.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "provisioning_info": { + "ref": "catalog.ProvisioningInfo", + "launch_stage": "GA" + }, + "read_only": { + "description": "If the connection is read only.", + "launch_stage": "GA" + }, + "securable_type": { + "ref": "catalog.SecurableType", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this connection was updated, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified connection.", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the remote data source, extracted from options.", + "launch_stage": "GA" + } + } + }, + "catalog.ConnectionType": { + "description": "Next Id: 126", + "enum": [ + "UNKNOWN_CONNECTION_TYPE", + "MYSQL", + "POSTGRESQL", + "SNOWFLAKE", + "REDSHIFT", + "SQLDW", + "SQLSERVER", + "DATABRICKS", + "SALESFORCE", + "BIGQUERY", + "WORKDAY_RAAS", + "HIVE_METASTORE", + "GA4_RAW_DATA", + "SERVICENOW", + "SALESFORCE_DATA_CLOUD", + "GLUE", + "ORACLE", + "TERADATA", + "HTTP", + "POWER_BI", + "CONFLUENCE", + "META_MARKETING", + "HUBSPOT", + "ZENDESK", + "GITHUB", + "OUTLOOK", + "SMARTSHEET" + ], + "enum_launch_stages": { + "BIGQUERY": "GA", + "CONFLUENCE": "GA", + "DATABRICKS": "GA", + "GA4_RAW_DATA": "GA", + "GITHUB": "PUBLIC_BETA", + "GLUE": "GA", + "HIVE_METASTORE": "GA", + "HTTP": "GA", + "HUBSPOT": "GA", + "META_MARKETING": "PUBLIC_BETA", + "MYSQL": "GA", + "ORACLE": "GA", + "OUTLOOK": "PUBLIC_BETA", + "POSTGRESQL": "GA", + "POWER_BI": "GA", + "REDSHIFT": "GA", + "SALESFORCE": "GA", + "SALESFORCE_DATA_CLOUD": "GA", + "SERVICENOW": "GA", + "SMARTSHEET": "PUBLIC_BETA", + "SNOWFLAKE": "GA", + "SQLDW": "GA", + "SQLSERVER": "GA", + "TERADATA": "GA", + "UNKNOWN_CONNECTION_TYPE": "GA", + "WORKDAY_RAAS": "GA", + "ZENDESK": "GA" + } + }, + "catalog.ContinuousUpdateStatus": { + "description": "Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE\nor the ONLINE_UPDATING_PIPELINE_RESOURCES state.", + "fields": { + "initial_pipeline_sync_progress": { + "description": "Progress of the initial data synchronization.", + "ref": "catalog.PipelineProgress", + "launch_stage": "PUBLIC_PREVIEW" + }, + "last_processed_commit_version": { + "description": "The last source table Delta version that was synced to the online table. Note that this Delta\nversion may not be completely synced to the online table yet.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "timestamp": { + "description": "The timestamp of the last time any data was synchronized from the source table to the online\ntable.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.CreateAccessRequest": { + "fields": { + "behalf_of": { + "description": "Optional. The principal this request is for.\nEmpty `behalf_of` defaults to the requester's identity.\n\nPrincipals must be unique across the API call.", + "ref": "catalog.Principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "comment": { + "description": "Optional. Comment associated with the request.\n\nAt most 200 characters, can only contain lowercase/uppercase\nletters (a-z, A-Z), numbers (0-9), punctuation, and spaces.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "securable_permissions": { + "description": "List of securables and their corresponding requested UC privileges.\n\nAt most 30 securables can be requested for a principal per batched call.\nEach securable can only be requested once per principal.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.CreateAccessRequestResponse": { + "fields": { + "behalf_of": { + "description": "The principal the request was made on behalf of.", + "ref": "catalog.Principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "request_destinations": { + "description": "The access request destinations for all the securables the principal requested.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.CreateAccountsMetastore": { + "fields": { + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The user-specified name of the metastore.", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).", + "launch_stage": "GA" + }, + "storage_root": { + "description": "The storage root URL for metastore", + "launch_stage": "GA" + } + } + }, + "catalog.CreateAccountsStorageCredential": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleRequest", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityRequest", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountRequest", + "launch_stage": "GA" + }, + "name": { + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateCatalog": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "connection_name": { + "description": "The name of the connection to an external data source.", + "launch_stage": "GA" + }, + "managed_encryption_settings": { + "description": "Control CMK encryption for managed catalog data", + "ref": "catalog.EncryptionSettings", + "launch_stage": "GA" + }, + "name": { + "description": "Name of catalog.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "provider_name": { + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", + "launch_stage": "GA" + }, + "share_name": { + "description": "The name of the share under the share provider.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for managed tables within catalog.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateConnection": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "connection_type": { + "description": "The type of connection.", + "ref": "catalog.ConnectionType", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the connection.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "read_only": { + "description": "If the connection is read only.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateCredentialRequest": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRole", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentity", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccount", + "launch_stage": "GA" + }, + "name": { + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "launch_stage": "GA" + }, + "purpose": { + "description": "Indicates the purpose of the credential.", + "ref": "catalog.CredentialPurpose", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Optional. Supplying true to this argument skips validation of the created\nset of credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateExternalLocation": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "credential_name": { + "description": "Name of the storage credential used with this location.", + "launch_stage": "GA" + }, + "effective_enable_file_events": { + "description": "The effective value of `enable_file_events` after applying server-side defaults.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_file_event_queue": { + "description": "The effective file event queue configuration after applying server-side defaults.\nAlways populated when a queue is provisioned, regardless of whether the user explicitly\nset `enable_file_events`. Use this field instead of `file_event_queue` for reading\nthe actual queue state.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "enable_file_events": { + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", + "launch_stage": "GA" + }, + "encryption_details": { + "ref": "catalog.EncryptionDetails", + "launch_stage": "GA" + }, + "fallback": { + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", + "launch_stage": "GA" + }, + "file_event_queue": { + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the external location.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Indicates whether the external location is read-only.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Skips validation of the storage credential associated with the external location.", + "launch_stage": "GA" + }, + "url": { + "description": "Path URL of the external location.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateFunction": { + "fields": { + "catalog_name": { + "description": "Name of parent Catalog.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "data_type": { + "description": "Scalar function return data type.", + "ref": "catalog.ColumnTypeName", + "launch_stage": "GA" + }, + "external_language": { + "description": "External function language.", + "launch_stage": "GA" + }, + "external_name": { + "description": "External function name.", + "launch_stage": "GA" + }, + "full_data_type": { + "description": "Pretty printed function data type.", + "launch_stage": "GA" + }, + "input_params": { + "description": "Function input parameters.", + "ref": "catalog.FunctionParameterInfos", + "launch_stage": "GA" + }, + "is_deterministic": { + "description": "Whether the function is deterministic.", + "launch_stage": "GA" + }, + "is_null_call": { + "description": "Function null call.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of function, relative to parent schema.", + "launch_stage": "GA" + }, + "parameter_style": { + "description": "Function parameter style. **S** is the value for SQL.", + "ref": "catalog.CreateFunctionParameterStyle", + "launch_stage": "GA" + }, + "properties": { + "description": "JSON-serialized key-value pair map, encoded (escaped) as a string.", + "launch_stage": "GA" + }, + "return_params": { + "description": "Table function return parameters.", + "ref": "catalog.FunctionParameterInfos", + "launch_stage": "GA" + }, + "routine_body": { + "description": "Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**.", + "ref": "catalog.CreateFunctionRoutineBody", + "launch_stage": "GA" + }, + "routine_definition": { + "description": "Function body.", + "launch_stage": "GA" + }, + "routine_dependencies": { + "description": "function dependencies.", + "ref": "catalog.DependencyList", + "launch_stage": "GA" + }, + "schema_name": { + "description": "Name of parent Schema relative to its parent Catalog.", + "launch_stage": "GA" + }, + "security_type": { + "description": "Function security type.", + "ref": "catalog.CreateFunctionSecurityType", + "launch_stage": "GA" + }, + "specific_name": { + "description": "Specific name of the function; Reserved for future use.", + "launch_stage": "GA" + }, + "sql_data_access": { + "description": "Function SQL data access.", + "ref": "catalog.CreateFunctionSqlDataAccess", + "launch_stage": "GA" + }, + "sql_path": { + "description": "List of schemes whose objects can be referenced without qualification.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateFunctionParameterStyle": { + "enum": [ + "S" + ], + "enum_launch_stages": { + "S": "GA" + } + }, + "catalog.CreateFunctionRequest": { + "fields": { + "function_info": { + "description": "Partial __FunctionInfo__ specifying the function to be created.", + "ref": "catalog.CreateFunction", + "launch_stage": "GA" + } + } + }, + "catalog.CreateFunctionRoutineBody": { + "enum": [ + "SQL", + "EXTERNAL" + ], + "enum_launch_stages": { + "EXTERNAL": "GA", + "SQL": "GA" + } + }, + "catalog.CreateFunctionSecurityType": { + "enum": [ + "DEFINER" + ], + "enum_launch_stages": { + "DEFINER": "GA" + } + }, + "catalog.CreateFunctionSqlDataAccess": { + "enum": [ + "CONTAINS_SQL", + "READS_SQL_DATA", + "NO_SQL" + ], + "enum_launch_stages": { + "CONTAINS_SQL": "GA", + "NO_SQL": "GA", + "READS_SQL_DATA": "GA" + } + }, + "catalog.CreateMetastore": { + "fields": { + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The user-specified name of the metastore.", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).", + "launch_stage": "GA" + }, + "storage_root": { + "description": "The storage root URL for metastore", + "launch_stage": "GA" + } + } + }, + "catalog.CreateMetastoreAssignment": { + "fields": { + "default_catalog_name": { + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "deprecated": true, + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique ID of the metastore.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateMonitor": { + "fields": { + "assets_dir": { + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "launch_stage": "GA" + }, + "baseline_table_name": { + "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "launch_stage": "GA" + }, + "custom_metrics": { + "description": "[Create:OPT Update:OPT] Custom metrics.", + "launch_stage": "GA" + }, + "data_classification_config": { + "description": "[Create:OPT Update:OPT] Data classification related config.", + "ref": "catalog.MonitorDataClassificationConfig", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "inference_log": { + "ref": "catalog.MonitorInferenceLog", + "launch_stage": "GA" + }, + "latest_monitor_failure_msg": { + "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", + "launch_stage": "GA" + }, + "notifications": { + "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", + "ref": "catalog.MonitorNotifications", + "launch_stage": "GA" + }, + "output_schema_name": { + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "schedule": { + "description": "[Create:OPT Update:OPT] The monitor schedule.", + "ref": "catalog.MonitorCronSchedule", + "launch_stage": "GA" + }, + "skip_builtin_dashboard": { + "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", + "launch_stage": "GA" + }, + "slicing_exprs": { + "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "launch_stage": "GA" + }, + "snapshot": { + "description": "Configuration for monitoring snapshot tables.", + "ref": "catalog.MonitorSnapshot", + "launch_stage": "GA" + }, + "time_series": { + "description": "Configuration for monitoring time series tables.", + "ref": "catalog.MonitorTimeSeries", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateRegisteredModelRequest": { + "fields": { + "aliases": { + "description": "List of aliases associated with the registered model", + "launch_stage": "GA" + }, + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog where the schema and the registered model reside", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the registered model", + "launch_stage": "GA" + }, + "created_at": { + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "created_by": { + "description": "The identifier of the user who created the registered model", + "launch_stage": "GA" + }, + "full_name": { + "description": "The three-level (fully qualified) name of the registered model", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique identifier of the metastore", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the registered model", + "launch_stage": "GA" + }, + "owner": { + "description": "The identifier of the user who owns the registered model", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema where the registered model resides", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud under which model version data files are stored", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "updated_by": { + "description": "The identifier of the user who updated the registered model last time", + "launch_stage": "GA" + } + } + }, + "catalog.CreateRequestExternalLineage": { + "fields": { + "columns": { + "description": "List of column relationships between source and target objects.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "description": "Unique identifier of the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "properties": { + "description": "Key-value properties associated with the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source": { + "description": "Source object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target": { + "description": "Target object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.CreateSchema": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of schema, relative to parent catalog.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for managed tables within schema.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateStorageCredential": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleRequest", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityRequest", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountRequest", + "launch_stage": "GA" + }, + "name": { + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Supplying true to this argument skips validation of the created credential.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateTableConstraint": { + "fields": { + "constraint": { + "ref": "catalog.TableConstraint", + "launch_stage": "GA" + }, + "full_name_arg": { + "description": "The full name of the table referenced by the constraint.", + "launch_stage": "GA" + } + } + }, + "catalog.CreateVolumeRequestContent": { + "fields": { + "catalog_name": { + "description": "The name of the catalog where the schema and the volume are", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the volume", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the volume", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema where the volume is", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud", + "launch_stage": "GA" + }, + "volume_type": { + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "ref": "catalog.VolumeType", + "launch_stage": "GA" + } + } + }, + "catalog.CredentialDependency": { + "description": "A credential that is dependent on a SQL object.", + "fields": { + "credential_name": { + "description": "Full name of the dependent credential, in the form of __credential_name__.", + "launch_stage": "GA" + } + } + }, + "catalog.CredentialInfo": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRole", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentity", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this credential was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of credential creator.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccount", + "launch_stage": "GA" + }, + "full_name": { + "description": "The full name of the credential.", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the credential.", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of the parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of credential.", + "launch_stage": "GA" + }, + "purpose": { + "description": "Indicates the purpose of the credential.", + "ref": "catalog.CredentialPurpose", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this credential was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the credential.", + "launch_stage": "GA" + }, + "used_for_managed_storage": { + "description": "Whether this credential is the current metastore's root storage credential.\nOnly applicable when purpose is **STORAGE**.", + "launch_stage": "GA" + } + } + }, + "catalog.CredentialPurpose": { + "enum": [ + "STORAGE", + "SERVICE" + ], + "enum_launch_stages": { + "SERVICE": "GA", + "STORAGE": "GA" + } + }, + "catalog.CredentialType": { + "description": "Next Id: 19", + "enum": [ + "UNKNOWN_CREDENTIAL_TYPE", + "USERNAME_PASSWORD", + "OAUTH_U2M", + "OAUTH_M2M", + "OAUTH_REFRESH_TOKEN", + "OAUTH_ACCESS_TOKEN", + "OAUTH_RESOURCE_OWNER_PASSWORD", + "SERVICE_CREDENTIAL", + "BEARER_TOKEN", + "OIDC_TOKEN", + "PEM_PRIVATE_KEY", + "OAUTH_U2M_MAPPING", + "ANY_STATIC_CREDENTIAL", + "OAUTH_MTLS", + "SSWS_TOKEN", + "EDGEGRID_AKAMAI" + ], + "enum_launch_stages": { + "ANY_STATIC_CREDENTIAL": "GA", + "BEARER_TOKEN": "GA", + "EDGEGRID_AKAMAI": "GA", + "OAUTH_ACCESS_TOKEN": "GA", + "OAUTH_M2M": "GA", + "OAUTH_MTLS": "GA", + "OAUTH_REFRESH_TOKEN": "GA", + "OAUTH_RESOURCE_OWNER_PASSWORD": "GA", + "OAUTH_U2M": "GA", + "OAUTH_U2M_MAPPING": "GA", + "OIDC_TOKEN": "GA", + "PEM_PRIVATE_KEY": "GA", + "SERVICE_CREDENTIAL": "GA", + "SSWS_TOKEN": "GA", + "UNKNOWN_CREDENTIAL_TYPE": "GA", + "USERNAME_PASSWORD": "GA" + } + }, + "catalog.CredentialValidationResult": { + "fields": { + "message": { + "description": "Error message would exist when the result does not equal to **PASS**.", + "launch_stage": "GA" + }, + "result": { + "description": "The results of the tested operation.", + "ref": "catalog.ValidateCredentialResult", + "launch_stage": "GA" + } + } + }, + "catalog.DataSourceFormat": { + "description": "Data source format", + "enum": [ + "DELTA", + "CSV", + "JSON", + "AVRO", + "PARQUET", + "ORC", + "TEXT", + "UNITY_CATALOG", + "DELTASHARING", + "DATABRICKS_FORMAT", + "MYSQL_FORMAT", + "ORACLE_FORMAT", + "POSTGRESQL_FORMAT", + "REDSHIFT_FORMAT", + "SNOWFLAKE_FORMAT", + "SQLDW_FORMAT", + "SQLSERVER_FORMAT", + "SALESFORCE_FORMAT", + "SALESFORCE_DATA_CLOUD_FORMAT", + "TERADATA_FORMAT", + "BIGQUERY_FORMAT", + "NETSUITE_FORMAT", + "WORKDAY_RAAS_FORMAT", + "MONGODB_FORMAT", + "HIVE", + "VECTOR_INDEX_FORMAT", + "DATABRICKS_ROW_STORE_FORMAT", + "DELTA_UNIFORM_HUDI", + "DELTA_UNIFORM_ICEBERG", + "ICEBERG" + ], + "enum_launch_stages": { + "AVRO": "GA", + "BIGQUERY_FORMAT": "GA", + "CSV": "GA", + "DATABRICKS_FORMAT": "GA", + "DATABRICKS_ROW_STORE_FORMAT": "GA", + "DELTA": "GA", + "DELTASHARING": "GA", + "DELTA_UNIFORM_HUDI": "GA", + "DELTA_UNIFORM_ICEBERG": "GA", + "HIVE": "GA", + "ICEBERG": "GA", + "JSON": "GA", + "MONGODB_FORMAT": "GA", + "MYSQL_FORMAT": "GA", + "NETSUITE_FORMAT": "GA", + "ORACLE_FORMAT": "GA", + "ORC": "GA", + "PARQUET": "GA", + "POSTGRESQL_FORMAT": "GA", + "REDSHIFT_FORMAT": "GA", + "SALESFORCE_DATA_CLOUD_FORMAT": "GA", + "SALESFORCE_FORMAT": "GA", + "SNOWFLAKE_FORMAT": "GA", + "SQLDW_FORMAT": "GA", + "SQLSERVER_FORMAT": "GA", + "TERADATA_FORMAT": "GA", + "TEXT": "GA", + "UNITY_CATALOG": "GA", + "VECTOR_INDEX_FORMAT": "GA", + "WORKDAY_RAAS_FORMAT": "GA" + } + }, + "catalog.DatabricksGcpServiceAccount": { + "description": "GCP long-lived credential.\nDatabricks-created Google Cloud Storage service account.", + "fields": { + "credential_id": { + "description": "The Databricks internal ID that represents this managed identity.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "email": { + "description": "The email of the service account.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "private_key_id": { + "description": "The ID that represents the private key for this Service Account", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.DatabricksGcpServiceAccountRequest": { + "description": "GCP long-lived credential.\nDatabricks-created Google Cloud Storage service account." + }, + "catalog.DatabricksGcpServiceAccountResponse": { + "description": "GCP long-lived credential.\nDatabricks-created Google Cloud Storage service account.", + "fields": { + "credential_id": { + "description": "The Databricks internal ID that represents this managed identity.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "email": { + "description": "The email of the service account.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.DeleteCredentialResponse": {}, + "catalog.DeleteMonitorResponse": {}, + "catalog.DeletePolicyResponse": {}, + "catalog.DeleteRequestExternalLineage": { + "fields": { + "id": { + "description": "Unique identifier of the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source": { + "description": "Source object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target": { + "description": "Target object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.DeleteResponse": {}, + "catalog.DeleteTableConstraintResponse": {}, + "catalog.DeltaRuntimePropertiesKVPairs": { + "description": "Properties pertaining to the current state of the delta table as given by the commit server.\nThis does not contain **delta.*** (input) properties in __TableInfo.properties__.", + "fields": { + "delta_runtime_properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + } + } + }, + "catalog.DeltaSharingScopeEnum": { + "enum": [ + "INTERNAL", + "INTERNAL_AND_EXTERNAL" + ], + "enum_launch_stages": { + "INTERNAL": "GA", + "INTERNAL_AND_EXTERNAL": "GA" + } + }, + "catalog.Dependency": { + "description": "A dependency of a SQL object. One of the following fields must be defined:\n__table__, __function__, __connection__, __credential__, __volume__, or __secret__.", + "fields": { + "connection": { + "ref": "catalog.ConnectionDependency", + "launch_stage": "GA" + }, + "credential": { + "ref": "catalog.CredentialDependency", + "launch_stage": "GA" + }, + "function": { + "ref": "catalog.FunctionDependency", + "launch_stage": "GA" + }, + "table": { + "ref": "catalog.TableDependency", + "launch_stage": "GA" + } + } + }, + "catalog.DependencyList": { + "description": "A list of dependencies.", + "fields": { + "dependencies": { + "description": "Array of dependencies.", + "launch_stage": "GA" + } + } + }, + "catalog.DestinationType": { + "enum": [ + "EMAIL", + "SLACK", + "GENERIC_WEBHOOK", + "MICROSOFT_TEAMS", + "URL" + ], + "enum_launch_stages": { + "EMAIL": "PUBLIC_PREVIEW", + "GENERIC_WEBHOOK": "PUBLIC_PREVIEW", + "MICROSOFT_TEAMS": "PUBLIC_PREVIEW", + "SLACK": "PUBLIC_PREVIEW", + "URL": "PUBLIC_PREVIEW" + } + }, + "catalog.DisableResponse": {}, + "catalog.EffectivePermissionsList": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "privilege_assignments": { + "description": "The privileges conveyed to each principal (either directly or via inheritance)", + "launch_stage": "GA" + } + } + }, + "catalog.EffectivePredictiveOptimizationFlag": { + "fields": { + "inherited_from_name": { + "description": "The name of the object from which the flag was inherited. If there was no inheritance, this field is left blank.", + "launch_stage": "GA" + }, + "inherited_from_type": { + "description": "The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank.", + "ref": "catalog.EffectivePredictiveOptimizationFlagInheritedFromType", + "launch_stage": "GA" + }, + "value": { + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + } + } + }, + "catalog.EffectivePredictiveOptimizationFlagInheritedFromType": { + "enum": [ + "CATALOG", + "SCHEMA" + ], + "enum_launch_stages": { + "CATALOG": "GA", + "SCHEMA": "GA" + } + }, + "catalog.EffectivePrivilege": { + "fields": { + "inherited_from_name": { + "description": "The full name of the object that conveys this privilege via inheritance.\nThis field is omitted when privilege is not inherited (it's assigned to the securable itself).", + "launch_stage": "GA" + }, + "inherited_from_type": { + "description": "The type of the object that conveys this privilege via inheritance.\nThis field is omitted when privilege is not inherited (it's assigned to the securable itself).", + "ref": "catalog.SecurableType", + "launch_stage": "GA" + }, + "privilege": { + "description": "The privilege assigned to the principal.", + "ref": "catalog.Privilege", + "launch_stage": "GA" + } + } + }, + "catalog.EffectivePrivilegeAssignment": { + "fields": { + "principal": { + "description": "The principal (user email address or group name).", + "launch_stage": "GA" + }, + "privileges": { + "description": "The privileges conveyed to the principal (either directly or via inheritance).", + "launch_stage": "GA" + } + } + }, + "catalog.EnablePredictiveOptimization": { + "enum": [ + "DISABLE", + "ENABLE", + "INHERIT" + ], + "enum_launch_stages": { + "DISABLE": "GA", + "ENABLE": "GA", + "INHERIT": "GA" + } + }, + "catalog.EnableResponse": {}, + "catalog.EncryptionDetails": { + "description": "Encryption options that apply to clients connecting to cloud storage.", + "fields": { + "sse_encryption_details": { + "description": "Server-Side Encryption properties for clients communicating with AWS s3.", + "ref": "catalog.SseEncryptionDetails", + "launch_stage": "GA" + } + } + }, + "catalog.EncryptionSettings": { + "description": "Encryption Settings are used to carry metadata for securable encryption at rest.\nCurrently used for catalogs, we can use the information supplied here to interact with a CMK.", + "fields": { + "azure_encryption_settings": { + "description": "optional Azure settings - only required if an Azure CMK is used.", + "ref": "catalog.AzureEncryptionSettings", + "launch_stage": "GA" + }, + "azure_key_vault_key_id": { + "description": "the AKV URL in Azure, null otherwise.", + "launch_stage": "GA" + }, + "customer_managed_key_id": { + "description": "the CMK uuid in AWS and GCP, null otherwise.", + "launch_stage": "GA" + } + } + }, + "catalog.EntityTagAssignment": { + "description": "Represents a tag assignment to an entity", + "fields": { + "entity_name": { + "description": "The fully qualified name of the entity to which the tag is assigned", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "entity_type": { + "description": "The type of the entity to which the tag is assigned.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "source_type": { + "description": "The source type of the tag assignment, e.g., user-assigned or system-assigned", + "ref": "catalog.TagAssignmentSourceType", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tag_key": { + "description": "The key of the tag", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "tag_value": { + "description": "The value of the tag", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "The timestamp when the tag assignment was last updated", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "The user or principal who updated the tag assignment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.ExternalLineageExternalMetadata": { + "fields": { + "name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageExternalMetadataInfo": { + "description": "Represents the external metadata object in the lineage event.", + "fields": { + "entity_type": { + "description": "Type of entity represented by the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_time": { + "description": "Timestamp of the lineage event.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "system_type": { + "description": "Type of external system.", + "ref": "catalog.SystemType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageFileInfo": { + "description": "Represents the path information in the lineage event.", + "fields": { + "event_time": { + "description": "Timestamp of the lineage event.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "path": { + "description": "URL of the path.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "securable_name": { + "description": "The full name of the securable on the path.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "securable_type": { + "description": "The securable type of the securable on the path.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "storage_location": { + "description": "The storage location associated with securable on the path.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageInfo": { + "description": "Lineage response containing lineage information of a data asset.", + "fields": { + "external_lineage_info": { + "description": "Information about the edge metadata of the external lineage relationship.", + "ref": "catalog.ExternalLineageRelationshipInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "external_metadata_info": { + "description": "Information about external metadata involved in the lineage relationship.", + "ref": "catalog.ExternalLineageExternalMetadataInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "file_info": { + "description": "Information about the file involved in the lineage relationship.", + "ref": "catalog.ExternalLineageFileInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "model_info": { + "description": "Information about the model version involved in the lineage relationship.", + "ref": "catalog.ExternalLineageModelVersionInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "table_info": { + "description": "Information about the table involved in the lineage relationship.", + "ref": "catalog.ExternalLineageTableInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageModelVersion": { + "fields": { + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "version": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageModelVersionInfo": { + "description": "Represents the model version information in the lineage event.", + "fields": { + "event_time": { + "description": "Timestamp of the lineage event.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "model_name": { + "description": "Name of the model.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "version": { + "description": "Version number of the model.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageObject": { + "fields": { + "external_metadata": { + "ref": "catalog.ExternalLineageExternalMetadata", + "launch_stage": "PUBLIC_PREVIEW" + }, + "model_version": { + "ref": "catalog.ExternalLineageModelVersion", + "launch_stage": "PUBLIC_PREVIEW" + }, + "path": { + "ref": "catalog.ExternalLineagePath", + "launch_stage": "PUBLIC_PREVIEW" + }, + "table": { + "ref": "catalog.ExternalLineageTable", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineagePath": { + "fields": { + "url": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageRelationship": { + "fields": { + "columns": { + "description": "List of column relationships between source and target objects.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "description": "Unique identifier of the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "properties": { + "description": "Key-value properties associated with the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source": { + "description": "Source object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target": { + "description": "Target object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.ExternalLineageRelationshipInfo": { + "fields": { + "columns": { + "description": "List of column relationships between source and target objects.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "description": "Unique identifier of the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "properties": { + "description": "Key-value properties associated with the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source": { + "description": "Source object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target": { + "description": "Target object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.ExternalLineageTable": { + "fields": { + "name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLineageTableInfo": { + "description": "Represents the table information in the lineage event.", + "fields": { + "catalog_name": { + "description": "Name of Catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_time": { + "description": "Timestamp of the lineage event.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of Table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema_name": { + "description": "Name of Schema.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ExternalLocationInfo": { + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this external location was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of external location creator.", + "launch_stage": "GA" + }, + "credential_id": { + "description": "Unique ID of the location's storage credential.", + "launch_stage": "GA" + }, + "credential_name": { + "description": "Name of the storage credential used with this location.", + "launch_stage": "GA" + }, + "effective_enable_file_events": { + "description": "The effective value of `enable_file_events` after applying server-side defaults.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_file_event_queue": { + "description": "The effective file event queue configuration after applying server-side defaults.\nAlways populated when a queue is provisioned, regardless of whether the user explicitly\nset `enable_file_events`. Use this field instead of `file_event_queue` for reading\nthe actual queue state.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "enable_file_events": { + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", + "launch_stage": "GA" + }, + "encryption_details": { + "ref": "catalog.EncryptionDetails", + "launch_stage": "GA" + }, + "fallback": { + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", + "launch_stage": "GA" + }, + "file_event_queue": { + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA" + }, + "isolation_mode": { + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of metastore hosting the external location.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the external location.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the external location.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Indicates whether the external location is read-only.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which external location this was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the external location.", + "launch_stage": "GA" + }, + "url": { + "description": "Path URL of the external location.", + "launch_stage": "GA" + } + } + }, + "catalog.ExternalMetadata": { + "fields": { + "columns": { + "description": "List of columns associated with the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "create_time": { + "description": "Time at which this external metadata object was created.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of external metadata object creator.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "User-provided free-form text description.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "entity_type": { + "description": "Type of entity within the external system.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "id": { + "description": "Unique identifier of the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Name of the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "owner": { + "description": "Owner of the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "properties": { + "description": "A map of key-value properties attached to the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "system_type": { + "description": "Type of external system.", + "ref": "catalog.SystemType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "update_time": { + "description": "Time at which this external metadata object was last modified.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of user who last modified external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "url": { + "description": "URL associated with the external metadata object.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.FailedStatus": { + "description": "Detailed status of an online table. Shown if the online table is in the OFFLINE_FAILED or the\nONLINE_PIPELINE_FAILED state.", + "fields": { + "last_processed_commit_version": { + "description": "The last source table Delta version that was synced to the online table. Note that this Delta\nversion may only be partially synced to the online table. Only populated if the table is still\nonline and available for serving.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "timestamp": { + "description": "The timestamp of the last time any data was synchronized from the source table to the online\ntable. Only populated if the table is still online and available for serving.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.FileEventQueue": { + "fields": { + "managed_aqs": { + "ref": "catalog.AzureQueueStorage", + "launch_stage": "GA" + }, + "managed_pubsub": { + "ref": "catalog.GcpPubsub", + "launch_stage": "GA" + }, + "managed_sqs": { + "ref": "catalog.AwsSqsQueue", + "launch_stage": "GA" + }, + "provided_aqs": { + "ref": "catalog.AzureQueueStorage", + "launch_stage": "GA" + }, + "provided_pubsub": { + "ref": "catalog.GcpPubsub", + "launch_stage": "GA" + }, + "provided_sqs": { + "ref": "catalog.AwsSqsQueue", + "launch_stage": "GA" + } + } + }, + "catalog.ForeignKeyConstraint": { + "fields": { + "child_columns": { + "description": "Column names for this constraint.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the constraint.", + "launch_stage": "GA" + }, + "parent_columns": { + "description": "Column names for this constraint.", + "launch_stage": "GA" + }, + "parent_table": { + "description": "The full name of the parent constraint.", + "launch_stage": "GA" + }, + "rely": { + "description": "True if the constraint is RELY, false or unset if NORELY.", + "launch_stage": "GA" + } + } + }, + "catalog.FunctionArgument": { + "fields": { + "alias": { + "description": "The alias of a matched column.", + "launch_stage": "GA" + }, + "constant": { + "description": "A constant literal.", + "launch_stage": "GA" + } + } + }, + "catalog.FunctionDependency": { + "description": "A function that is dependent on a SQL object.", + "fields": { + "function_full_name": { + "description": "Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__.", + "launch_stage": "GA" + } + } + }, + "catalog.FunctionInfo": { + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "Name of parent Catalog.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this function was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of function creator.", + "launch_stage": "GA" + }, + "data_type": { + "description": "Scalar function return data type.", + "ref": "catalog.ColumnTypeName", + "launch_stage": "GA" + }, + "external_language": { + "description": "External function language.", + "launch_stage": "GA" + }, + "external_name": { + "description": "External function name.", + "launch_stage": "GA" + }, + "full_data_type": { + "description": "Pretty printed function data type.", + "launch_stage": "GA" + }, + "full_name": { + "description": "Full name of Function, in form of **catalog_name**.**schema_name**.**function_name**", + "launch_stage": "GA" + }, + "function_id": { + "description": "Id of Function, relative to parent schema.", + "launch_stage": "GA" + }, + "input_params": { + "description": "Function input parameters.", + "ref": "catalog.FunctionParameterInfos", + "launch_stage": "GA" + }, + "is_deterministic": { + "description": "Whether the function is deterministic.", + "launch_stage": "GA" + }, + "is_null_call": { + "description": "Function null call.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of function, relative to parent schema.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of the function.", + "launch_stage": "GA" + }, + "parameter_style": { + "description": "Function parameter style. **S** is the value for SQL.", + "ref": "catalog.FunctionInfoParameterStyle", + "launch_stage": "GA" + }, + "properties": { + "description": "JSON-serialized key-value pair map, encoded (escaped) as a string.", + "launch_stage": "GA" + }, + "return_params": { + "description": "Table function return parameters.", + "ref": "catalog.FunctionParameterInfos", + "launch_stage": "GA" + }, + "routine_body": { + "description": "Function language. When **EXTERNAL** is used, the language of the routine function should be specified in the **external_language** field, and the **return_params** of the function cannot be used (as **TABLE** return type is not supported), and the **sql_data_access** field must be **NO_SQL**.", + "ref": "catalog.FunctionInfoRoutineBody", + "launch_stage": "GA" + }, + "routine_definition": { + "description": "Function body.", + "launch_stage": "GA" + }, + "routine_dependencies": { + "description": "function dependencies.", + "ref": "catalog.DependencyList", + "launch_stage": "GA" + }, + "schema_name": { + "description": "Name of parent Schema relative to its parent Catalog.", + "launch_stage": "GA" + }, + "security_type": { + "description": "Function security type.", + "ref": "catalog.FunctionInfoSecurityType", + "launch_stage": "GA" + }, + "specific_name": { + "description": "Specific name of the function; Reserved for future use.", + "launch_stage": "GA" + }, + "sql_data_access": { + "description": "Function SQL data access.", + "ref": "catalog.FunctionInfoSqlDataAccess", + "launch_stage": "GA" + }, + "sql_path": { + "description": "List of schemes whose objects can be referenced without qualification.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this function was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the function.", + "launch_stage": "GA" + } + } + }, + "catalog.FunctionInfoParameterStyle": { + "enum": [ + "S" + ], + "enum_launch_stages": { + "S": "GA" + } + }, + "catalog.FunctionInfoRoutineBody": { + "enum": [ + "SQL", + "EXTERNAL" + ], + "enum_launch_stages": { + "EXTERNAL": "GA", + "SQL": "GA" + } + }, + "catalog.FunctionInfoSecurityType": { + "enum": [ + "DEFINER" + ], + "enum_launch_stages": { + "DEFINER": "GA" + } + }, + "catalog.FunctionInfoSqlDataAccess": { + "enum": [ + "CONTAINS_SQL", + "READS_SQL_DATA", + "NO_SQL" + ], + "enum_launch_stages": { + "CONTAINS_SQL": "GA", + "NO_SQL": "GA", + "READS_SQL_DATA": "GA" + } + }, + "catalog.FunctionParameterInfo": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of Parameter.", + "launch_stage": "GA" + }, + "parameter_default": { + "description": "Default value of the parameter.", + "launch_stage": "GA" + }, + "parameter_mode": { + "description": "Function parameter mode.", + "ref": "catalog.FunctionParameterMode", + "launch_stage": "GA" + }, + "parameter_type": { + "description": "Function parameter type.", + "ref": "catalog.FunctionParameterType", + "launch_stage": "GA" + }, + "position": { + "description": "Ordinal position of column (starting at position 0).", + "launch_stage": "GA" + }, + "type_interval_type": { + "description": "Format of IntervalType.", + "launch_stage": "GA" + }, + "type_json": { + "description": "Full data type spec, JSON-serialized.", + "launch_stage": "GA" + }, + "type_name": { + "description": "Name of type (INT, STRUCT, MAP, etc.)", + "ref": "catalog.ColumnTypeName", + "launch_stage": "GA" + }, + "type_precision": { + "description": "Digits of precision; required on Create for DecimalTypes.", + "launch_stage": "GA" + }, + "type_scale": { + "description": "Digits to right of decimal; Required on Create for DecimalTypes.", + "launch_stage": "GA" + }, + "type_text": { + "description": "Full data type spec, SQL/catalogString text.", + "launch_stage": "GA" + } + } + }, + "catalog.FunctionParameterInfos": { + "fields": { + "parameters": { + "launch_stage": "GA" + } + } + }, + "catalog.FunctionParameterMode": { + "enum": [ + "IN" + ], + "enum_launch_stages": { + "IN": "GA" + } + }, + "catalog.FunctionParameterType": { + "enum": [ + "PARAM", + "COLUMN" + ], + "enum_launch_stages": { + "COLUMN": "GA", + "PARAM": "GA" + } + }, + "catalog.GcpOauthToken": { + "description": "GCP temporary credentials for API authentication.\nRead more at https://developers.google.com/identity/protocols/oauth2/service-account", + "fields": { + "oauth_token": { + "launch_stage": "GA" + } + } + }, + "catalog.GcpPubsub": { + "fields": { + "managed_resource_id": { + "description": "Unique identifier included in the name of file events managed cloud resources.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "subscription_name": { + "description": "The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.\nOnly required for provided_pubsub.", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryPathCredentialRequest": { + "fields": { + "dry_run": { + "description": "Optional. When set to true, the service will not validate that the generated\ncredentials can perform write operations, therefore no new paths will be created\nand the response will not contain valid credentials. Defaults to false.", + "launch_stage": "GA" + }, + "operation": { + "description": "The operation being performed on the path.", + "ref": "catalog.PathOperation", + "launch_stage": "GA" + }, + "url": { + "description": "URL for path-based access.", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryPathCredentialResponse": { + "fields": { + "aws_temp_credentials": { + "ref": "catalog.AwsCredentials", + "launch_stage": "GA" + }, + "azure_aad": { + "ref": "catalog.AzureActiveDirectoryToken", + "launch_stage": "GA" + }, + "azure_user_delegation_sas": { + "ref": "catalog.AzureUserDelegationSAS", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Server time when the credential will expire, in epoch milliseconds.\nThe API client is advised to cache the credential given this expiration time.", + "launch_stage": "GA" + }, + "gcp_oauth_token": { + "ref": "catalog.GcpOauthToken", + "launch_stage": "GA" + }, + "r2_temp_credentials": { + "ref": "catalog.R2Credentials", + "launch_stage": "GA" + }, + "url": { + "description": "The URL of the storage path accessible by the temporary credential.", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryServiceCredentialAzureOptions": { + "description": "The Azure cloud options to customize the requested temporary credential", + "fields": { + "resources": { + "description": "The resources to which the temporary Azure credential should apply. These resources\nare the scopes that are passed to the token provider (see https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python)", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryServiceCredentialGcpOptions": { + "description": "The GCP cloud options to customize the requested temporary credential", + "fields": { + "scopes": { + "description": "The scopes to which the temporary GCP credential should apply. These resources\nare the scopes that are passed to the token provider (see\nhttps://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials)", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryServiceCredentialRequest": { + "fields": { + "azure_options": { + "ref": "catalog.GenerateTemporaryServiceCredentialAzureOptions", + "launch_stage": "GA" + }, + "credential_name": { + "description": "The name of the service credential used to generate a temporary credential", + "launch_stage": "GA" + }, + "gcp_options": { + "ref": "catalog.GenerateTemporaryServiceCredentialGcpOptions", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryTableCredentialRequest": { + "fields": { + "operation": { + "description": "The operation performed against the table data, either READ or READ_WRITE. If READ_WRITE is specified,\nthe credentials returned will have write permissions, otherwise, it will be read only.", + "ref": "catalog.TableOperation", + "launch_stage": "GA" + }, + "table_id": { + "description": "UUID of the table to read or write.", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryTableCredentialResponse": { + "fields": { + "aws_temp_credentials": { + "ref": "catalog.AwsCredentials", + "launch_stage": "GA" + }, + "azure_aad": { + "ref": "catalog.AzureActiveDirectoryToken", + "launch_stage": "GA" + }, + "azure_user_delegation_sas": { + "ref": "catalog.AzureUserDelegationSAS", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Server time when the credential will expire, in epoch milliseconds.\nThe API client is advised to cache the credential given this expiration time.", + "launch_stage": "GA" + }, + "gcp_oauth_token": { + "ref": "catalog.GcpOauthToken", + "launch_stage": "GA" + }, + "r2_temp_credentials": { + "ref": "catalog.R2Credentials", + "launch_stage": "GA" + }, + "url": { + "description": "The URL of the storage path accessible by the temporary credential.", + "launch_stage": "GA" + } + } + }, + "catalog.GenerateTemporaryVolumeCredentialRequest": { + "description": "Generate volume credentials RPC", + "fields": { + "operation": { + "description": "The operation performed against the volume data, either READ_VOLUME or WRITE_VOLUME. If WRITE_VOLUME is specified,\nthe credentials returned will have write permissions, otherwise, it will be read only.", + "ref": "catalog.VolumeOperation", + "launch_stage": "PUBLIC_PREVIEW" + }, + "volume_id": { + "description": "Id of the volume to read or write.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.GenerateTemporaryVolumeCredentialResponse": { + "fields": { + "aws_temp_credentials": { + "ref": "catalog.AwsCredentials", + "launch_stage": "PUBLIC_PREVIEW" + }, + "azure_aad": { + "ref": "catalog.AzureActiveDirectoryToken", + "launch_stage": "PUBLIC_PREVIEW" + }, + "azure_user_delegation_sas": { + "ref": "catalog.AzureUserDelegationSAS", + "launch_stage": "PUBLIC_PREVIEW" + }, + "expiration_time": { + "description": "Server time when the credential will expire, in epoch milliseconds.\nThe API client is advised to cache the credential given this expiration time.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "gcp_oauth_token": { + "ref": "catalog.GcpOauthToken", + "launch_stage": "PUBLIC_PREVIEW" + }, + "r2_temp_credentials": { + "ref": "catalog.R2Credentials", + "launch_stage": "PUBLIC_PREVIEW" + }, + "url": { + "description": "The URL of the storage path accessible by the temporary credential.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.GetCatalogWorkspaceBindingsResponse": { + "fields": { + "workspaces": { + "description": "A list of workspace IDs", + "launch_stage": "GA" + } + } + }, + "catalog.GetMetastoreSummaryResponse": { + "fields": { + "cloud": { + "description": "Cloud vendor of the metastore home shard (e.g., `aws`, `azure`, `gcp`).", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this metastore was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of metastore creator.", + "launch_stage": "GA" + }, + "default_data_access_config_id": { + "description": "Unique identifier of the metastore's (Default) Data Access Configuration.", + "deprecated": true, + "launch_stage": "GA" + }, + "delta_sharing_organization_name": { + "description": "The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.", + "launch_stage": "GA" + }, + "delta_sharing_recipient_token_lifetime_in_seconds": { + "description": "The lifetime of delta sharing recipient token in seconds.", + "launch_stage": "GA" + }, + "delta_sharing_scope": { + "description": "The scope of Delta Sharing enabled for the metastore.", + "ref": "catalog.DeltaSharingScopeEnum", + "launch_stage": "GA" + }, + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "global_metastore_id": { + "description": "Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The user-specified name of the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the metastore.", + "launch_stage": "GA" + }, + "privilege_model_version": { + "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).", + "launch_stage": "GA" + }, + "storage_root": { + "description": "The storage root URL for metastore", + "launch_stage": "GA" + }, + "storage_root_credential_id": { + "description": "UUID of storage credential to access the metastore storage_root.", + "launch_stage": "GA" + }, + "storage_root_credential_name": { + "description": "Name of the storage credential to access the metastore storage_root.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which the metastore was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the metastore.", + "launch_stage": "GA" + } + } + }, + "catalog.GetPermissionsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "privilege_assignments": { + "description": "The privileges assigned to each principal", + "launch_stage": "GA" + } + } + }, + "catalog.GetQuotaResponse": { + "fields": { + "quota_info": { + "description": "The returned QuotaInfo.", + "ref": "catalog.QuotaInfo", + "launch_stage": "GA" + } + } + }, + "catalog.GetWorkspaceBindingsResponse": { + "fields": { + "bindings": { + "description": "List of workspace bindings", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.IsolationMode": { + "enum": [ + "ISOLATION_MODE_OPEN", + "ISOLATION_MODE_ISOLATED" + ], + "enum_launch_stages": { + "ISOLATION_MODE_ISOLATED": "GA", + "ISOLATION_MODE_OPEN": "GA" + } + }, + "catalog.LineageDirection": { + "enum": [ + "UPSTREAM", + "DOWNSTREAM" + ], + "enum_launch_stages": { + "DOWNSTREAM": "PUBLIC_PREVIEW", + "UPSTREAM": "PUBLIC_PREVIEW" + } + }, + "catalog.ListAccountMetastoreAssignmentsResponse": { + "description": "The metastore assignments were successfully returned.", + "fields": { + "workspace_ids": { + "launch_stage": "GA" + } + } + }, + "catalog.ListAccountStorageCredentialsResponse": { + "description": "The metastore storage credentials were successfully returned.", + "fields": { + "storage_credentials": { + "description": "An array of metastore storage credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.ListCatalogsResponse": { + "fields": { + "catalogs": { + "description": "An array of catalog information objects.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListConnectionsResponse": { + "fields": { + "connections": { + "description": "An array of connection information objects.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListCredentialsResponse": { + "fields": { + "credentials": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no\nmore pages.\n__page_token__ should be set to this value for the next request (for the\nnext page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListEntityTagAssignmentsResponse": { + "fields": { + "next_page_token": { + "description": "Optional. Pagination token for retrieving the next page of results", + "launch_stage": "GA" + }, + "tag_assignments": { + "description": "The list of tag assignments", + "launch_stage": "GA" + } + } + }, + "catalog.ListExternalLineageRelationshipsResponse": { + "fields": { + "external_lineage_relationships": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ListExternalLocationsResponse": { + "fields": { + "external_locations": { + "description": "An array of external locations.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListExternalMetadataResponse": { + "fields": { + "external_metadata": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ListFunctionsResponse": { + "fields": { + "functions": { + "description": "An array of function information objects.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListMetastoresResponse": { + "fields": { + "metastores": { + "description": "An array of metastore information objects.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListModelVersionsResponse": { + "fields": { + "model_versions": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "catalog.ListPoliciesResponse": { + "fields": { + "next_page_token": { + "description": "Optional opaque token for continuing pagination. `page_token` should be set to this value for\nthe next request to retrieve the next page of results.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "policies": { + "description": "The list of retrieved policies.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.ListQuotasResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request.", + "launch_stage": "GA" + }, + "quotas": { + "description": "An array of returned QuotaInfos.", + "launch_stage": "GA" + } + } + }, + "catalog.ListRegisteredModelsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token for pagination. Omitted if there are no more results. page_token should\nbe set to this value for fetching the next page.", + "launch_stage": "GA" + }, + "registered_models": { + "launch_stage": "GA" + } + } + }, + "catalog.ListSchemasResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "schemas": { + "description": "An array of schema information objects.", + "launch_stage": "GA" + } + } + }, + "catalog.ListSecretsResponse": { + "description": "Response message for ListSecrets.", + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n**page_token** should be set to this value for the next request.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "secrets": { + "description": "An array of secret objects.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.ListStorageCredentialsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no\nmore pages.\n__page_token__ should be set to this value for the next request (for the\nnext page of results).", + "launch_stage": "GA" + }, + "storage_credentials": { + "launch_stage": "GA" + } + } + }, + "catalog.ListSystemSchemasResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "An array of system schema information objects.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.ListTableSummariesResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "tables": { + "description": "List of table summaries.", + "launch_stage": "GA" + } + } + }, + "catalog.ListTablesResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "tables": { + "description": "An array of table information objects.", + "launch_stage": "GA" + } + } + }, + "catalog.ListVolumesResponseContent": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request to retrieve the next page of results.", + "launch_stage": "GA" + }, + "volumes": { + "launch_stage": "GA" + } + } + }, + "catalog.MatchColumn": { + "fields": { + "alias": { + "description": "Optional alias of the matched column.", + "launch_stage": "GA" + }, + "condition": { + "description": "The condition expression used to match a table column.", + "launch_stage": "GA" + } + } + }, + "catalog.MatchType": { + "description": "The artifact pattern matching type", + "enum": [ + "PREFIX_MATCH" + ], + "enum_launch_stages": { + "PREFIX_MATCH": "GA" + } + }, + "catalog.MetastoreAssignment": { + "fields": { + "default_catalog_name": { + "description": "The name of the default catalog in the metastore. This field is deprecated.\nPlease use \"Default Namespace API\" to configure the default catalog for a Databricks workspace.", + "deprecated": true, + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique ID of the metastore.", + "launch_stage": "GA" + }, + "workspace_id": { + "description": "The unique ID of the Databricks workspace.", + "launch_stage": "GA" + } + } + }, + "catalog.MetastoreInfo": { + "fields": { + "cloud": { + "description": "Cloud vendor of the metastore home shard (e.g., `aws`, `azure`, `gcp`).", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this metastore was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of metastore creator.", + "launch_stage": "GA" + }, + "default_data_access_config_id": { + "description": "Unique identifier of the metastore's (Default) Data Access Configuration.", + "deprecated": true, + "launch_stage": "GA" + }, + "delta_sharing_organization_name": { + "description": "The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.", + "launch_stage": "GA" + }, + "delta_sharing_recipient_token_lifetime_in_seconds": { + "description": "The lifetime of delta sharing recipient token in seconds.", + "launch_stage": "GA" + }, + "delta_sharing_scope": { + "description": "The scope of Delta Sharing enabled for the metastore.", + "ref": "catalog.DeltaSharingScopeEnum", + "launch_stage": "GA" + }, + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "global_metastore_id": { + "description": "Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The user-specified name of the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the metastore.", + "launch_stage": "GA" + }, + "privilege_model_version": { + "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).", + "launch_stage": "GA" + }, + "storage_root": { + "description": "The storage root URL for metastore", + "launch_stage": "GA" + }, + "storage_root_credential_id": { + "description": "UUID of storage credential to access the metastore storage_root.", + "launch_stage": "GA" + }, + "storage_root_credential_name": { + "description": "Name of the storage credential to access the metastore storage_root.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which the metastore was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the metastore.", + "launch_stage": "GA" + } + } + }, + "catalog.ModelVersionInfo": { + "fields": { + "aliases": { + "description": "List of aliases associated with the model version", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog containing the model version", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the model version", + "launch_stage": "GA" + }, + "created_at": { + "launch_stage": "GA" + }, + "created_by": { + "description": "The identifier of the user who created the model version", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the model version", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique identifier of the metastore containing the model version", + "launch_stage": "GA" + }, + "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", + "launch_stage": "GA" + }, + "model_version_dependencies": { + "description": "Model version dependencies, for feature-store packaged models", + "ref": "catalog.DependencyList", + "launch_stage": "GA" + }, + "run_id": { + "description": "MLflow run ID used when creating the model version, if ``source`` was generated by an\nexperiment run stored in an MLflow tracking server", + "launch_stage": "GA" + }, + "run_workspace_id": { + "description": "ID of the Databricks workspace containing the MLflow run that generated this model\nversion, if applicable", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", + "launch_stage": "GA" + }, + "source": { + "description": "URI indicating the location of the source artifacts (files) for the model version", + "launch_stage": "GA" + }, + "status": { + "description": "Current status of the model version. Newly created model versions start in\nPENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and\nthe model version is finalized. Only model versions in READY status can be loaded for inference or\nserved.", + "ref": "catalog.ModelVersionInfoStatus", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud under which model version data files are stored", + "launch_stage": "GA" + }, + "updated_at": { + "launch_stage": "GA" + }, + "updated_by": { + "description": "The identifier of the user who updated the model version last time", + "launch_stage": "GA" + }, + "version": { + "description": "Integer model version number, used to reference the model version in API requests.", + "launch_stage": "GA" + } + } + }, + "catalog.ModelVersionInfoStatus": { + "enum": [ + "MODEL_VERSION_STATUS_UNKNOWN", + "PENDING_REGISTRATION", + "FAILED_REGISTRATION", + "READY" + ], + "enum_launch_stages": { + "FAILED_REGISTRATION": "GA", + "MODEL_VERSION_STATUS_UNKNOWN": "GA", + "PENDING_REGISTRATION": "GA", + "READY": "GA" + } + }, + "catalog.MonitorCronSchedule": { + "fields": { + "pause_status": { + "description": "Read only field that indicates whether a schedule is paused or not.", + "ref": "catalog.MonitorCronSchedulePauseStatus", + "launch_stage": "GA" + }, + "quartz_cron_expression": { + "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "timezone_id": { + "description": "The timezone id (e.g., ``PST``) in which to evaluate the quartz expression.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.MonitorCronSchedulePauseStatus": { + "description": "Source link: https://src.dev.databricks.com/databricks/universe/-/blob/elastic-spark-common/api/messages/schedule.proto\nMonitoring workflow schedule pause status.", + "enum": [ + "UNSPECIFIED", + "UNPAUSED", + "PAUSED" + ], + "enum_launch_stages": { + "PAUSED": "GA", + "UNPAUSED": "GA", + "UNSPECIFIED": "GA" + } + }, + "catalog.MonitorDataClassificationConfig": { + "description": "Data classification related configuration.", + "fields": { + "enabled": { + "description": "Whether to enable data classification.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.MonitorDestination": { + "fields": { + "email_addresses": { + "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.", + "launch_stage": "GA" + } + } + }, + "catalog.MonitorInferenceLog": { + "fields": { + "granularities": { + "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "label_col": { + "description": "Column for the label.", + "launch_stage": "GA" + }, + "model_id_col": { + "description": "Column for the model identifier.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "prediction_col": { + "description": "Column for the prediction.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "prediction_proba_col": { + "description": "Column for prediction probabilities", + "launch_stage": "GA" + }, + "problem_type": { + "description": "Problem type the model aims to solve.", + "ref": "catalog.MonitorInferenceLogProblemType", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "timestamp_col": { + "description": "Column for the timestamp.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.MonitorInferenceLogProblemType": { + "enum": [ + "PROBLEM_TYPE_CLASSIFICATION", + "PROBLEM_TYPE_REGRESSION" + ], + "enum_launch_stages": { + "PROBLEM_TYPE_CLASSIFICATION": "GA", + "PROBLEM_TYPE_REGRESSION": "GA" + } + }, + "catalog.MonitorInfo": { + "fields": { + "assets_dir": { + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "launch_stage": "GA" + }, + "baseline_table_name": { + "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "launch_stage": "GA" + }, + "custom_metrics": { + "description": "[Create:OPT Update:OPT] Custom metrics.", + "launch_stage": "GA" + }, + "dashboard_id": { + "description": "[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state.", + "launch_stage": "GA" + }, + "data_classification_config": { + "description": "[Create:OPT Update:OPT] Data classification related config.", + "ref": "catalog.MonitorDataClassificationConfig", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "drift_metrics_table_name": { + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "launch_stage": "GA" + }, + "inference_log": { + "ref": "catalog.MonitorInferenceLog", + "launch_stage": "GA" + }, + "latest_monitor_failure_msg": { + "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", + "launch_stage": "GA" + }, + "monitor_version": { + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "launch_stage": "GA" + }, + "notifications": { + "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", + "ref": "catalog.MonitorNotifications", + "launch_stage": "GA" + }, + "output_schema_name": { + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "profile_metrics_table_name": { + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "launch_stage": "GA" + }, + "schedule": { + "description": "[Create:OPT Update:OPT] The monitor schedule.", + "ref": "catalog.MonitorCronSchedule", + "launch_stage": "GA" + }, + "slicing_exprs": { + "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "launch_stage": "GA" + }, + "snapshot": { + "description": "Configuration for monitoring snapshot tables.", + "ref": "catalog.MonitorSnapshot", + "launch_stage": "GA" + }, + "status": { + "description": "[Create:ERR Update:IGN] The monitor status.", + "ref": "catalog.MonitorInfoStatus", + "launch_stage": "GA" + }, + "table_name": { + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "launch_stage": "GA" + }, + "time_series": { + "description": "Configuration for monitoring time series tables.", + "ref": "catalog.MonitorTimeSeries", + "launch_stage": "GA" + } + } + }, + "catalog.MonitorInfoStatus": { + "enum": [ + "MONITOR_STATUS_ACTIVE", + "MONITOR_STATUS_PENDING", + "MONITOR_STATUS_DELETE_PENDING", + "MONITOR_STATUS_ERROR", + "MONITOR_STATUS_FAILED" + ], + "enum_launch_stages": { + "MONITOR_STATUS_ACTIVE": "GA", + "MONITOR_STATUS_DELETE_PENDING": "GA", + "MONITOR_STATUS_ERROR": "GA", + "MONITOR_STATUS_FAILED": "GA", + "MONITOR_STATUS_PENDING": "GA" + } + }, + "catalog.MonitorMetric": { + "description": "Custom metric definition.", + "fields": { + "definition": { + "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "input_columns": { + "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "name": { + "description": "Name of the metric in the output tables.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "output_data_type": { + "description": "The output type of the custom metric.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "type": { + "description": "Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or ``\"CUSTOM_METRIC_TYPE_DRIFT\"``.\nThe ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics\nare computed on a single table, whereas the ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics", + "ref": "catalog.MonitorMetricType", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.MonitorMetricType": { + "description": "Can only be one of ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"``, ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"``, or ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"``.\nThe ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"`` and ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"`` metrics\nare computed on a single table, whereas the ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics", + "enum": [ + "CUSTOM_METRIC_TYPE_AGGREGATE", + "CUSTOM_METRIC_TYPE_DERIVED", + "CUSTOM_METRIC_TYPE_DRIFT" + ], + "enum_launch_stages": { + "CUSTOM_METRIC_TYPE_AGGREGATE": "GA", + "CUSTOM_METRIC_TYPE_DERIVED": "GA", + "CUSTOM_METRIC_TYPE_DRIFT": "GA" + } + }, + "catalog.MonitorNotifications": { + "fields": { + "on_failure": { + "description": "Destinations to send notifications on failure/timeout.", + "ref": "catalog.MonitorDestination", + "launch_stage": "GA" + }, + "on_new_classification_tag_detected": { + "description": "Destinations to send notifications on new classification tag detected.", + "ref": "catalog.MonitorDestination", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.MonitorRefreshInfo": { + "fields": { + "end_time_ms": { + "description": "Time at which refresh operation completed (milliseconds since 1/1/1970 UTC).", + "launch_stage": "GA" + }, + "message": { + "description": "An optional message to give insight into the current state of the job (e.g. FAILURE messages).", + "launch_stage": "GA" + }, + "refresh_id": { + "description": "Unique id of the refresh operation.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "start_time_ms": { + "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "state": { + "description": "The current state of the refresh.", + "ref": "catalog.MonitorRefreshInfoState", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "trigger": { + "description": "The method by which the refresh was triggered.", + "ref": "catalog.MonitorRefreshInfoTrigger", + "launch_stage": "GA" + } + } + }, + "catalog.MonitorRefreshInfoState": { + "description": "The current state of the refresh.", + "enum": [ + "UNKNOWN", + "PENDING", + "RUNNING", + "SUCCESS", + "FAILED", + "CANCELED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "FAILED": "GA", + "PENDING": "GA", + "RUNNING": "GA", + "SUCCESS": "GA", + "UNKNOWN": "GA" + } + }, + "catalog.MonitorRefreshInfoTrigger": { + "enum": [ + "UNKNOWN_TRIGGER", + "SCHEDULE", + "MANUAL" + ], + "enum_launch_stages": { + "MANUAL": "GA", + "SCHEDULE": "GA", + "UNKNOWN_TRIGGER": "GA" + } + }, + "catalog.MonitorRefreshListResponse": { + "fields": { + "refreshes": { + "description": "List of refreshes.", + "launch_stage": "GA" + } + } + }, + "catalog.MonitorSnapshot": { + "description": "Snapshot analysis configuration" + }, + "catalog.MonitorTimeSeries": { + "description": "Time series analysis configuration.", + "fields": { + "granularities": { + "description": "Granularities for aggregating data into time windows based on their timestamp. Currently the following static\ngranularities are supported:\n{``\\\"5 minutes\\\"``, ``\\\"30 minutes\\\"``, ``\\\"1 hour\\\"``, ``\\\"1 day\\\"``, ``\\\"\\u003cn\\u003e week(s)\\\"``, ``\\\"1 month\\\"``, ``\\\"1 year\\\"``}.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "timestamp_col": { + "description": "Column for the timestamp.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.NamedTableConstraint": { + "fields": { + "name": { + "description": "The name of the constraint.", + "launch_stage": "GA" + } + } + }, + "catalog.NotificationDestination": { + "fields": { + "destination_id": { + "description": "The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations,\nor the unique Databricks notification destination ID for all other external destinations.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "destination_type": { + "description": "The type of the destination.", + "ref": "catalog.DestinationType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "special_destination": { + "description": "This field is used to denote whether the destination is the email of the owner of the securable object.\nThe special destination cannot be assigned to a securable and only represents the default destination of the securable.\nThe securable types that support default special destinations are: \"catalog\", \"external_location\", \"connection\", \"credential\", and \"metastore\".\nThe **destination_type** of a **special_destination** is always EMAIL.", + "ref": "catalog.SpecialDestination", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.OnlineTable": { + "description": "Online Table information.", + "fields": { + "name": { + "description": "Full three-part (catalog, schema, table) name of the table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "spec": { + "description": "Specification of the online table.", + "ref": "catalog.OnlineTableSpec", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "description": "Online Table data synchronization status", + "ref": "catalog.OnlineTableStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "table_serving_url": { + "description": "Data serving REST API URL for this table", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "unity_catalog_provisioning_state": { + "description": "The provisioning state of the online table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).", + "ref": "catalog.ProvisioningInfoState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.OnlineTableSpec": { + "description": "Specification of an online table.", + "fields": { + "perform_full_copy": { + "description": "Whether to create a full-copy pipeline -- a pipeline that stops after creates a full copy of\nthe source table upon initialization and does not process any change data feeds (CDFs)\nafterwards. The pipeline can still be manually triggered afterwards, but it always perform a\nfull copy of the source table and there are no incremental updates. This mode is useful for\nsyncing views or tables without CDFs to online tables.\nNote that the full-copy pipeline only supports \"triggered\" scheduling policy.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "pipeline_id": { + "description": "ID of the associated pipeline. Generated by the server - cannot be set by the caller.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "primary_key_columns": { + "description": "Primary Key columns to be used for data insert/update in the destination.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "run_continuously": { + "description": "Pipeline runs continuously after generating the initial data.", + "ref": "catalog.OnlineTableSpecContinuousSchedulingPolicy", + "launch_stage": "PUBLIC_PREVIEW" + }, + "run_triggered": { + "description": "Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers)", + "ref": "catalog.OnlineTableSpecTriggeredSchedulingPolicy", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_table_full_name": { + "description": "Three-part (catalog, schema, table) name of the source Delta table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "timeseries_key": { + "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.OnlineTableSpecContinuousSchedulingPolicy": {}, + "catalog.OnlineTableSpecTriggeredSchedulingPolicy": {}, + "catalog.OnlineTableState": { + "description": "The state of an online table.", + "enum": [ + "PROVISIONING", + "PROVISIONING_PIPELINE_RESOURCES", + "PROVISIONING_INITIAL_SNAPSHOT", + "ONLINE", + "ONLINE_CONTINUOUS_UPDATE", + "ONLINE_TRIGGERED_UPDATE", + "ONLINE_NO_PENDING_UPDATE", + "OFFLINE", + "OFFLINE_FAILED", + "ONLINE_PIPELINE_FAILED", + "ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enum_launch_stages": { + "OFFLINE": "PUBLIC_PREVIEW", + "OFFLINE_FAILED": "PUBLIC_PREVIEW", + "ONLINE": "PUBLIC_PREVIEW", + "ONLINE_CONTINUOUS_UPDATE": "PUBLIC_PREVIEW", + "ONLINE_NO_PENDING_UPDATE": "PUBLIC_PREVIEW", + "ONLINE_PIPELINE_FAILED": "PUBLIC_PREVIEW", + "ONLINE_TRIGGERED_UPDATE": "PUBLIC_PREVIEW", + "ONLINE_UPDATING_PIPELINE_RESOURCES": "PUBLIC_PREVIEW", + "PROVISIONING": "PUBLIC_PREVIEW", + "PROVISIONING_INITIAL_SNAPSHOT": "PUBLIC_PREVIEW", + "PROVISIONING_PIPELINE_RESOURCES": "PUBLIC_PREVIEW" + } + }, + "catalog.OnlineTableStatus": { + "description": "Status of an online table.", + "fields": { + "continuous_update_status": { + "ref": "catalog.ContinuousUpdateStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "detailed_state": { + "description": "The state of the online table.", + "ref": "catalog.OnlineTableState", + "launch_stage": "PUBLIC_PREVIEW" + }, + "failed_status": { + "ref": "catalog.FailedStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "message": { + "description": "A text description of the current state of the online table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "provisioning_status": { + "ref": "catalog.ProvisioningStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "triggered_update_status": { + "ref": "catalog.TriggeredUpdateStatus", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.OptionSpec": { + "description": "Spec of an allowed option on a securable kind and its attributes.\nThis is mostly used by UI to provide user friendly hints and descriptions\nin order to facilitate the securable creation process.", + "fields": { + "allowed_values": { + "description": "For drop down / radio button selections, UI will want to know the possible\ninput values, it can also be used by other option types to limit input selections.", + "launch_stage": "GA" + }, + "default_value": { + "description": "The default value of the option, for example, value '443' for 'port' option.", + "launch_stage": "GA" + }, + "description": { + "description": "A concise user facing description of what the input value of this option should look like.", + "launch_stage": "GA" + }, + "hint": { + "description": "The hint is used on the UI to suggest what the input value\ncan possibly be like, for example: example.com for 'host' option.\nUnlike default value, it will not be applied automatically without user input.", + "launch_stage": "GA" + }, + "is_copiable": { + "description": "Indicates whether an option should be displayed with copy button on the UI.", + "launch_stage": "GA" + }, + "is_creatable": { + "description": "Indicates whether an option can be provided by users in the create/update path of an entity.", + "launch_stage": "GA" + }, + "is_hidden": { + "description": "Is the option value not user settable and is thus not shown on the UI.", + "launch_stage": "GA" + }, + "is_loggable": { + "description": "Specifies whether this option is safe to log, i.e. no sensitive information.", + "launch_stage": "GA" + }, + "is_required": { + "description": "Is the option required.", + "launch_stage": "GA" + }, + "is_secret": { + "description": "Is the option value considered secret and thus redacted on the UI.", + "launch_stage": "GA" + }, + "is_updatable": { + "description": "Is the option updatable by users.", + "launch_stage": "GA" + }, + "name": { + "description": "The unique name of the option.", + "launch_stage": "GA" + }, + "oauth_stage": { + "description": "Specifies when the option value is displayed on the UI within the OAuth flow.", + "ref": "catalog.OptionSpecOauthStage", + "launch_stage": "GA" + }, + "type": { + "description": "The type of the option.", + "ref": "catalog.OptionSpecOptionType", + "launch_stage": "GA" + } + } + }, + "catalog.OptionSpecOauthStage": { + "description": "During the OAuth flow, specifies which stage the option should be displayed in the UI.\nOAUTH_STAGE_UNSPECIFIED is the default value for options unrelated to the OAuth flow.\nBEFORE_AUTHORIZATION_CODE corresponds to options necessary to initiate the OAuth process.\nBEFORE_ACCESS_TOKEN corresponds to options that are necessary to create a foreign connection,\nbut that should be displayed after the authorization code has already been received.", + "enum": [ + "BEFORE_AUTHORIZATION_CODE", + "BEFORE_ACCESS_TOKEN" + ], + "enum_launch_stages": { + "BEFORE_ACCESS_TOKEN": "GA", + "BEFORE_AUTHORIZATION_CODE": "GA" + } + }, + "catalog.OptionSpecOptionType": { + "description": "Type of the option, we purposely follow JavaScript types so that\nthe UI can map the options to JS types.\nhttps://www.w3schools.com/js/js_datatypes.asp\nEnum is a special case that it's just string with selections.", + "enum": [ + "OPTION_BOOLEAN", + "OPTION_NUMBER", + "OPTION_BIGINT", + "OPTION_STRING", + "OPTION_ENUM", + "OPTION_SERVICE_CREDENTIAL", + "OPTION_MULTILINE_STRING" + ], + "enum_launch_stages": { + "OPTION_BIGINT": "GA", + "OPTION_BOOLEAN": "GA", + "OPTION_ENUM": "GA", + "OPTION_MULTILINE_STRING": "GA", + "OPTION_NUMBER": "GA", + "OPTION_SERVICE_CREDENTIAL": "GA", + "OPTION_STRING": "GA" + } + }, + "catalog.PathOperation": { + "enum": [ + "PATH_READ", + "PATH_READ_WRITE", + "PATH_CREATE_TABLE" + ], + "enum_launch_stages": { + "PATH_CREATE_TABLE": "GA", + "PATH_READ": "GA", + "PATH_READ_WRITE": "GA" + } + }, + "catalog.PermissionsChange": { + "fields": { + "add": { + "description": "The set of privileges to add.", + "launch_stage": "GA" + }, + "principal": { + "description": "The principal whose privileges we are changing.\nOnly one of principal or principal_id should be specified, never both at the same time.", + "launch_stage": "GA" + }, + "remove": { + "description": "The set of privileges to remove.", + "launch_stage": "GA" + } + } + }, + "catalog.PipelineProgress": { + "description": "Progress information of the Online Table data synchronization pipeline.", + "fields": { + "estimated_completion_time_seconds": { + "description": "The estimated time remaining to complete this update in seconds.", + "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\nhave completely processed this version yet.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sync_progress_completion": { + "description": "The completion ratio of this update. This is a number between 0 and 1.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "synced_row_count": { + "description": "The number of rows that have been synced in this update.", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.PolicyFunctionArgument": { + "description": "A positional argument passed to a row filter or column mask function.\nDistinguishes between column references and literals.", + "fields": { + "column": { + "description": "A column reference.", + "launch_stage": "GA" + }, + "constant": { + "description": "A constant literal.", + "launch_stage": "GA" + } + } + }, + "catalog.PolicyInfo": { + "fields": { + "column_mask": { + "description": "Options for column mask policies. Valid only if `policy_type` is `POLICY_TYPE_COLUMN_MASK`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "ref": "catalog.ColumnMaskOptions", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "comment": { + "description": "Optional description of the policy.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "created_at": { + "description": "Time at which the policy was created, in epoch milliseconds. Output only.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of the user who created the policy. Output only.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "except_principals": { + "description": "Optional list of user or group names that should be excluded from the policy.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "for_securable_type": { + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "ref": "catalog.SecurableType", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "id": { + "description": "Unique identifier of the policy. This field is output only and is generated by the system.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "match_columns": { + "description": "Optional list of condition expressions used to match table columns.\nOnly valid when `for_securable_type` is `TABLE`.\nWhen specified, the policy only applies to tables whose columns satisfy all match conditions.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name of the policy. Required on create and optional on update.\nTo rename the policy, set `name` to a different value on update.", + "launch_stage": "GA" + }, + "on_securable_fullname": { + "description": "Full name of the securable on which the policy is defined.\nRequired on create.", + "launch_stage": "GA" + }, + "on_securable_type": { + "description": "Type of the securable on which the policy is defined.\nOnly `CATALOG`, `SCHEMA` and `TABLE` are supported at this moment.\nRequired on create.", + "ref": "catalog.SecurableType", + "launch_stage": "GA" + }, + "policy_type": { + "description": "Type of the policy. Required on create.", + "ref": "catalog.PolicyType", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "row_filter": { + "description": "Options for row filter policies. Valid only if `policy_type` is `POLICY_TYPE_ROW_FILTER`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "ref": "catalog.RowFilterOptions", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "to_principals": { + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "updated_at": { + "description": "Time at which the policy was last modified, in epoch milliseconds. Output only.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of the user who last modified the policy. Output only.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "when_condition": { + "description": "Optional condition when the policy should take effect.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.PolicyType": { + "enum": [ + "POLICY_TYPE_ROW_FILTER", + "POLICY_TYPE_COLUMN_MASK" + ], + "enum_launch_stages": { + "POLICY_TYPE_COLUMN_MASK": "GA", + "POLICY_TYPE_ROW_FILTER": "GA" + } + }, + "catalog.PrimaryKeyConstraint": { + "fields": { + "child_columns": { + "description": "Column names for this constraint.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the constraint.", + "launch_stage": "GA" + }, + "rely": { + "description": "True if the constraint is RELY, false or unset if NORELY.", + "launch_stage": "GA" + }, + "timeseries_columns": { + "description": "Column names that represent a timeseries.", + "launch_stage": "GA" + } + } + }, + "catalog.Principal": { + "fields": { + "id": { + "description": "Databricks user, group or service principal ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "principal_type": { + "ref": "catalog.PrincipalType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.PrincipalType": { + "enum": [ + "USER_PRINCIPAL", + "GROUP_PRINCIPAL", + "SERVICE_PRINCIPAL" + ], + "enum_launch_stages": { + "GROUP_PRINCIPAL": "PUBLIC_PREVIEW", + "SERVICE_PRINCIPAL": "PUBLIC_PREVIEW", + "USER_PRINCIPAL": "PUBLIC_PREVIEW" + } + }, + "catalog.Privilege": { + "enum": [ + "SELECT", + "READ_PRIVATE_FILES", + "WRITE_PRIVATE_FILES", + "CREATE", + "USAGE", + "USE_CATALOG", + "USE_SCHEMA", + "CREATE_SCHEMA", + "CREATE_VIEW", + "CREATE_EXTERNAL_TABLE", + "CREATE_MATERIALIZED_VIEW", + "CREATE_FUNCTION", + "CREATE_MODEL", + "CREATE_CATALOG", + "CREATE_MANAGED_STORAGE", + "CREATE_EXTERNAL_LOCATION", + "CREATE_STORAGE_CREDENTIAL", + "CREATE_SERVICE_CREDENTIAL", + "ACCESS", + "CREATE_SHARE", + "CREATE_RECIPIENT", + "CREATE_PROVIDER", + "USE_SHARE", + "USE_RECIPIENT", + "USE_PROVIDER", + "USE_MARKETPLACE_ASSETS", + "SET_SHARE_PERMISSION", + "MODIFY", + "REFRESH", + "EXECUTE", + "READ_FILES", + "WRITE_FILES", + "CREATE_TABLE", + "ALL_PRIVILEGES", + "CREATE_CONNECTION", + "USE_CONNECTION", + "APPLY_TAG", + "CREATE_FOREIGN_CATALOG", + "CREATE_FOREIGN_SECURABLE", + "MANAGE_ALLOWLIST", + "CREATE_VOLUME", + "CREATE_EXTERNAL_VOLUME", + "READ_VOLUME", + "WRITE_VOLUME", + "MANAGE", + "BROWSE", + "CREATE_CLEAN_ROOM", + "MODIFY_CLEAN_ROOM", + "EXECUTE_CLEAN_ROOM_TASK", + "EXTERNAL_USE_SCHEMA" + ], + "enum_launch_stages": { + "ACCESS": "GA", + "ALL_PRIVILEGES": "GA", + "APPLY_TAG": "GA", + "BROWSE": "GA", + "CREATE": "GA", + "CREATE_CATALOG": "GA", + "CREATE_CLEAN_ROOM": "GA", + "CREATE_CONNECTION": "GA", + "CREATE_EXTERNAL_LOCATION": "GA", + "CREATE_EXTERNAL_TABLE": "GA", + "CREATE_EXTERNAL_VOLUME": "GA", + "CREATE_FOREIGN_CATALOG": "GA", + "CREATE_FOREIGN_SECURABLE": "GA", + "CREATE_FUNCTION": "GA", + "CREATE_MANAGED_STORAGE": "GA", + "CREATE_MATERIALIZED_VIEW": "GA", + "CREATE_MODEL": "GA", + "CREATE_PROVIDER": "GA", + "CREATE_RECIPIENT": "GA", + "CREATE_SCHEMA": "GA", + "CREATE_SERVICE_CREDENTIAL": "GA", + "CREATE_SHARE": "GA", + "CREATE_STORAGE_CREDENTIAL": "GA", + "CREATE_TABLE": "GA", + "CREATE_VIEW": "GA", + "CREATE_VOLUME": "GA", + "EXECUTE": "GA", + "EXECUTE_CLEAN_ROOM_TASK": "GA", + "EXTERNAL_USE_SCHEMA": "GA", + "MANAGE": "GA", + "MANAGE_ALLOWLIST": "GA", + "MODIFY": "GA", + "MODIFY_CLEAN_ROOM": "GA", + "READ_FILES": "GA", + "READ_PRIVATE_FILES": "GA", + "READ_VOLUME": "GA", + "REFRESH": "GA", + "SELECT": "GA", + "SET_SHARE_PERMISSION": "GA", + "USAGE": "GA", + "USE_CATALOG": "GA", + "USE_CONNECTION": "GA", + "USE_MARKETPLACE_ASSETS": "GA", + "USE_PROVIDER": "GA", + "USE_RECIPIENT": "GA", + "USE_SCHEMA": "GA", + "USE_SHARE": "GA", + "WRITE_FILES": "GA", + "WRITE_PRIVATE_FILES": "GA", + "WRITE_VOLUME": "GA" + } + }, + "catalog.PrivilegeAssignment": { + "fields": { + "principal": { + "description": "The principal (user email address or group name).\nFor deleted principals, `principal` is empty while `principal_id` is populated.", + "launch_stage": "GA" + }, + "privileges": { + "description": "The privileges assigned to the principal.", + "launch_stage": "GA" + } + } + }, + "catalog.ProvisioningInfo": { + "description": "Status of an asynchronously provisioned resource.", + "fields": { + "state": { + "description": "The provisioning state of the resource.", + "ref": "catalog.ProvisioningInfoState", + "launch_stage": "GA" + } + } + }, + "catalog.ProvisioningInfoState": { + "enum": [ + "PROVISIONING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING", + "DEGRADED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "DEGRADED": "GA", + "DELETING": "GA", + "FAILED": "GA", + "PROVISIONING": "GA", + "UPDATING": "GA" + } + }, + "catalog.ProvisioningStatus": { + "description": "Detailed status of an online table. Shown if the online table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "fields": { + "initial_pipeline_sync_progress": { + "description": "Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state.", + "ref": "catalog.PipelineProgress", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.QuotaInfo": { + "fields": { + "last_refreshed_at": { + "description": "The timestamp that indicates when the quota count was last updated.", + "launch_stage": "GA" + }, + "parent_full_name": { + "description": "Name of the parent resource. Returns metastore ID if the parent is a metastore.", + "launch_stage": "GA" + }, + "parent_securable_type": { + "description": "The quota parent securable type.", + "ref": "catalog.SecurableType", + "launch_stage": "GA" + }, + "quota_count": { + "description": "The current usage of the resource quota.", + "launch_stage": "GA" + }, + "quota_limit": { + "description": "The current limit of the resource quota.", + "launch_stage": "GA" + }, + "quota_name": { + "description": "The name of the quota.", + "launch_stage": "GA" + } + } + }, + "catalog.R2Credentials": { + "description": "R2 temporary credentials for API authentication.\nRead more at https://developers.cloudflare.com/r2/api/s3/tokens/.", + "fields": { + "access_key_id": { + "description": "The access key ID that identifies the temporary credentials.", + "launch_stage": "GA" + }, + "secret_access_key": { + "description": "The secret access key associated with the access key.", + "launch_stage": "GA" + }, + "session_token": { + "description": "The generated JWT that users must pass to use the temporary credentials.", + "launch_stage": "GA" + } + } + }, + "catalog.RegenerateDashboardRequest": { + "fields": { + "warehouse_id": { + "description": "Optional argument to specify the warehouse for dashboard regeneration. If not specified, the first running\nwarehouse will be used.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.RegenerateDashboardResponse": { + "fields": { + "dashboard_id": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "parent_folder": { + "description": "Parent folder is equivalent to {assets_dir}/{tableName}", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.RegisteredModelAlias": { + "fields": { + "alias_name": { + "description": "Name of the alias, e.g. 'champion' or 'latest_stable'", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog containing the model version", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the alias", + "launch_stage": "GA" + }, + "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", + "launch_stage": "GA" + }, + "version_num": { + "description": "Integer version number of the model version to which this alias points.", + "launch_stage": "GA" + } + } + }, + "catalog.RegisteredModelInfo": { + "fields": { + "aliases": { + "description": "List of aliases associated with the registered model", + "launch_stage": "GA" + }, + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog where the schema and the registered model reside", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the registered model", + "launch_stage": "GA" + }, + "created_at": { + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "created_by": { + "description": "The identifier of the user who created the registered model", + "launch_stage": "GA" + }, + "full_name": { + "description": "The three-level (fully qualified) name of the registered model", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique identifier of the metastore", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the registered model", + "launch_stage": "GA" + }, + "owner": { + "description": "The identifier of the user who owns the registered model", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema where the registered model resides", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud under which model version data files are stored", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "updated_by": { + "description": "The identifier of the user who updated the registered model last time", + "launch_stage": "GA" + } + } + }, + "catalog.RowFilterOptions": { + "fields": { + "function_name": { + "description": "The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "using": { + "description": "Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.SchemaInfo": { + "description": "Next ID: 45", + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "GA" + }, + "catalog_type": { + "description": "The type of the parent catalog.", + "ref": "catalog.CatalogType", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this schema was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of schema creator.", + "launch_stage": "GA" + }, + "effective_predictive_optimization_flag": { + "ref": "catalog.EffectivePredictiveOptimizationFlag", + "launch_stage": "GA" + }, + "enable_predictive_optimization": { + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + }, + "full_name": { + "description": "Full name of schema, in form of __catalog_name__.__schema_name__.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of schema, relative to parent catalog.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of schema.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "schema_id": { + "description": "The unique identifier of the schema.", + "launch_stage": "GA" + }, + "storage_location": { + "description": "Storage location for managed tables within schema.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for managed tables within schema.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this schema was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified schema.", + "launch_stage": "GA" + } + } + }, + "catalog.Secret": { + "description": "A secret stored in Unity Catalog. Secrets are three-level namespace objects\n(catalog.schema.secret) that securely store sensitive credential data such as\npasswords, tokens, and keys.", + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object\nthrough the **BROWSE** privilege when **include_browse** is enabled in the request.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "catalog_name": { + "description": "The name of the catalog where the schema and the secret reside.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "comment": { + "description": "User-provided free-form text description of the secret.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "create_time": { + "description": "The time at which this secret was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The principal that created the secret.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_owner": { + "description": "The effective owner of the secret, which may differ from the directly-set **owner** due to\ninheritance.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_value": { + "description": "The secret value. Only populated in responses when you have the **READ_SECRET**\nprivilege and **include_value** is set to true in the request. The maximum size is 60 KiB.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expire_time": { + "description": "User-provided expiration time of the secret. This field indicates when the secret should no\nlonger be used and may be displayed as a warning in the UI. It is purely informational and\ndoes not trigger any automatic actions or affect the secret's lifecycle.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "external_secret_id": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "full_name": { + "description": "The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "metastore_id": { + "description": "Unique identifier of the metastore hosting the secret.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the secret, relative to its parent schema.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "owner": { + "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "schema_name": { + "description": "The name of the schema where the secret resides.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "update_time": { + "description": "The time at which this secret was last updated.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "The principal that last updated the secret.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "value": { + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "INPUT_ONLY" + ] + } + } + }, + "catalog.Securable": { + "description": "Generic definition of a securable, which is uniquely defined in a metastore\nby its type and full name.", + "fields": { + "full_name": { + "description": "Required. The full name of the catalog/schema/table.\nOptional if resource_name is present.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "provider_share": { + "description": "Optional. The name of the Share object that contains the securable when the securable is\ngetting shared in D2D Delta Sharing.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "type": { + "description": "Required. The type of securable (catalog/schema/table).\nOptional if resource_name is present.", + "ref": "catalog.SecurableType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.SecurableKind": { + "description": "Latest kind: MEMORY_STORE_STANDARD = 342; Next id: 343.\nReserved numbers: 316, 317, 327, 330, 341 (former ENDPOINT_LLM_*,\nMODEL_SERVICE_STANDARD, MODEL_SERVICE_SYSTEM_DELTASHARING, MCP_SERVICE_STANDARD).", + "enum": [ + "TABLE_STANDARD", + "TABLE_EXTERNAL", + "TABLE_DELTA", + "TABLE_DELTA_EXTERNAL", + "TABLE_VIEW", + "TABLE_METRIC_VIEW", + "TABLE_DELTASHARING", + "TABLE_DELTASHARING_MUTABLE", + "TABLE_VIEW_DELTASHARING", + "TABLE_METRIC_VIEW_DELTASHARING", + "TABLE_MATERIALIZED_VIEW_DELTASHARING", + "TABLE_STREAMING_LIVE_TABLE_DELTASHARING", + "TABLE_FOREIGN_DELTASHARING", + "TABLE_DELTA_ICEBERG_DELTASHARING", + "TABLE_DELTASHARING_OPEN_DIR_BASED", + "TABLE_FEATURE_STORE", + "TABLE_FEATURE_STORE_EXTERNAL", + "TABLE_STREAMING_LIVE_TABLE", + "TABLE_SYSTEM", + "TABLE_SYSTEM_DELTASHARING", + "TABLE_MATERIALIZED_VIEW", + "TABLE_INTERNAL", + "TABLE_FOREIGN_BIGQUERY", + "TABLE_FOREIGN_MYSQL", + "TABLE_FOREIGN_ORACLE", + "TABLE_FOREIGN_POSTGRESQL", + "TABLE_FOREIGN_SQLDW", + "TABLE_FOREIGN_REDSHIFT", + "TABLE_FOREIGN_SNOWFLAKE", + "TABLE_FOREIGN_SQLSERVER", + "TABLE_FOREIGN_SALESFORCE", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING_VIEW", + "TABLE_FOREIGN_TERADATA", + "TABLE_FOREIGN_NETSUITE", + "TABLE_FOREIGN_DATABRICKS", + "TABLE_FOREIGN_WORKDAY_RAAS", + "TABLE_FOREIGN_HIVE_METASTORE", + "TABLE_FOREIGN_HIVE_METASTORE_MANAGED", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED", + "TABLE_FOREIGN_HIVE_METASTORE_EXTERNAL", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL", + "TABLE_FOREIGN_HIVE_METASTORE_VIEW", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_VIEW", + "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_MANAGED", + "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_EXTERNAL", + "TABLE_FOREIGN_MONGODB", + "TABLE_DELTA_UNIFORM_HUDI_EXTERNAL", + "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_EXTERNAL", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_MANAGED", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_SNOWFLAKE", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_DELTASHARING", + "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL_DELTASHARING", + "TABLE_ICEBERG_UNIFORM_MANAGED", + "TABLE_DELTA_ICEBERG_MANAGED", + "TABLE_ONLINE_VECTOR_INDEX_REPLICA", + "TABLE_ONLINE_VECTOR_INDEX_DIRECT", + "TABLE_ONLINE_VIEW", + "TABLE_DB_STORAGE", + "TABLE_MANAGED_POSTGRESQL" + ], + "enum_launch_stages": { + "TABLE_DB_STORAGE": "GA", + "TABLE_DELTA": "GA", + "TABLE_DELTASHARING": "GA", + "TABLE_DELTASHARING_MUTABLE": "GA", + "TABLE_DELTASHARING_OPEN_DIR_BASED": "GA", + "TABLE_DELTA_EXTERNAL": "GA", + "TABLE_DELTA_ICEBERG_DELTASHARING": "GA", + "TABLE_DELTA_ICEBERG_MANAGED": "GA", + "TABLE_DELTA_UNIFORM_HUDI_EXTERNAL": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL_DELTASHARING": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_DELTASHARING": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_EXTERNAL": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_MANAGED": "GA", + "TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_SNOWFLAKE": "GA", + "TABLE_EXTERNAL": "GA", + "TABLE_FEATURE_STORE": "GA", + "TABLE_FEATURE_STORE_EXTERNAL": "GA", + "TABLE_FOREIGN_BIGQUERY": "GA", + "TABLE_FOREIGN_DATABRICKS": "GA", + "TABLE_FOREIGN_DELTASHARING": "GA", + "TABLE_FOREIGN_HIVE_METASTORE": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_EXTERNAL": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_MANAGED": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_DBFS_VIEW": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_EXTERNAL": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_MANAGED": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED": "GA", + "TABLE_FOREIGN_HIVE_METASTORE_VIEW": "GA", + "TABLE_FOREIGN_MONGODB": "GA", + "TABLE_FOREIGN_MYSQL": "GA", + "TABLE_FOREIGN_NETSUITE": "GA", + "TABLE_FOREIGN_ORACLE": "GA", + "TABLE_FOREIGN_POSTGRESQL": "GA", + "TABLE_FOREIGN_REDSHIFT": "GA", + "TABLE_FOREIGN_SALESFORCE": "GA", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD": "GA", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING": "GA", + "TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING_VIEW": "GA", + "TABLE_FOREIGN_SNOWFLAKE": "GA", + "TABLE_FOREIGN_SQLDW": "GA", + "TABLE_FOREIGN_SQLSERVER": "GA", + "TABLE_FOREIGN_TERADATA": "GA", + "TABLE_FOREIGN_WORKDAY_RAAS": "GA", + "TABLE_ICEBERG_UNIFORM_MANAGED": "GA", + "TABLE_INTERNAL": "GA", + "TABLE_MANAGED_POSTGRESQL": "GA", + "TABLE_MATERIALIZED_VIEW": "GA", + "TABLE_MATERIALIZED_VIEW_DELTASHARING": "GA", + "TABLE_METRIC_VIEW": "GA", + "TABLE_METRIC_VIEW_DELTASHARING": "GA", + "TABLE_ONLINE_VECTOR_INDEX_DIRECT": "GA", + "TABLE_ONLINE_VECTOR_INDEX_REPLICA": "GA", + "TABLE_ONLINE_VIEW": "GA", + "TABLE_STANDARD": "GA", + "TABLE_STREAMING_LIVE_TABLE": "GA", + "TABLE_STREAMING_LIVE_TABLE_DELTASHARING": "GA", + "TABLE_SYSTEM": "GA", + "TABLE_SYSTEM_DELTASHARING": "GA", + "TABLE_VIEW": "GA", + "TABLE_VIEW_DELTASHARING": "GA" + } + }, + "catalog.SecurableKindManifest": { + "description": "Manifest of a specific securable kind.", + "fields": { + "assignable_privileges": { + "description": "Privileges that can be assigned to the securable.", + "launch_stage": "GA" + }, + "capabilities": { + "description": "A list of capabilities in the securable kind.", + "launch_stage": "GA" + }, + "options": { + "description": "Detailed specs of allowed options.", + "launch_stage": "GA" + }, + "securable_kind": { + "description": "Securable kind to get manifest of.", + "ref": "catalog.SecurableKind", + "launch_stage": "GA" + }, + "securable_type": { + "description": "Securable Type of the kind.", + "ref": "catalog.SecurableType", + "launch_stage": "GA" + } + } + }, + "catalog.SecurablePermissions": { + "fields": { + "permissions": { + "description": "List of requested Unity Catalog permissions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "securable": { + "description": "The securable for which the access request destinations are being requested.", + "ref": "catalog.Securable", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.SecurableType": { + "description": "The type of Unity Catalog securable.", + "enum": [ + "CATALOG", + "SCHEMA", + "TABLE", + "STORAGE_CREDENTIAL", + "EXTERNAL_LOCATION", + "FUNCTION", + "SHARE", + "PROVIDER", + "RECIPIENT", + "CLEAN_ROOM", + "METASTORE", + "PIPELINE", + "VOLUME", + "CONNECTION", + "CREDENTIAL", + "EXTERNAL_METADATA", + "STAGING_TABLE" + ], + "enum_launch_stages": { + "CATALOG": "GA", + "CLEAN_ROOM": "GA", + "CONNECTION": "GA", + "CREDENTIAL": "GA", + "EXTERNAL_LOCATION": "GA", + "EXTERNAL_METADATA": "GA", + "FUNCTION": "GA", + "METASTORE": "GA", + "PIPELINE": "GA", + "PROVIDER": "GA", + "RECIPIENT": "GA", + "SCHEMA": "GA", + "SHARE": "GA", + "STAGING_TABLE": "GA", + "STORAGE_CREDENTIAL": "GA", + "TABLE": "GA", + "VOLUME": "GA" + } + }, + "catalog.SetArtifactAllowlist": { + "fields": { + "artifact_matchers": { + "description": "A list of allowed artifact match patterns.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this artifact allowlist was set, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of the user who set the artifact allowlist.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "catalog.SetRegisteredModelAliasRequest": { + "fields": { + "version_num": { + "description": "The version number of the model version to which the alias points", + "launch_stage": "GA" + } + } + }, + "catalog.SpecialDestination": { + "enum": [ + "SPECIAL_DESTINATION_CATALOG_OWNER", + "SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER", + "SPECIAL_DESTINATION_CONNECTION_OWNER", + "SPECIAL_DESTINATION_CREDENTIAL_OWNER", + "SPECIAL_DESTINATION_METASTORE_OWNER" + ], + "enum_launch_stages": { + "SPECIAL_DESTINATION_CATALOG_OWNER": "PUBLIC_PREVIEW", + "SPECIAL_DESTINATION_CONNECTION_OWNER": "PUBLIC_PREVIEW", + "SPECIAL_DESTINATION_CREDENTIAL_OWNER": "PUBLIC_PREVIEW", + "SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER": "PUBLIC_PREVIEW", + "SPECIAL_DESTINATION_METASTORE_OWNER": "PUBLIC_PREVIEW" + } + }, + "catalog.SseEncryptionDetails": { + "description": "Server-Side Encryption properties for clients communicating with AWS s3.", + "fields": { + "algorithm": { + "description": "Sets the value of the 'x-amz-server-side-encryption' header in S3 request.", + "ref": "catalog.SseEncryptionDetailsAlgorithm", + "launch_stage": "GA" + }, + "aws_kms_key_arn": { + "description": "Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = \"SSE-KMS\".\nSets the value of the 'x-amz-server-side-encryption-aws-kms-key-id' header.", + "launch_stage": "GA" + } + } + }, + "catalog.SseEncryptionDetailsAlgorithm": { + "enum": [ + "AWS_SSE_S3", + "AWS_SSE_KMS" + ], + "enum_launch_stages": { + "AWS_SSE_KMS": "GA", + "AWS_SSE_S3": "GA" + } + }, + "catalog.StorageCredentialInfo": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleResponse", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityResponse", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this credential was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of credential creator.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountResponse", + "launch_stage": "GA" + }, + "full_name": { + "description": "The full name of the credential.", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the credential.", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of the parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of credential.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this credential was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the credential.", + "launch_stage": "GA" + }, + "used_for_managed_storage": { + "description": "Whether this credential is the current metastore's root storage credential.\nOnly applicable when purpose is **STORAGE**.", + "launch_stage": "GA" + } + } + }, + "catalog.SystemSchemaInfo": { + "fields": { + "schema": { + "description": "Name of the system schema.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "state": { + "description": "The current state of enablement for the system schema. An empty string means the system schema is available and ready for opt-in.\nPossible values: AVAILABLE | ENABLE_INITIALIZED | ENABLE_COMPLETED | DISABLE_INITIALIZED | UNAVAILABLE | MANAGED", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.SystemType": { + "enum": [ + "OTHER", + "TABLEAU", + "POWER_BI", + "LOOKER", + "KAFKA", + "SAP", + "ORACLE", + "SALESFORCE", + "WORKDAY", + "MYSQL", + "POSTGRESQL", + "MICROSOFT_SQL_SERVER", + "SERVICENOW", + "AMAZON_REDSHIFT", + "AZURE_SYNAPSE", + "SNOWFLAKE", + "GOOGLE_BIGQUERY", + "MICROSOFT_FABRIC", + "MONGODB", + "TERADATA", + "CONFLUENT", + "DATABRICKS", + "STREAM_NATIVE" + ], + "enum_launch_stages": { + "AMAZON_REDSHIFT": "PUBLIC_PREVIEW", + "AZURE_SYNAPSE": "PUBLIC_PREVIEW", + "CONFLUENT": "PUBLIC_PREVIEW", + "DATABRICKS": "PUBLIC_PREVIEW", + "GOOGLE_BIGQUERY": "PUBLIC_PREVIEW", + "KAFKA": "PUBLIC_PREVIEW", + "LOOKER": "PUBLIC_PREVIEW", + "MICROSOFT_FABRIC": "PUBLIC_PREVIEW", + "MICROSOFT_SQL_SERVER": "PUBLIC_PREVIEW", + "MONGODB": "PUBLIC_PREVIEW", + "MYSQL": "PUBLIC_PREVIEW", + "ORACLE": "PUBLIC_PREVIEW", + "OTHER": "PUBLIC_PREVIEW", + "POSTGRESQL": "PUBLIC_PREVIEW", + "POWER_BI": "PUBLIC_PREVIEW", + "SALESFORCE": "PUBLIC_PREVIEW", + "SAP": "PUBLIC_PREVIEW", + "SERVICENOW": "PUBLIC_PREVIEW", + "SNOWFLAKE": "PUBLIC_PREVIEW", + "STREAM_NATIVE": "PUBLIC_PREVIEW", + "TABLEAU": "PUBLIC_PREVIEW", + "TERADATA": "PUBLIC_PREVIEW", + "WORKDAY": "PUBLIC_PREVIEW" + } + }, + "catalog.TableConstraint": { + "description": "A table constraint, as defined by *one* of the following fields being set:\n__primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.", + "fields": { + "foreign_key_constraint": { + "ref": "catalog.ForeignKeyConstraint", + "launch_stage": "GA" + }, + "named_table_constraint": { + "ref": "catalog.NamedTableConstraint", + "launch_stage": "GA" + }, + "primary_key_constraint": { + "ref": "catalog.PrimaryKeyConstraint", + "launch_stage": "GA" + } + } + }, + "catalog.TableDependency": { + "description": "A table that is dependent on a SQL object.", + "fields": { + "table_full_name": { + "description": "Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__.", + "launch_stage": "GA" + } + } + }, + "catalog.TableExistsResponse": { + "fields": { + "table_exists": { + "description": "Whether the table exists or not.", + "launch_stage": "GA" + } + } + }, + "catalog.TableInfo": { + "fields": { + "access_point": { + "description": "The AWS access point to use when accesing s3 for this external location.", + "launch_stage": "GA" + }, + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "GA" + }, + "columns": { + "description": "The array of __ColumnInfo__ definitions of the table's columns.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this table was created, in epoch milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "Username of table creator.", + "launch_stage": "GA" + }, + "data_access_configuration_id": { + "description": "Unique ID of the Data Access Configuration to use with the table data.", + "deprecated": true, + "launch_stage": "GA" + }, + "data_source_format": { + "ref": "catalog.DataSourceFormat", + "launch_stage": "GA" + }, + "deleted_at": { + "description": "Time at which this table was deleted, in epoch milliseconds. Field is omitted if table is not deleted.", + "launch_stage": "GA" + }, + "delta_runtime_properties_kvpairs": { + "description": "Information pertaining to current state of the delta table.", + "ref": "catalog.DeltaRuntimePropertiesKVPairs", + "launch_stage": "GA" + }, + "effective_predictive_optimization_flag": { + "ref": "catalog.EffectivePredictiveOptimizationFlag", + "launch_stage": "GA" + }, + "enable_predictive_optimization": { + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + }, + "encryption_details": { + "ref": "catalog.EncryptionDetails", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "full_name": { + "description": "Full name of table, in form of __catalog_name__.__schema_name__.__table_name__", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of parent metastore.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of table, relative to parent schema.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of table.", + "launch_stage": "GA" + }, + "pipeline_id": { + "description": "The pipeline ID of the table. Applicable for tables created by pipelines (Materialized View, Streaming Table, etc.).", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "row_filter": { + "ref": "catalog.TableRowFilter", + "launch_stage": "GA" + }, + "schema_name": { + "description": "Name of parent schema relative to its parent catalog.", + "launch_stage": "GA" + }, + "securable_kind_manifest": { + "description": "SecurableKindManifest of table, including capabilities the table has.", + "ref": "catalog.SecurableKindManifest", + "launch_stage": "GA" + }, + "sql_path": { + "description": "List of schemes whose objects can be referenced without qualification.", + "launch_stage": "GA" + }, + "storage_credential_name": { + "description": "Name of the storage credential, when a storage credential is configured for use with this table.", + "launch_stage": "GA" + }, + "storage_location": { + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "launch_stage": "GA" + }, + "table_constraints": { + "description": "List of table constraints. Note: this field is not set in the output of the __listTables__ API.", + "launch_stage": "GA" + }, + "table_id": { + "description": "The unique identifier of the table.", + "launch_stage": "GA" + }, + "table_type": { + "ref": "catalog.TableType", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this table was last modified, in epoch milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "Username of user who last modified the table.", + "launch_stage": "GA" + }, + "view_definition": { + "description": "View definition SQL (when __table_type__ is **VIEW**, **MATERIALIZED_VIEW**, or **STREAMING_TABLE**)", + "launch_stage": "GA" + }, + "view_dependencies": { + "description": "View dependencies (when table_type == **VIEW** or **MATERIALIZED_VIEW**, **STREAMING_TABLE**)\n- when DependencyList is None, the dependency is not provided;\n- when DependencyList is an empty list, the dependency is provided but is empty;\n- when DependencyList is not an empty list, dependencies are provided and recorded.\nNote: this field is not set in the output of the __listTables__ API.", + "ref": "catalog.DependencyList", + "launch_stage": "GA" + } + } + }, + "catalog.TableOperation": { + "enum": [ + "READ", + "READ_WRITE" + ], + "enum_launch_stages": { + "READ": "GA", + "READ_WRITE": "GA" + } + }, + "catalog.TableRowFilter": { + "fields": { + "function_name": { + "description": "The full name of the row filter SQL UDF.", + "launch_stage": "GA" + }, + "input_arguments": { + "description": "The list of additional table columns or literals to be passed as additional arguments to\na row filter function. This is the replacement of the deprecated input_column_names field and\ncarries information about the types (alias or constant) of the arguments to the filter function.", + "launch_stage": "GA" + }, + "input_column_names": { + "description": "The list of table columns to be passed as input to the row filter function. The column types\nshould match the types of the filter function arguments.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "catalog.TableSummary": { + "fields": { + "full_name": { + "description": "The full name of the table.", + "launch_stage": "GA" + }, + "securable_kind_manifest": { + "description": "SecurableKindManifest of table, including capabilities the table has.", + "ref": "catalog.SecurableKindManifest", + "launch_stage": "GA" + }, + "table_type": { + "ref": "catalog.TableType", + "launch_stage": "GA" + } + } + }, + "catalog.TableType": { + "enum": [ + "MANAGED", + "EXTERNAL", + "VIEW", + "MATERIALIZED_VIEW", + "STREAMING_TABLE", + "MANAGED_SHALLOW_CLONE", + "FOREIGN", + "EXTERNAL_SHALLOW_CLONE", + "METRIC_VIEW" + ], + "enum_launch_stages": { + "EXTERNAL": "GA", + "EXTERNAL_SHALLOW_CLONE": "GA", + "FOREIGN": "GA", + "MANAGED": "GA", + "MANAGED_SHALLOW_CLONE": "GA", + "MATERIALIZED_VIEW": "GA", + "METRIC_VIEW": "GA", + "STREAMING_TABLE": "GA", + "VIEW": "GA" + } + }, + "catalog.TagAssignmentSourceType": { + "description": "Enum representing the source type of a tag assignment", + "enum": [ + "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION" + ], + "enum_launch_stages": { + "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION": "GA" + } + }, + "catalog.TagKeyValue": { + "fields": { + "key": { + "description": "name of the tag", + "launch_stage": "GA" + }, + "value": { + "description": "value of the tag associated with the key, could be optional", + "launch_stage": "GA" + } + } + }, + "catalog.TemporaryCredentials": { + "fields": { + "aws_temp_credentials": { + "ref": "catalog.AwsCredentials", + "launch_stage": "GA" + }, + "azure_aad": { + "ref": "catalog.AzureActiveDirectoryToken", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Server time when the credential will expire, in epoch milliseconds.\nThe API client is advised to cache the credential given this expiration time.", + "launch_stage": "GA" + }, + "gcp_oauth_token": { + "ref": "catalog.GcpOauthToken", + "launch_stage": "GA" + }, + "r2_temp_credentials": { + "ref": "catalog.R2Credentials", + "launch_stage": "GA" + } + } + }, + "catalog.TriggeredUpdateStatus": { + "description": "Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE\nor the ONLINE_NO_PENDING_UPDATE state.", + "fields": { + "last_processed_commit_version": { + "description": "The last source table Delta version that was synced to the online table. Note that this Delta\nversion may not be completely synced to the online table yet.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "timestamp": { + "description": "The timestamp of the last time any data was synchronized from the source table to the online\ntable.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "triggered_update_progress": { + "description": "Progress of the active data synchronization pipeline.", + "ref": "catalog.PipelineProgress", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.UnassignResponse": {}, + "catalog.UpdateAccountsMetastore": { + "fields": { + "delta_sharing_organization_name": { + "description": "The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.", + "launch_stage": "GA" + }, + "delta_sharing_recipient_token_lifetime_in_seconds": { + "description": "The lifetime of delta sharing recipient token in seconds.", + "launch_stage": "GA" + }, + "delta_sharing_scope": { + "description": "The scope of Delta Sharing enabled for the metastore.", + "ref": "catalog.DeltaSharingScopeEnum", + "launch_stage": "GA" + }, + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the metastore.", + "launch_stage": "GA" + }, + "privilege_model_version": { + "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).", + "launch_stage": "GA" + }, + "storage_root_credential_id": { + "description": "UUID of storage credential to access the metastore storage_root.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateAccountsStorageCredential": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleRequest", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityResponse", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountRequest", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of credential.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateAssignmentResponse": {}, + "catalog.UpdateCatalog": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "enable_predictive_optimization": { + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a specific set of workspaces.", + "ref": "catalog.CatalogIsolationMode", + "launch_stage": "GA" + }, + "managed_encryption_settings": { + "description": "Control CMK encryption for managed catalog data", + "ref": "catalog.EncryptionSettings", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the catalog.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of catalog.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateCatalogWorkspaceBindingsResponse": { + "fields": { + "workspaces": { + "description": "A list of workspace IDs", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateConnection": { + "fields": { + "new_name": { + "description": "New name for the connection.", + "launch_stage": "GA" + }, + "options": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of the connection.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateCredentialRequest": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRole", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentity", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccount", + "launch_stage": "GA" + }, + "force": { + "description": "Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**).", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name of credential.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of credential.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Supply true to this argument to skip validation of the updated credential.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateExternalLocation": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "credential_name": { + "description": "Name of the storage credential used with this location.", + "launch_stage": "GA" + }, + "effective_enable_file_events": { + "description": "The effective value of `enable_file_events` after applying server-side defaults.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_file_event_queue": { + "description": "The effective file event queue configuration after applying server-side defaults.\nAlways populated when a queue is provisioned, regardless of whether the user explicitly\nset `enable_file_events`. Use this field instead of `file_event_queue` for reading\nthe actual queue state.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "enable_file_events": { + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", + "launch_stage": "GA" + }, + "encryption_details": { + "ref": "catalog.EncryptionDetails", + "launch_stage": "GA" + }, + "fallback": { + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", + "launch_stage": "GA" + }, + "file_event_queue": { + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", + "ref": "catalog.FileEventQueue", + "launch_stage": "GA" + }, + "force": { + "description": "Force update even if changing url invalidates dependent external tables or mounts.", + "launch_stage": "GA" + }, + "isolation_mode": { + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the external location.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the external location.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Indicates whether the external location is read-only.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Skips validation of the storage credential associated with the external location.", + "launch_stage": "GA" + }, + "url": { + "description": "Path URL of the external location.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateFunction": { + "fields": { + "owner": { + "description": "Username of current owner of the function.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateMetastore": { + "fields": { + "delta_sharing_organization_name": { + "description": "The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.", + "launch_stage": "GA" + }, + "delta_sharing_recipient_token_lifetime_in_seconds": { + "description": "The lifetime of delta sharing recipient token in seconds.", + "launch_stage": "GA" + }, + "delta_sharing_scope": { + "description": "The scope of Delta Sharing enabled for the metastore.", + "ref": "catalog.DeltaSharingScopeEnum", + "launch_stage": "GA" + }, + "external_access_enabled": { + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the metastore.", + "launch_stage": "GA" + }, + "owner": { + "description": "The owner of the metastore.", + "launch_stage": "GA" + }, + "privilege_model_version": { + "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).", + "launch_stage": "GA" + }, + "storage_root_credential_id": { + "description": "UUID of storage credential to access the metastore storage_root.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateMetastoreAssignment": { + "fields": { + "default_catalog_name": { + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique ID of the metastore.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateModelVersionRequest": { + "fields": { + "aliases": { + "description": "List of aliases associated with the model version", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog containing the model version", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the model version", + "launch_stage": "GA" + }, + "created_at": { + "launch_stage": "GA" + }, + "created_by": { + "description": "The identifier of the user who created the model version", + "launch_stage": "GA" + }, + "id": { + "description": "The unique identifier of the model version", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique identifier of the metastore containing the model version", + "launch_stage": "GA" + }, + "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", + "launch_stage": "GA" + }, + "model_version_dependencies": { + "description": "Model version dependencies, for feature-store packaged models", + "ref": "catalog.DependencyList", + "launch_stage": "GA" + }, + "run_id": { + "description": "MLflow run ID used when creating the model version, if ``source`` was generated by an\nexperiment run stored in an MLflow tracking server", + "launch_stage": "GA" + }, + "run_workspace_id": { + "description": "ID of the Databricks workspace containing the MLflow run that generated this model\nversion, if applicable", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", + "launch_stage": "GA" + }, + "source": { + "description": "URI indicating the location of the source artifacts (files) for the model version", + "launch_stage": "GA" + }, + "status": { + "description": "Current status of the model version. Newly created model versions start in\nPENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and\nthe model version is finalized. Only model versions in READY status can be loaded for inference or\nserved.", + "ref": "catalog.ModelVersionInfoStatus", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud under which model version data files are stored", + "launch_stage": "GA" + }, + "updated_at": { + "launch_stage": "GA" + }, + "updated_by": { + "description": "The identifier of the user who updated the model version last time", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateMonitor": { + "fields": { + "baseline_table_name": { + "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "launch_stage": "GA" + }, + "custom_metrics": { + "description": "[Create:OPT Update:OPT] Custom metrics.", + "launch_stage": "GA" + }, + "dashboard_id": { + "description": "[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state.", + "launch_stage": "GA" + }, + "data_classification_config": { + "description": "[Create:OPT Update:OPT] Data classification related config.", + "ref": "catalog.MonitorDataClassificationConfig", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "inference_log": { + "ref": "catalog.MonitorInferenceLog", + "launch_stage": "GA" + }, + "latest_monitor_failure_msg": { + "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", + "launch_stage": "GA" + }, + "notifications": { + "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", + "ref": "catalog.MonitorNotifications", + "launch_stage": "GA" + }, + "output_schema_name": { + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "schedule": { + "description": "[Create:OPT Update:OPT] The monitor schedule.", + "ref": "catalog.MonitorCronSchedule", + "launch_stage": "GA" + }, + "slicing_exprs": { + "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "launch_stage": "GA" + }, + "snapshot": { + "description": "Configuration for monitoring snapshot tables.", + "ref": "catalog.MonitorSnapshot", + "launch_stage": "GA" + }, + "time_series": { + "description": "Configuration for monitoring time series tables.", + "ref": "catalog.MonitorTimeSeries", + "launch_stage": "GA" + } + } + }, + "catalog.UpdatePermissions": { + "fields": { + "changes": { + "description": "Array of permissions change objects.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdatePermissionsResponse": { + "fields": { + "privilege_assignments": { + "description": "The privileges assigned to each principal", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateRegisteredModelRequest": { + "fields": { + "aliases": { + "description": "List of aliases associated with the registered model", + "launch_stage": "GA" + }, + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA" + }, + "catalog_name": { + "description": "The name of the catalog where the schema and the registered model reside", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the registered model", + "launch_stage": "GA" + }, + "created_at": { + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "created_by": { + "description": "The identifier of the user who created the registered model", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "The unique identifier of the metastore", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the registered model", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the registered model.", + "launch_stage": "GA" + }, + "owner": { + "description": "The identifier of the user who owns the registered model", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema where the registered model resides", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud under which model version data files are stored", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", + "launch_stage": "GA" + }, + "updated_by": { + "description": "The identifier of the user who updated the registered model last time", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateRequestExternalLineage": { + "fields": { + "columns": { + "description": "List of column relationships between source and target objects.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "description": "Unique identifier of the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "properties": { + "description": "Key-value properties associated with the external lineage relationship.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source": { + "description": "Source object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target": { + "description": "Target object of the external lineage relationship.", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "catalog.UpdateResponse": {}, + "catalog.UpdateSchema": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "enable_predictive_optimization": { + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "ref": "catalog.EnablePredictiveOptimization", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the schema.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of schema.", + "launch_stage": "GA" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateStorageCredential": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleRequest", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityResponse", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment associated with the credential.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "description": "The Databricks managed GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountRequest", + "launch_stage": "GA" + }, + "force": { + "description": "Force update even if there are dependent external locations or external\ntables.", + "launch_stage": "GA" + }, + "isolation_mode": { + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "ref": "catalog.IsolationMode", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the storage credential.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of credential.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "Supplying true to this argument skips validation of the updated credential.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateVolumeRequestContent": { + "fields": { + "comment": { + "description": "The comment attached to the volume", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the volume.", + "launch_stage": "GA" + }, + "owner": { + "description": "The identifier of the user who owns the volume", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateWorkspaceBindingsResponse": { + "description": "A list of workspace IDs that are bound to the securable", + "fields": { + "bindings": { + "description": "List of workspace bindings.", + "launch_stage": "GA" + } + } + }, + "catalog.ValidateCredentialRequest": { + "description": "Next ID: 18", + "fields": { + "aws_iam_role": { + "ref": "catalog.AwsIamRole", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "ref": "catalog.AzureManagedIdentity", + "launch_stage": "GA" + }, + "credential_name": { + "description": "Required. The name of an existing credential or long-lived cloud\ncredential to validate.", + "launch_stage": "GA" + }, + "databricks_gcp_service_account": { + "ref": "catalog.DatabricksGcpServiceAccount", + "launch_stage": "GA" + }, + "external_location_name": { + "description": "The name of an existing external location to validate. Only applicable for\nstorage credentials (purpose is\n**STORAGE**.)", + "launch_stage": "GA" + }, + "purpose": { + "description": "The purpose of the credential. This should only be used when the credential\nis specified.", + "ref": "catalog.CredentialPurpose", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the credential is only usable for read operations. Only applicable\nfor storage credentials (purpose is\n**STORAGE**.)", + "launch_stage": "GA" + }, + "url": { + "description": "The external location url to validate. Only applicable when purpose is\n**STORAGE**.", + "launch_stage": "GA" + } + } + }, + "catalog.ValidateCredentialResponse": { + "fields": { + "isDir": { + "description": "Whether the tested location is a directory in cloud storage. Only\napplicable for when purpose is **STORAGE**.", + "launch_stage": "GA" + }, + "results": { + "description": "The results of the validation check.", + "launch_stage": "GA" + } + } + }, + "catalog.ValidateCredentialResult": { + "description": "A enum represents the result of the file operation", + "enum": [ + "PASS", + "FAIL", + "SKIP" + ], + "enum_launch_stages": { + "FAIL": "GA", + "PASS": "GA", + "SKIP": "GA" + } + }, + "catalog.ValidateStorageCredential": { + "fields": { + "aws_iam_role": { + "description": "The AWS IAM role configuration.", + "ref": "catalog.AwsIamRoleRequest", + "launch_stage": "GA" + }, + "azure_managed_identity": { + "description": "The Azure managed identity configuration.", + "ref": "catalog.AzureManagedIdentityRequest", + "launch_stage": "GA" + }, + "azure_service_principal": { + "description": "The Azure service principal configuration.", + "ref": "catalog.AzureServicePrincipal", + "launch_stage": "GA" + }, + "cloudflare_api_token": { + "description": "The Cloudflare API token configuration.", + "ref": "catalog.CloudflareApiToken", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "databricks_gcp_service_account": { + "description": "The Databricks created GCP service account configuration.", + "ref": "catalog.DatabricksGcpServiceAccountRequest", + "launch_stage": "GA" + }, + "external_location_name": { + "description": "The name of an existing external location to validate.", + "launch_stage": "GA" + }, + "read_only": { + "description": "Whether the storage credential is only usable for read operations.", + "launch_stage": "GA" + }, + "storage_credential_name": { + "description": "Required. The name of an existing credential or long-lived cloud\ncredential to validate.", + "launch_stage": "GA" + }, + "url": { + "description": "The external location url to validate.", + "launch_stage": "GA" + } + } + }, + "catalog.ValidateStorageCredentialResponse": { + "fields": { + "isDir": { + "description": "Whether the tested location is a directory in cloud storage.", + "launch_stage": "GA" + }, + "results": { + "description": "The results of the validation check.", + "launch_stage": "GA" + } + } + }, + "catalog.ValidationResult": { + "fields": { + "message": { + "description": "Error message would exist when the result does not equal to **PASS**.", + "launch_stage": "GA" + }, + "operation": { + "description": "The operation tested.", + "ref": "catalog.ValidationResultOperation", + "launch_stage": "GA" + }, + "result": { + "description": "The results of the tested operation.", + "ref": "catalog.ValidationResultResult", + "launch_stage": "GA" + } + } + }, + "catalog.ValidationResultOperation": { + "description": "A enum represents the file operation performed on the external location\nwith the storage credential", + "enum": [ + "LIST", + "READ", + "WRITE", + "DELETE", + "PATH_EXISTS" + ], + "enum_launch_stages": { + "DELETE": "GA", + "LIST": "GA", + "PATH_EXISTS": "GA", + "READ": "GA", + "WRITE": "GA" + } + }, + "catalog.ValidationResultResult": { + "description": "A enum represents the result of the file operation", + "enum": [ + "PASS", + "FAIL", + "SKIP" + ], + "enum_launch_stages": { + "FAIL": "GA", + "PASS": "GA", + "SKIP": "GA" + } + }, + "catalog.VolumeInfo": { + "fields": { + "access_point": { + "description": "The AWS access point to use when accesing s3 for this external location.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "catalog_name": { + "description": "The name of the catalog where the schema and the volume are", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment attached to the volume", + "launch_stage": "GA" + }, + "created_at": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The identifier of the user who created the volume", + "launch_stage": "GA" + }, + "encryption_details": { + "ref": "catalog.EncryptionDetails", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "full_name": { + "description": "The three-level (fully qualified) name of the volume", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "metastore_id": { + "description": "The unique identifier of the metastore", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the volume", + "launch_stage": "GA" + }, + "owner": { + "description": "The identifier of the user who owns the volume", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema where the volume is", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location on the cloud", + "launch_stage": "GA" + }, + "updated_at": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "The identifier of the user who updated the volume last time", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "volume_id": { + "description": "The unique identifier of the volume", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "volume_type": { + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "ref": "catalog.VolumeType", + "launch_stage": "GA" + } + } + }, + "catalog.VolumeOperation": { + "enum": [ + "READ_VOLUME", + "WRITE_VOLUME" + ], + "enum_launch_stages": { + "READ_VOLUME": "PUBLIC_PREVIEW", + "WRITE_VOLUME": "PUBLIC_PREVIEW" + } + }, + "catalog.VolumeType": { + "enum": [ + "MANAGED", + "EXTERNAL" + ], + "enum_launch_stages": { + "EXTERNAL": "GA", + "MANAGED": "GA" + } + }, + "catalog.cancelRefreshRequest": {}, + "catalog.createTableRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "columns": { + "description": "The array of __ColumnInfo__ definitions of the table's columns.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "data_source_format": { + "ref": "catalog.DataSourceFormat", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of table, relative to parent schema.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema_name": { + "description": "Name of parent schema relative to its parent catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "storage_location": { + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "launch_stage": "PUBLIC_PREVIEW" + }, + "table_type": { + "ref": "catalog.TableType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.enableRequest": { + "fields": { + "catalog_name": { + "description": "the catalog for which the system schema is to enabled in", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.runRefreshRequest": {}, + "catalog.updateTableRequest": { + "fields": { + "owner": { + "description": "Username of current owner of table.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "catalog.updateWorkspaceBindings": { + "fields": { + "assign_workspaces": { + "description": "A list of workspace IDs.", + "launch_stage": "GA" + }, + "unassign_workspaces": { + "description": "A list of workspace IDs.", + "launch_stage": "GA" + } + } + }, + "catalog.updateWorkspaceBindingsParameters": { + "fields": { + "add": { + "description": "List of workspace bindings to add. If a binding for the workspace already exists with a\ndifferent binding_type, adding it again with a new binding_type will update the existing\nbinding (e.g., from READ_WRITE to READ_ONLY).", + "launch_stage": "GA" + }, + "remove": { + "description": "List of workspace bindings to remove.", + "launch_stage": "GA" + } + } + }, + "catalog.workspaceBinding": { + "fields": { + "binding_type": { + "description": "One of READ_WRITE/READ_ONLY. Default is READ_WRITE.", + "ref": "catalog.workspaceBindingBindingType", + "launch_stage": "GA" + }, + "workspace_id": { + "description": "Required", + "launch_stage": "GA" + } + } + }, + "catalog.workspaceBindingBindingType": { + "description": "Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in `credentials_common.proto`.", + "enum": [ + "BINDING_TYPE_READ_WRITE", + "BINDING_TYPE_READ_ONLY" + ], + "enum_launch_stages": { + "BINDING_TYPE_READ_ONLY": "GA", + "BINDING_TYPE_READ_WRITE": "GA" + } + }, + "cleanrooms.CleanRoom": { + "fields": { + "access_restricted": { + "description": "Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html)", + "ref": "cleanrooms.CleanRoomAccessRestricted", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "comment": { + "launch_stage": "GA" + }, + "created_at": { + "description": "When the clean room was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "local_collaborator_alias": { + "description": "The alias of the collaborator tied to the local clean room.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the clean room.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "output_catalog": { + "description": "Output catalog of the clean room. It is an output only field. Output catalog is manipulated\nusing the separate CreateCleanRoomOutputCatalog API.", + "ref": "cleanrooms.CleanRoomOutputCatalog", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "owner": { + "description": "This is the Databricks username of the owner of the local clean room securable for permission management.", + "launch_stage": "GA" + }, + "remote_detailed_info": { + "description": "Central clean room details. During creation, users need to specify\ncloud_vendor, region, and collaborators.global_metastore_id.\nThis field will not be filled in the ListCleanRooms call.", + "ref": "cleanrooms.CleanRoomRemoteDetail", + "launch_stage": "GA" + }, + "status": { + "description": "Clean room status.", + "ref": "cleanrooms.CleanRoomStatusEnum", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_at": { + "description": "When the clean room was last updated, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomAccessRestricted": { + "enum": [ + "NO_RESTRICTION", + "CSP_MISMATCH" + ], + "enum_launch_stages": { + "CSP_MISMATCH": "GA", + "NO_RESTRICTION": "GA" + } + }, + "cleanrooms.CleanRoomAsset": { + "description": "Metadata of the clean room asset", + "fields": { + "added_at": { + "description": "When the asset is added to the clean room, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "asset_type": { + "description": "The type of the asset.", + "ref": "cleanrooms.CleanRoomAssetAssetType", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "clean_room_name": { + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "foreign_table": { + "description": "Foreign table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "ref": "cleanrooms.CleanRoomAssetForeignTable", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "foreign_table_local_details": { + "description": "Local details for a foreign that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "ref": "cleanrooms.CleanRoomAssetForeignTableLocalDetails", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "notebook": { + "description": "Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**", + "ref": "cleanrooms.CleanRoomAssetNotebook", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "owner_collaborator_alias": { + "description": "The alias of the collaborator who owns this asset", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "status": { + "description": "Status of the asset", + "ref": "cleanrooms.CleanRoomAssetStatusEnum", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "table": { + "description": "Table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **TABLE**", + "ref": "cleanrooms.CleanRoomAssetTable", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "table_local_details": { + "description": "Local details for a table that are only available to its owner.\nPresent if and only if **asset_type** is **TABLE**", + "ref": "cleanrooms.CleanRoomAssetTableLocalDetails", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "view": { + "description": "View details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **VIEW**", + "ref": "cleanrooms.CleanRoomAssetView", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "view_local_details": { + "description": "Local details for a view that are only available to its owner.\nPresent if and only if **asset_type** is **VIEW**", + "ref": "cleanrooms.CleanRoomAssetViewLocalDetails", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "volume_local_details": { + "description": "Local details for a volume that are only available to its owner.\nPresent if and only if **asset_type** is **VOLUME**", + "ref": "cleanrooms.CleanRoomAssetVolumeLocalDetails", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "cleanrooms.CleanRoomAssetAssetType": { + "enum": [ + "TABLE", + "NOTEBOOK_FILE", + "VOLUME", + "VIEW", + "FOREIGN_TABLE" + ], + "enum_launch_stages": { + "FOREIGN_TABLE": "GA", + "NOTEBOOK_FILE": "GA", + "TABLE": "GA", + "VIEW": "GA", + "VOLUME": "GA" + } + }, + "cleanrooms.CleanRoomAssetForeignTable": { + "fields": { + "columns": { + "description": "The metadata information of the columns in the foreign table", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomAssetForeignTableLocalDetails": { + "fields": { + "local_name": { + "description": "The fully qualified name of the foreign table in its owner's local metastore,\nin the format of *catalog*.*schema*.*foreign_table_name*", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "cleanrooms.CleanRoomAssetNotebook": { + "fields": { + "etag": { + "description": "Server generated etag that represents the notebook version.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "notebook_content": { + "description": "Base 64 representation of the notebook contents.\nThis is the same format as returned by :method:workspace/export with the format of **HTML**.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "review_state": { + "description": "Top-level status derived from all reviews", + "ref": "cleanrooms.CleanRoomNotebookReviewNotebookReviewState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "reviews": { + "description": "All existing approvals or rejections", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "runner_collaborator_aliases": { + "description": "Aliases of collaborators that can run the notebook.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "cleanrooms.CleanRoomAssetStatusEnum": { + "enum": [ + "ACTIVE", + "PERMISSION_DENIED", + "PENDING" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "PENDING": "GA", + "PERMISSION_DENIED": "GA" + } + }, + "cleanrooms.CleanRoomAssetTable": { + "fields": { + "columns": { + "description": "The metadata information of the columns in the table", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomAssetTableLocalDetails": { + "fields": { + "local_name": { + "description": "The fully qualified name of the table in its owner's local metastore,\nin the format of *catalog*.*schema*.*table_name*", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "partitions": { + "description": "Partition filtering specification for a shared table.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "cleanrooms.CleanRoomAssetView": { + "fields": { + "columns": { + "description": "The metadata information of the columns in the view", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomAssetViewLocalDetails": { + "fields": { + "local_name": { + "description": "The fully qualified name of the view in its owner's local metastore,\nin the format of *catalog*.*schema*.*view_name*", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "cleanrooms.CleanRoomAssetVolumeLocalDetails": { + "fields": { + "local_name": { + "description": "The fully qualified name of the volume in its owner's local metastore,\nin the format of *catalog*.*schema*.*volume_name*", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "cleanrooms.CleanRoomAutoApprovalRule": { + "fields": { + "author_collaborator_alias": { + "description": "Collaborator alias of the author covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "author_scope": { + "description": "Scope of authors covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.", + "ref": "cleanrooms.CleanRoomAutoApprovalRuleAuthorScope", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "clean_room_name": { + "description": "The name of the clean room this auto-approval rule belongs to.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "created_at": { + "description": "Timestamp of when the rule was created, in epoch milliseconds.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "rule_id": { + "description": "A generated UUID identifying the rule.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "rule_owner_collaborator_alias": { + "description": "The owner of the rule to whom the rule applies.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "runner_collaborator_alias": { + "description": "Collaborator alias of the runner covered by the rule.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "cleanrooms.CleanRoomAutoApprovalRuleAuthorScope": { + "enum": [ + "ANY_AUTHOR" + ], + "enum_launch_stages": { + "ANY_AUTHOR": "PUBLIC_BETA" + } + }, + "cleanrooms.CleanRoomCollaborator": { + "description": "Publicly visible clean room collaborator.", + "fields": { + "collaborator_alias": { + "description": "Collaborator alias specified by the clean room creator. It is unique across all collaborators of this clean room, and used to derive\nmultiple values internally such as catalog alias and clean room name for single metastore clean rooms.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "display_name": { + "description": "Generated display name for the collaborator. In the case of a single metastore clean room, it is the clean\nroom name. For x-metastore clean rooms, it is the organization name of the metastore. It is not restricted to\nthese values and could change in the future", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "global_metastore_id": { + "description": "The global Unity Catalog metastore ID of the collaborator. The identifier is of format cloud:region:metastore-uuid.", + "launch_stage": "GA" + }, + "invite_recipient_email": { + "description": "Email of the user who is receiving the clean room \"invitation\". It should be empty\nfor the creator of the clean room, and non-empty for the invitees of the clean room.\nIt is only returned in the output when clean room creator calls GET", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "invite_recipient_workspace_id": { + "description": "Workspace ID of the user who is receiving the clean room \"invitation\". Must be specified if\ninvite_recipient_email is specified.\nIt should be empty when the collaborator is the creator of the clean room.", + "launch_stage": "GA", + "behaviors": [ + "INPUT_ONLY" + ] + }, + "organization_name": { + "description": "[Organization name](:method:metastores/list#metastores-delta_sharing_organization_name)\nconfigured in the metastore", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomNotebookReview": { + "fields": { + "comment": { + "description": "Review comment", + "launch_stage": "GA" + }, + "created_at_millis": { + "description": "When the review was submitted, in epoch milliseconds", + "launch_stage": "GA" + }, + "review_state": { + "description": "Review outcome", + "ref": "cleanrooms.CleanRoomNotebookReviewNotebookReviewState", + "launch_stage": "GA" + }, + "review_sub_reason": { + "description": "Specified when the review was not explicitly made by a user", + "ref": "cleanrooms.CleanRoomNotebookReviewNotebookReviewSubReason", + "launch_stage": "GA" + }, + "reviewer_collaborator_alias": { + "description": "Collaborator alias of the reviewer", + "launch_stage": "GA" + } + } + }, + "cleanrooms.CleanRoomNotebookReviewNotebookReviewState": { + "enum": [ + "APPROVED", + "REJECTED", + "PENDING" + ], + "enum_launch_stages": { + "APPROVED": "GA", + "PENDING": "GA", + "REJECTED": "GA" + } + }, + "cleanrooms.CleanRoomNotebookReviewNotebookReviewSubReason": { + "enum": [ + "BACKFILLED", + "AUTO_APPROVED" + ], + "enum_launch_stages": { + "AUTO_APPROVED": "GA", + "BACKFILLED": "GA" + } + }, + "cleanrooms.CleanRoomNotebookTaskRun": { + "description": "Stores information about a single task run.", + "fields": { + "collaborator_job_run_info": { + "description": "Job run info of the task in the runner's local workspace.\nThis field is only included in the LIST API.\nif the task was run within the same workspace the API is being called.\nIf the task run was in a different workspace under the same metastore, only the workspace_id is included.", + "ref": "cleanrooms.CollaboratorJobRunInfo", + "launch_stage": "GA" + }, + "notebook_etag": { + "description": "Etag of the notebook executed in this task run, used to identify the notebook version.", + "launch_stage": "GA" + }, + "notebook_job_run_state": { + "description": "State of the task run.", + "ref": "jobs.CleanRoomTaskRunState", + "launch_stage": "GA" + }, + "notebook_name": { + "description": "Asset name of the notebook executed in this task run.", + "launch_stage": "GA" + }, + "notebook_updated_at": { + "description": "The timestamp of when the notebook was last updated.", + "launch_stage": "GA" + }, + "output_schema_expiration_time": { + "description": "Expiration time of the output schema of the task run (if any), in epoch milliseconds.", + "launch_stage": "GA" + }, + "output_schema_name": { + "description": "Name of the output schema associated with the clean rooms notebook task run.", + "launch_stage": "GA" + }, + "run_duration": { + "description": "Duration of the task run, in milliseconds.", + "launch_stage": "GA" + }, + "start_time": { + "description": "When the task run started, in epoch milliseconds.", + "launch_stage": "GA" + } + } + }, + "cleanrooms.CleanRoomOutputCatalog": { + "fields": { + "catalog_name": { + "description": "The name of the output catalog in UC.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).\nThe field will always exist if status is CREATED.", + "launch_stage": "GA" + }, + "status": { + "ref": "cleanrooms.CleanRoomOutputCatalogOutputCatalogStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "cleanrooms.CleanRoomOutputCatalogOutputCatalogStatus": { + "enum": [ + "NOT_ELIGIBLE", + "NOT_CREATED", + "CREATED" + ], + "enum_launch_stages": { + "CREATED": "GA", + "NOT_CREATED": "GA", + "NOT_ELIGIBLE": "GA" + } + }, + "cleanrooms.CleanRoomRemoteDetail": { + "description": "Publicly visible central clean room details.", + "fields": { + "central_clean_room_id": { + "description": "Central clean room ID.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "cloud_vendor": { + "description": "Cloud vendor (aws,azure,gcp) of the central clean room.", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "collaborators": { + "description": "Collaborators in the central clean room. There should one and only one collaborator\nin the list that satisfies the owner condition:\n\n1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom).\n\n2. Its invite_recipient_email is empty.", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "compliance_security_profile": { + "ref": "cleanrooms.ComplianceSecurityProfile", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "Collaborator who creates the clean room.", + "ref": "cleanrooms.CleanRoomCollaborator", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "egress_network_policy": { + "description": "Egress network policy to apply to the central clean room workspace.", + "ref": "settings.EgressNetworkPolicy", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "region": { + "description": "Region of the central clean room.", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + } + } + }, + "cleanrooms.CleanRoomStatusEnum": { + "enum": [ + "ACTIVE", + "PROVISIONING", + "DELETED", + "FAILED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "DELETED": "GA", + "FAILED": "GA", + "PROVISIONING": "GA" + } + }, + "cleanrooms.CollaboratorJobRunInfo": { + "fields": { + "collaborator_alias": { + "description": "Alias of the collaborator that triggered the task run.", + "launch_stage": "GA" + }, + "collaborator_job_id": { + "description": "Job ID of the task run in the collaborator's workspace.", + "launch_stage": "GA" + }, + "collaborator_job_run_id": { + "description": "Job run ID of the task run in the collaborator's workspace.", + "launch_stage": "GA" + }, + "collaborator_task_run_id": { + "description": "Task run ID of the task run in the collaborator's workspace.", + "launch_stage": "GA" + }, + "collaborator_workspace_id": { + "description": "ID of the collaborator's workspace that triggered the task run.", + "launch_stage": "GA" + } + } + }, + "cleanrooms.ComplianceSecurityProfile": { + "description": "The compliance security profile used to process regulated data following compliance standards.", + "fields": { + "compliance_standards": { + "description": "The list of compliance standards that the compliance security profile is configured to enforce.", + "launch_stage": "GA" + }, + "is_enabled": { + "description": "Whether the compliance security profile is enabled.", + "launch_stage": "GA" + } + } + }, + "cleanrooms.CreateCleanRoomAssetReviewRequest": { + "fields": { + "notebook_review": { + "ref": "cleanrooms.NotebookVersionReview", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.CreateCleanRoomAssetReviewResponse": { + "fields": { + "notebook_review_state": { + "description": "Top-level status derived from all reviews", + "ref": "cleanrooms.CleanRoomNotebookReviewNotebookReviewState", + "launch_stage": "PUBLIC_BETA" + }, + "notebook_reviews": { + "description": "All existing notebook approvals or rejections", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.CreateCleanRoomAutoApprovalRuleRequest": { + "fields": { + "auto_approval_rule": { + "ref": "cleanrooms.CleanRoomAutoApprovalRule", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.CreateCleanRoomOutputCatalogResponse": { + "fields": { + "output_catalog": { + "ref": "cleanrooms.CleanRoomOutputCatalog", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "cleanrooms.DeleteCleanRoomAssetResponse": { + "description": "Response for delete clean room request. Using an empty message since the generic Empty proto does not externd\nUnshadedMessageMarker." + }, + "cleanrooms.ListCleanRoomAssetRevisionsResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + }, + "revisions": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.ListCleanRoomAssetsResponse": { + "fields": { + "assets": { + "description": "Assets in the clean room.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\npage_token should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "cleanrooms.ListCleanRoomAutoApprovalRulesResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\npage_token should be set to this value for the next request (for the next page of results).", + "launch_stage": "PUBLIC_BETA" + }, + "rules": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.ListCleanRoomNotebookTaskRunsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\npage_token should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "runs": { + "description": "Name of the clean room.", + "launch_stage": "GA" + } + } + }, + "cleanrooms.ListCleanRoomsResponse": { + "fields": { + "clean_rooms": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\npage_token should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + } + } + }, + "cleanrooms.NotebookVersionReview": { + "fields": { + "comment": { + "description": "Review comment", + "launch_stage": "PUBLIC_BETA" + }, + "etag": { + "description": "Etag identifying the notebook version", + "launch_stage": "PUBLIC_BETA" + }, + "review_state": { + "description": "Review outcome", + "ref": "cleanrooms.CleanRoomNotebookReviewNotebookReviewState", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "cleanrooms.UpdateCleanRoomRequest": { + "fields": { + "clean_room": { + "ref": "cleanrooms.CleanRoom", + "launch_stage": "GA" + } + } + }, + "compute.AddInstanceProfile": { + "fields": { + "iam_role_arn": { + "description": "The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "launch_stage": "GA" + }, + "is_meta_instance_profile": { + "description": "Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.", + "launch_stage": "GA" + }, + "skip_validation": { + "description": "By default, Databricks validates that it has sufficient permissions to launch\ninstances with the instance profile. This validation uses AWS dry-run mode for\nthe RunInstances API. If validation fails with an error message that does not\nindicate an IAM related permission issue,\n(e.g. “Your requested instance type is not supported in your requested availability zone”),\nyou can pass this flag to skip the validation and forcibly add the instance profile.", + "launch_stage": "GA" + } + } + }, + "compute.AddResponse": {}, + "compute.Adlsgen2Info": { + "description": "A storage location in Adls Gen2", + "fields": { + "destination": { + "description": "abfss destination, e.g. `abfss://\u003ccontainer-name\u003e@\u003cstorage-account-name\u003e.dfs.core.windows.net/\u003cdirectory-name\u003e`.", + "launch_stage": "GA" + } + } + }, + "compute.AutoScale": { + "fields": { + "max_workers": { + "description": "The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`.", + "launch_stage": "GA" + }, + "min_workers": { + "description": "The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation.", + "launch_stage": "GA" + } + } + }, + "compute.AwsAttributes": { + "description": "Attributes set during cluster creation which are related to Amazon Web Services.", + "fields": { + "availability": { + "ref": "compute.AwsAvailability", + "launch_stage": "GA" + }, + "ebs_volume_count": { + "description": "The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden.", + "launch_stage": "GA" + }, + "ebs_volume_iops": { + "description": "If using gp3 volumes, what IOPS to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.", + "launch_stage": "GA" + }, + "ebs_volume_size": { + "description": "The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096.", + "launch_stage": "GA" + }, + "ebs_volume_throughput": { + "description": "If using gp3 volumes, what throughput to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.", + "launch_stage": "GA" + }, + "ebs_volume_type": { + "description": "The type of EBS volumes that will be launched with this cluster.", + "ref": "compute.EbsVolumeType", + "launch_stage": "GA" + }, + "first_on_demand": { + "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.", + "launch_stage": "GA" + }, + "spot_bid_price_percent": { + "description": "The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.", + "launch_stage": "GA" + }, + "zone_id": { + "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, the zone \"auto\" will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\n\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method.", + "launch_stage": "GA" + } + } + }, + "compute.AwsAvailability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", + "enum": [ + "SPOT", + "ON_DEMAND", + "SPOT_WITH_FALLBACK" + ], + "enum_launch_stages": { + "ON_DEMAND": "GA", + "SPOT": "GA", + "SPOT_WITH_FALLBACK": "GA" + } + }, + "compute.AzureAttributes": { + "description": "Attributes set during cluster creation which are related to Microsoft Azure.", + "fields": { + "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero, this availability\ntype will be used for the entire cluster.", + "ref": "compute.AzureAvailability", + "launch_stage": "GA" + }, + "first_on_demand": { + "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", + "launch_stage": "GA" + }, + "log_analytics_info": { + "description": "Defines values necessary to configure and run Azure Log Analytics agent", + "ref": "compute.LogAnalyticsInfo", + "launch_stage": "GA" + }, + "spot_bid_max_price": { + "description": "The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1.", + "launch_stage": "GA" + } + } + }, + "compute.AzureAvailability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", + "enum": [ + "SPOT_AZURE", + "ON_DEMAND_AZURE", + "SPOT_WITH_FALLBACK_AZURE" + ], + "enum_launch_stages": { + "ON_DEMAND_AZURE": "GA", + "SPOT_AZURE": "GA", + "SPOT_WITH_FALLBACK_AZURE": "GA" + } + }, + "compute.CancelCommand": { + "fields": { + "clusterId": { + "launch_stage": "GA" + }, + "commandId": { + "launch_stage": "GA" + }, + "contextId": { + "launch_stage": "GA" + } + } + }, + "compute.CancelResponse": {}, + "compute.ChangeClusterOwner": { + "fields": { + "cluster_id": { + "launch_stage": "GA" + }, + "owner_username": { + "description": "New owner of the cluster_id after this RPC.", + "launch_stage": "GA" + } + } + }, + "compute.ChangeClusterOwnerResponse": {}, + "compute.ClientsTypes": { + "fields": { + "jobs": { + "description": "With jobs set, the cluster can be used for jobs", + "launch_stage": "GA" + }, + "notebooks": { + "description": "With notebooks set, this cluster can be used for notebooks", + "launch_stage": "GA" + } + } + }, + "compute.CloneCluster": { + "fields": { + "source_cluster_id": { + "description": "The cluster that is being cloned.", + "launch_stage": "GA" + } + } + }, + "compute.CloudProviderNodeInfo": { + "fields": { + "status": { + "description": "Status as reported by the cloud provider", + "launch_stage": "GA" + } + } + }, + "compute.CloudProviderNodeStatus": { + "enum": [ + "NotEnabledOnSubscription", + "NotAvailableInRegion" + ], + "enum_launch_stages": { + "NotAvailableInRegion": "GA", + "NotEnabledOnSubscription": "GA" + } + }, + "compute.ClusterAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.ClusterAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.ClusterAttributes": { + "description": "Common set of attributes set during cluster creation. These attributes cannot be changed\nover the lifetime of a cluster.", + "fields": { + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.ClusterCompliance": { + "fields": { + "cluster_id": { + "description": "Canonical unique identifier for a cluster.", + "launch_stage": "GA" + }, + "is_compliant": { + "description": "Whether this cluster is in compliance with the latest version of its policy.", + "launch_stage": "GA" + }, + "violations": { + "description": "An object containing key-value mappings representing the first 200 policy validation errors.\nThe keys indicate the path where the policy validation error is occurring.\nThe values indicate an error message describing the policy validation error.", + "launch_stage": "GA" + } + } + }, + "compute.ClusterDetails": { + "description": "Describes all of the metadata about a single Spark cluster in Databricks.", + "fields": { + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_cores": { + "description": "Number of CPU cores available for this cluster.\nNote that this can be fractional, e.g. 7.5 cores, since certain node types are configured to\nshare cores between Spark nodes on the same instance.", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "Canonical identifier for the cluster. This id is retained during cluster restarts and resizes,\nwhile each new cluster has a globally unique id.", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_log_status": { + "description": "Cluster log delivery status.", + "ref": "compute.LogSyncStatus", + "launch_stage": "GA" + }, + "cluster_memory_mb": { + "description": "Total amount of cluster memory, in megabytes", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "cluster_source": { + "description": "Determines whether the cluster was created by a user through the UI, created by the Databricks\nJobs Scheduler, or through an API request.", + "ref": "compute.ClusterSource", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "Creator user name.\nThe field won't be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "default_tags": { + "description": "Tags that are added by Databricks regardless of any `custom_tags`, including:\n\n- Vendor: Databricks\n\n- Creator: \u003cusername_of_creator\u003e\n\n- ClusterName: \u003cname_of_cluster\u003e\n\n- ClusterId: \u003cid_of_cluster\u003e\n\n- Name: \u003cDatabricks internal use\u003e", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver": { + "description": "Node on which the Spark driver resides. The driver node contains the Spark master and\nthe Databricks application that manages the per-notebook Spark REPLs.", + "ref": "compute.SparkNode", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "executors": { + "description": "Nodes on which the Spark executors reside.", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "jdbc_port": { + "description": "Port on which Spark JDBC server is listening, in the driver nod. No service will be listeningon\non this port in executor nodes.", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "last_restarted_time": { + "description": "the timestamp that the cluster was started/restarted", + "launch_stage": "GA" + }, + "last_state_loss_time": { + "description": "Time when the cluster driver last lost its state (due to a restart or driver failure).", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_context_id": { + "description": "A canonical SparkContext identifier. This value *does* change when the Spark driver restarts.\nThe pair `(cluster_id, spark_context_id)` is a globally unique identifier over all Spark\ncontexts.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "spec": { + "description": "The spec contains a snapshot of the latest user specified settings that were used to create/edit the cluster.\nNote: not included in the response of the ListClusters API.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "start_time": { + "description": "Time (in epoch milliseconds) when the cluster creation request was received (when the cluster\nentered a `PENDING` state).", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the cluster.", + "ref": "compute.State", + "launch_stage": "GA" + }, + "state_message": { + "description": "A message associated with the most recent state transition (e.g., the reason why\nthe cluster entered a `TERMINATED` state).", + "launch_stage": "GA" + }, + "terminated_time": { + "description": "Time (in epoch milliseconds) when the cluster was terminated, if applicable.", + "launch_stage": "GA" + }, + "termination_reason": { + "description": "Information about why the cluster was terminated.\nThis field only appears when the cluster is in a `TERMINATING` or `TERMINATED` state.", + "ref": "compute.TerminationReason", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.ClusterEvent": { + "fields": { + "cluster_id": { + "launch_stage": "GA" + }, + "data_plane_event_details": { + "ref": "compute.DataPlaneEventDetails", + "launch_stage": "GA" + }, + "details": { + "ref": "compute.EventDetails", + "launch_stage": "GA" + }, + "timestamp": { + "description": "The timestamp when the event occurred, stored as the number of milliseconds since\nthe Unix epoch. If not provided, this will be assigned by the Timeline service.", + "launch_stage": "GA" + }, + "type": { + "ref": "compute.EventType", + "launch_stage": "GA" + } + } + }, + "compute.ClusterLibraryStatuses": { + "fields": { + "cluster_id": { + "description": "Unique identifier for the cluster.", + "launch_stage": "GA" + }, + "library_statuses": { + "description": "Status of all libraries on the cluster.", + "launch_stage": "GA" + } + } + }, + "compute.ClusterLogConf": { + "description": "Cluster log delivery config", + "fields": { + "dbfs": { + "description": "destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`", + "ref": "compute.DbfsStorageInfo", + "launch_stage": "GA" + }, + "s3": { + "description": "destination and either the region or endpoint need to be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.", + "ref": "compute.S3StorageInfo", + "launch_stage": "GA" + }, + "volumes": { + "description": "destination needs to be provided, e.g.\n`{ \"volumes\": { \"destination\": \"/Volumes/catalog/schema/volume/cluster_log\" } }`", + "ref": "compute.VolumesStorageInfo", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_RESTART", + "CAN_ATTACH_TO" + ] + }, + "compute.ClusterPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "compute.ClusterPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPolicyPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPolicyPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_USE" + ] + }, + "compute.ClusterPolicyPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.ClusterPolicyPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.ClusterPolicyPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "compute.ClusterSettingsChange": { + "description": "Represents a change to the cluster settings required for the cluster\nto become compliant with its policy.", + "fields": { + "field": { + "description": "The field where this change would be made.", + "launch_stage": "GA" + }, + "new_value": { + "description": "The new value of this field after enforcing policy compliance\n(either a number, a boolean, or a string) converted to a string.\nThis is intended to be read by a human. The typed new value of this field\ncan be retrieved by reading the settings field in the API response.", + "launch_stage": "GA" + }, + "previous_value": { + "description": "The previous value of this field before enforcing policy compliance\n(either a number, a boolean, or a string) converted to a string.\nThis is intended to be read by a human. The type of the field\ncan be retrieved by reading the settings field in the API response.", + "launch_stage": "GA" + } + } + }, + "compute.ClusterSize": { + "fields": { + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + } + } + }, + "compute.ClusterSource": { + "description": "Determines whether the cluster was created by a user through the UI, created by the Databricks\nJobs Scheduler, or through an API request.\nThis is the same as cluster_creator, but read only.", + "enum": [ + "UI", + "JOB", + "API", + "SQL", + "MODELS", + "PIPELINE", + "PIPELINE_MAINTENANCE" + ], + "enum_launch_stages": { + "API": "GA", + "JOB": "GA", + "MODELS": "GA", + "PIPELINE": "GA", + "PIPELINE_MAINTENANCE": "GA", + "SQL": "GA", + "UI": "GA" + } + }, + "compute.ClusterSpec": { + "description": "Contains a snapshot of the latest user specified settings that were used to create/edit the cluster.", + "fields": { + "apply_policy_default_values": { + "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.", + "launch_stage": "GA" + }, + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.Command": { + "fields": { + "clusterId": { + "description": "Running cluster id", + "launch_stage": "GA" + }, + "command": { + "description": "Executable code", + "launch_stage": "GA" + }, + "contextId": { + "description": "Running context id", + "launch_stage": "GA" + }, + "language": { + "ref": "compute.Language", + "launch_stage": "GA" + } + } + }, + "compute.CommandStatus": { + "enum": [ + "Cancelled", + "Cancelling", + "Error", + "Finished", + "Queued", + "Running" + ], + "enum_launch_stages": { + "Cancelled": "GA", + "Cancelling": "GA", + "Error": "GA", + "Finished": "GA", + "Queued": "GA", + "Running": "GA" + } + }, + "compute.CommandStatusResponse": { + "fields": { + "id": { + "launch_stage": "GA" + }, + "results": { + "ref": "compute.Results", + "launch_stage": "GA" + }, + "status": { + "ref": "compute.CommandStatus", + "launch_stage": "GA" + } + } + }, + "compute.ConfidentialComputeType": { + "description": "Confidential computing technology for GCP instances.\nAligns with gcloud's --confidential-compute-type flag and the REST API's\nconfidentialInstanceConfig.confidentialInstanceType field.\nSee: https://cloud.google.com/confidential-computing/confidential-vm/docs/create-a-confidential-vm-instance", + "enum": [ + "CONFIDENTIAL_COMPUTE_TYPE_NONE", + "SEV_SNP" + ], + "enum_launch_stages": { + "CONFIDENTIAL_COMPUTE_TYPE_NONE": "PRIVATE_PREVIEW", + "SEV_SNP": "PRIVATE_PREVIEW" + } + }, + "compute.ContextStatus": { + "enum": [ + "Running", + "Pending", + "Error" + ], + "enum_launch_stages": { + "Error": "GA", + "Pending": "GA", + "Running": "GA" + } + }, + "compute.ContextStatusResponse": { + "fields": { + "id": { + "launch_stage": "GA" + }, + "status": { + "ref": "compute.ContextStatus", + "launch_stage": "GA" + } + } + }, + "compute.CreateCluster": { + "fields": { + "apply_policy_default_values": { + "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted.\nWhen set to false, only fixed values from the policy will be applied.", + "launch_stage": "GA" + }, + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "clone_from": { + "description": "When specified, this clones libraries from a source cluster during the creation of a new cluster.", + "ref": "compute.CloneCluster", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.CreateClusterResponse": { + "fields": { + "cluster_id": { + "launch_stage": "GA" + } + } + }, + "compute.CreateContext": { + "fields": { + "clusterId": { + "description": "Running cluster id", + "launch_stage": "GA" + }, + "language": { + "ref": "compute.Language", + "launch_stage": "GA" + } + } + }, + "compute.CreateInstancePool": { + "fields": { + "aws_attributes": { + "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAzureAttributes", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "launch_stage": "GA" + }, + "disk_spec": { + "description": "Defines the specification of the disks that will be attached to all spark containers.", + "ref": "compute.DiskSpec", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolGcpAttributes", + "launch_stage": "GA" + }, + "idle_instance_autotermination_minutes": { + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "launch_stage": "GA" + }, + "instance_pool_name": { + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "max_capacity": { + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "launch_stage": "GA" + }, + "min_idle_instances": { + "description": "Minimum number of idle instances to keep in the instance pool", + "launch_stage": "GA" + }, + "node_type_flexibility": { + "description": "Flexible node type configuration for the pool.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "preloaded_docker_images": { + "description": "Custom Docker Image BYOC", + "launch_stage": "GA" + }, + "preloaded_spark_versions": { + "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + } + } + }, + "compute.CreateInstancePoolResponse": { + "fields": { + "instance_pool_id": { + "description": "The ID of the created instance pool.", + "launch_stage": "GA" + } + } + }, + "compute.CreatePolicy": { + "fields": { + "definition": { + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "launch_stage": "GA" + }, + "description": { + "description": "Additional human-readable description of the cluster policy.", + "launch_stage": "GA" + }, + "libraries": { + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "launch_stage": "GA" + }, + "max_clusters_per_user": { + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "launch_stage": "GA" + }, + "name": { + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "policy_family_definition_overrides": { + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "launch_stage": "GA" + }, + "policy_family_id": { + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "launch_stage": "GA" + } + } + }, + "compute.CreatePolicyResponse": { + "fields": { + "policy_id": { + "description": "Canonical unique identifier for the cluster policy.", + "launch_stage": "GA" + } + } + }, + "compute.CreateResponse": { + "fields": { + "script_id": { + "description": "The global init script ID.", + "launch_stage": "GA" + } + } + }, + "compute.Created": { + "fields": { + "id": { + "launch_stage": "GA" + } + } + }, + "compute.CustomPolicyTag": { + "fields": { + "key": { + "description": "The key of the tag.\n- Must be unique among all custom tags of the same policy\n- Cannot be “budget-policy-name”, “budget-policy-id” or \"budget-policy-resolution-result\" -\nthese tags are preserved.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "value": { + "description": "The value of the tag.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "compute.DataPlaneEventDetails": { + "fields": { + "event_type": { + "ref": "compute.DataPlaneEventDetailsEventType", + "launch_stage": "GA" + }, + "executor_failures": { + "launch_stage": "GA" + }, + "host_id": { + "launch_stage": "GA" + }, + "timestamp": { + "launch_stage": "GA" + } + } + }, + "compute.DataPlaneEventDetailsEventType": { + "enum": [ + "NODE_BLACKLISTED", + "NODE_EXCLUDED_DECOMMISSIONED" + ], + "enum_launch_stages": { + "NODE_BLACKLISTED": "GA", + "NODE_EXCLUDED_DECOMMISSIONED": "GA" + } + }, + "compute.DataSecurityMode": { + "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", + "USER_ISOLATION", + "LEGACY_TABLE_ACL", + "LEGACY_PASSTHROUGH", + "LEGACY_SINGLE_USER", + "LEGACY_SINGLE_USER_STANDARD", + "DATA_SECURITY_MODE_STANDARD", + "DATA_SECURITY_MODE_DEDICATED", + "DATA_SECURITY_MODE_AUTO" + ], + "enum_launch_stages": { + "DATA_SECURITY_MODE_AUTO": "GA", + "DATA_SECURITY_MODE_DEDICATED": "GA", + "DATA_SECURITY_MODE_STANDARD": "GA", + "LEGACY_PASSTHROUGH": "GA", + "LEGACY_SINGLE_USER": "GA", + "LEGACY_SINGLE_USER_STANDARD": "GA", + "LEGACY_TABLE_ACL": "GA", + "NONE": "GA", + "SINGLE_USER": "GA", + "USER_ISOLATION": "GA" + }, + "enum_descriptions": { + "DATA_SECURITY_MODE_AUTO": "\u003cDatabricks\u003e 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`." + } + }, + "compute.DbfsStorageInfo": { + "description": "A storage location in DBFS", + "fields": { + "destination": { + "description": "dbfs destination, e.g. `dbfs:/my/path`", + "launch_stage": "GA" + } + } + }, + "compute.DeleteCluster": { + "fields": { + "cluster_id": { + "description": "The cluster to be terminated.", + "launch_stage": "GA" + } + } + }, + "compute.DeleteClusterResponse": {}, + "compute.DeleteInstancePool": { + "fields": { + "instance_pool_id": { + "description": "The instance pool to be terminated.", + "launch_stage": "GA" + } + } + }, + "compute.DeleteInstancePoolResponse": {}, + "compute.DeletePolicy": { + "fields": { + "policy_id": { + "description": "The ID of the policy to delete.", + "launch_stage": "GA" + } + } + }, + "compute.DeletePolicyResponse": {}, + "compute.DeleteResponse": {}, + "compute.DestroyContext": { + "fields": { + "clusterId": { + "launch_stage": "GA" + }, + "contextId": { + "launch_stage": "GA" + } + } + }, + "compute.DestroyResponse": {}, + "compute.DiskSpec": { + "description": "Describes the disks that are launched for each instance in the spark cluster.\nFor example, if the cluster has 3 instances, each instance is configured to launch\n2 disks, 100 GiB each, then Databricks will launch a total of 6 disks,\n100 GiB each, for this cluster.", + "fields": { + "disk_count": { + "description": "The number of disks launched for each instance:\n- This feature is only enabled for supported node types.\n- Users can choose up to the limit of the disks supported by the node type.\n- For node types with no OS disk, at least one disk must be specified;\notherwise, cluster creation will fail.\n\nIf disks are attached, Databricks will configure Spark to use only the disks for\nscratch storage, because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no disks are attached, Databricks will configure Spark to use\ninstance store disks.\n\nNote: If disks are specified, then the Spark configuration\n`spark.local.dir` will be overridden.\n\nDisks will be mounted at:\n- For AWS: `/ebs0`, `/ebs1`, and etc.\n- For Azure: `/remote_volume0`, `/remote_volume1`, and etc.", + "launch_stage": "GA" + }, + "disk_iops": { + "launch_stage": "GA" + }, + "disk_size": { + "description": "The size of each disk (in GiB) launched for each instance.\nValues must fall into the supported range for a particular instance type.\n\nFor AWS:\n- General Purpose SSD: 100 - 4096 GiB\n- Throughput Optimized HDD: 500 - 4096 GiB\n\nFor Azure:\n- Premium LRS (SSD): 1 - 1023 GiB\n- Standard LRS (HDD): 1- 1023 GiB", + "launch_stage": "GA" + }, + "disk_throughput": { + "launch_stage": "GA" + }, + "disk_type": { + "description": "The type of disks that will be launched with this cluster.", + "ref": "compute.DiskType", + "launch_stage": "GA" + } + } + }, + "compute.DiskType": { + "description": "Describes the disk type.", + "fields": { + "azure_disk_volume_type": { + "ref": "compute.DiskTypeAzureDiskVolumeType", + "launch_stage": "GA" + }, + "ebs_volume_type": { + "ref": "compute.DiskTypeEbsVolumeType", + "launch_stage": "GA" + } + } + }, + "compute.DiskTypeAzureDiskVolumeType": { + "description": "All Azure Disk types that Databricks supports.\nSee https://docs.microsoft.com/en-us/azure/storage/storage-about-disks-and-vhds-linux#types-of-disks", + "enum": [ + "PREMIUM_LRS", + "STANDARD_LRS" + ], + "enum_launch_stages": { + "PREMIUM_LRS": "GA", + "STANDARD_LRS": "GA" + } + }, + "compute.DiskTypeEbsVolumeType": { + "description": "All EBS volume types that Databricks supports.\nSee https://aws.amazon.com/ebs/details/ for details.", + "enum": [ + "GENERAL_PURPOSE_SSD", + "THROUGHPUT_OPTIMIZED_HDD" + ], + "enum_launch_stages": { + "GENERAL_PURPOSE_SSD": "GA", + "THROUGHPUT_OPTIMIZED_HDD": "GA" + } + }, + "compute.DockerBasicAuth": { + "fields": { + "password": { + "description": "Password of the user", + "launch_stage": "GA" + }, + "username": { + "description": "Name of the user", + "launch_stage": "GA" + } + } + }, + "compute.DockerImage": { + "fields": { + "basic_auth": { + "description": "Basic auth with username and password", + "ref": "compute.DockerBasicAuth", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the docker image.", + "launch_stage": "GA" + } + } + }, + "compute.EbsVolumeType": { + "description": "All EBS volume types that Databricks supports.\nSee https://aws.amazon.com/ebs/details/ for details.", + "enum": [ + "GENERAL_PURPOSE_SSD", + "THROUGHPUT_OPTIMIZED_HDD" + ], + "enum_launch_stages": { + "GENERAL_PURPOSE_SSD": "GA", + "THROUGHPUT_OPTIMIZED_HDD": "GA" + } + }, + "compute.EditCluster": { + "fields": { + "apply_policy_default_values": { + "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.", + "launch_stage": "GA" + }, + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "ID of the cluster", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.EditClusterResponse": {}, + "compute.EditInstancePool": { + "fields": { + "custom_tags": { + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "launch_stage": "GA" + }, + "idle_instance_autotermination_minutes": { + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "Instance pool ID", + "launch_stage": "GA" + }, + "instance_pool_name": { + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "max_capacity": { + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "launch_stage": "GA" + }, + "min_idle_instances": { + "description": "Minimum number of idle instances to keep in the instance pool", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + } + } + }, + "compute.EditInstancePoolResponse": {}, + "compute.EditPolicy": { + "fields": { + "definition": { + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "launch_stage": "GA" + }, + "description": { + "description": "Additional human-readable description of the cluster policy.", + "launch_stage": "GA" + }, + "libraries": { + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "launch_stage": "GA" + }, + "max_clusters_per_user": { + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "launch_stage": "GA" + }, + "name": { + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "policy_family_definition_overrides": { + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "launch_stage": "GA" + }, + "policy_family_id": { + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the policy to update.", + "launch_stage": "GA" + } + } + }, + "compute.EditPolicyResponse": {}, + "compute.EditResponse": {}, + "compute.EnforceClusterComplianceRequest": { + "fields": { + "cluster_id": { + "description": "The ID of the cluster you want to enforce policy compliance on.", + "launch_stage": "GA" + }, + "validate_only": { + "description": "If set, previews the changes that would be made to a cluster\nto enforce compliance but does not update the cluster.", + "launch_stage": "GA" + } + } + }, + "compute.EnforceClusterComplianceResponse": { + "fields": { + "changes": { + "description": "A list of changes that have been made to the cluster settings for\nthe cluster to become compliant with its policy.", + "launch_stage": "GA" + }, + "has_changes": { + "description": "Whether any changes have been made to the cluster settings for the cluster\nto become compliant with its policy.", + "launch_stage": "GA" + } + } + }, + "compute.Environment": { + "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.", + "fields": { + "base_environment": { + "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided.\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.\nFor more information, see", + "launch_stage": "GA" + }, + "client": { + "description": "Use `environment_version` instead.", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "dependencies": { + "description": "List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a valid pip requirements file line per https://pip.pypa.io/en/stable/reference/requirements-file-format/.\nAllowed dependencies include a requirement specifier, an archive URL, a local project path (such as WSFS or UC Volumes in Databricks), or a VCS project URL.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "environment_version": { + "description": "Either `environment_version` or `base_environment` needs to be provided. Environment version used by the environment.\nEach version comes with a specific Python version and a set of Python packages.\nThe version is a string, consisting of an integer.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "java_dependencies": { + "description": "List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "compute.EventDetails": { + "fields": { + "attributes": { + "description": "* For created clusters, the attributes of the cluster.\n* For edited clusters, the new attributes of the cluster.", + "ref": "compute.ClusterAttributes", + "launch_stage": "GA" + }, + "cause": { + "description": "The cause of a change in target size.", + "ref": "compute.EventDetailsCause", + "launch_stage": "GA" + }, + "cluster_size": { + "description": "The actual cluster size that was set in the cluster creation or edit.", + "ref": "compute.ClusterSize", + "launch_stage": "GA" + }, + "current_num_vcpus": { + "description": "The current number of vCPUs in the cluster.", + "launch_stage": "GA" + }, + "current_num_workers": { + "description": "The current number of nodes in the cluster.", + "launch_stage": "GA" + }, + "did_not_expand_reason": { + "launch_stage": "GA" + }, + "disk_size": { + "description": "Current disk size in bytes", + "launch_stage": "GA" + }, + "driver_state_message": { + "description": "More details about the change in driver's state", + "launch_stage": "GA" + }, + "enable_termination_for_node_blocklisted": { + "description": "Whether or not a blocklisted node should be terminated. For ClusterEventType NODE_BLACKLISTED.", + "launch_stage": "GA" + }, + "free_space": { + "launch_stage": "GA" + }, + "init_scripts": { + "description": "List of global and cluster init scripts associated with this cluster event.", + "ref": "compute.InitScriptEventDetails", + "launch_stage": "GA" + }, + "instance_id": { + "description": "Instance Id where the event originated from", + "launch_stage": "GA" + }, + "job_run_name": { + "description": "Unique identifier of the specific job run associated with this cluster event\n* For clusters created for jobs, this will be the same as the cluster name", + "launch_stage": "GA" + }, + "previous_attributes": { + "description": "The cluster attributes before a cluster was edited.", + "ref": "compute.ClusterAttributes", + "launch_stage": "GA" + }, + "previous_cluster_size": { + "description": "The size of the cluster before an edit or resize.", + "ref": "compute.ClusterSize", + "launch_stage": "GA" + }, + "previous_disk_size": { + "description": "Previous disk size in bytes", + "launch_stage": "GA" + }, + "reason": { + "description": "A termination reason:\n* On a TERMINATED event, this is the reason of the termination.\n* On a RESIZE_COMPLETE event, this indicates the reason that we failed to acquire some nodes.", + "ref": "compute.TerminationReason", + "launch_stage": "GA" + }, + "target_num_vcpus": { + "description": "The targeted number of vCPUs in the cluster.", + "launch_stage": "GA" + }, + "target_num_workers": { + "description": "The targeted number of nodes in the cluster.", + "launch_stage": "GA" + }, + "user": { + "description": "The user that caused the event to occur. (Empty if it was done by the control plane.)", + "launch_stage": "GA" + } + } + }, + "compute.EventDetailsCause": { + "description": "The cause of a change in target size.", + "enum": [ + "AUTOSCALE", + "USER_REQUEST", + "AUTORECOVERY", + "REPLACE_BAD_NODES", + "AUTOSCALE_V2", + "DBR_AUTOSCALE" + ], + "enum_launch_stages": { + "AUTORECOVERY": "GA", + "AUTOSCALE": "GA", + "AUTOSCALE_V2": "GA", + "DBR_AUTOSCALE": "GA", + "REPLACE_BAD_NODES": "GA", + "USER_REQUEST": "GA" + } + }, + "compute.EventType": { + "enum": [ + "CREATING", + "STARTING", + "RESTARTING", + "TERMINATING", + "EDITED", + "RUNNING", + "RESIZING", + "NODES_LOST", + "UPSIZE_COMPLETED", + "INIT_SCRIPTS_STARTED", + "INIT_SCRIPTS_FINISHED", + "DID_NOT_EXPAND_DISK", + "EXPANDED_DISK", + "FAILED_TO_EXPAND_DISK", + "DRIVER_HEALTHY", + "DRIVER_NOT_RESPONDING", + "DRIVER_UNAVAILABLE", + "SPARK_EXCEPTION", + "METASTORE_DOWN", + "DBFS_DOWN", + "AUTOSCALING_STATS_REPORT", + "NODE_BLACKLISTED", + "PINNED", + "UNPINNED", + "NODE_EXCLUDED_DECOMMISSIONED", + "ADD_NODES_FAILED", + "AUTOSCALING_BACKOFF", + "AUTOMATIC_CLUSTER_UPDATE", + "AUTOSCALING_FAILED", + "CLUSTER_MIGRATED", + "DECOMMISSION_STARTED", + "DECOMMISSION_ENDED", + "UC_VOLUME_MISCONFIGURED" + ], + "enum_launch_stages": { + "ADD_NODES_FAILED": "GA", + "AUTOMATIC_CLUSTER_UPDATE": "GA", + "AUTOSCALING_BACKOFF": "GA", + "AUTOSCALING_FAILED": "GA", + "AUTOSCALING_STATS_REPORT": "GA", + "CLUSTER_MIGRATED": "GA", + "CREATING": "GA", + "DBFS_DOWN": "GA", + "DECOMMISSION_ENDED": "GA", + "DECOMMISSION_STARTED": "GA", + "DID_NOT_EXPAND_DISK": "GA", + "DRIVER_HEALTHY": "GA", + "DRIVER_NOT_RESPONDING": "GA", + "DRIVER_UNAVAILABLE": "GA", + "EDITED": "GA", + "EXPANDED_DISK": "GA", + "FAILED_TO_EXPAND_DISK": "GA", + "INIT_SCRIPTS_FINISHED": "GA", + "INIT_SCRIPTS_STARTED": "GA", + "METASTORE_DOWN": "GA", + "NODES_LOST": "GA", + "NODE_BLACKLISTED": "GA", + "NODE_EXCLUDED_DECOMMISSIONED": "GA", + "PINNED": "GA", + "RESIZING": "GA", + "RESTARTING": "GA", + "RUNNING": "GA", + "SPARK_EXCEPTION": "GA", + "STARTING": "GA", + "TERMINATING": "GA", + "UC_VOLUME_MISCONFIGURED": "GA", + "UNPINNED": "GA", + "UPSIZE_COMPLETED": "GA" + } + }, + "compute.GcpAttributes": { + "description": "Attributes set during cluster creation which are related to GCP.", + "fields": { + "availability": { + "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", + "ref": "compute.GcpAvailability", + "launch_stage": "GA" + }, + "boot_disk_size": { + "description": "Boot disk size in GB", + "launch_stage": "GA" + }, + "confidential_compute_type": { + "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", + "ref": "compute.ConfidentialComputeType", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "first_on_demand": { + "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", + "launch_stage": "GA" + }, + "google_service_account": { + "description": "If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator.", + "launch_stage": "GA" + }, + "local_ssd_count": { + "description": "If provided, each node (workers and driver) in the cluster will have this number of local SSDs attached.\nEach local SSD is 375GB in size.\nRefer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds)\nfor the supported number of local SSDs for each instance type.", + "launch_stage": "GA" + }, + "use_preemptible_executors": { + "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs (when set to true) versus standard compute engine VMs (when set to false; default).\nNote: Soon to be deprecated, use the 'availability' field instead.", + "deprecated": true, + "launch_stage": "GA" + }, + "zone_id": { + "description": "Identifier for the availability zone in which the cluster resides.\nThis can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region [default].\n- \"AUTO\" =\u003e Databricks picks an availability zone to schedule the cluster on.\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from\nhttps://cloud.google.com/compute/docs/regions-zones.", + "launch_stage": "GA" + } + } + }, + "compute.GcpAvailability": { + "description": "This field determines whether the instance pool will contain preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", + "enum": [ + "PREEMPTIBLE_GCP", + "ON_DEMAND_GCP", + "PREEMPTIBLE_WITH_FALLBACK_GCP" + ], + "enum_launch_stages": { + "ON_DEMAND_GCP": "GA", + "PREEMPTIBLE_GCP": "GA", + "PREEMPTIBLE_WITH_FALLBACK_GCP": "GA" + } + }, + "compute.GcsStorageInfo": { + "description": "A storage location in Google Cloud Platform's GCS", + "fields": { + "destination": { + "description": "GCS destination/URI, e.g. `gs://my-bucket/some-prefix`", + "launch_stage": "GA" + } + } + }, + "compute.GetClusterComplianceResponse": { + "fields": { + "is_compliant": { + "description": "Whether the cluster is compliant with its policy or not. Clusters could be out\nof compliance if the policy was updated after the cluster was last edited.", + "launch_stage": "GA" + }, + "violations": { + "description": "An object containing key-value mappings representing the first 200 policy validation errors.\nThe keys indicate the path where the policy validation error is occurring.\nThe values indicate an error message describing the policy validation error.", + "launch_stage": "GA" + } + } + }, + "compute.GetClusterPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "compute.GetClusterPolicyPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "compute.GetEvents": { + "fields": { + "cluster_id": { + "description": "The ID of the cluster to retrieve events about.", + "launch_stage": "GA" + }, + "end_time": { + "description": "The end time in epoch milliseconds.\nIf empty, returns events up to the current time.", + "launch_stage": "GA" + }, + "event_types": { + "description": "An optional set of event types to filter on.\nIf empty, all event types are returned.", + "launch_stage": "GA" + }, + "limit": { + "description": "Deprecated: use page_token in combination with page_size instead.\n\nThe maximum number of events to include in a page of events.\nDefaults to 50, and maximum allowed value is 500.", + "deprecated": true, + "launch_stage": "GA" + }, + "offset": { + "description": "Deprecated: use page_token in combination with page_size instead.\n\nThe offset in the result set. Defaults to 0 (no offset). When an offset is specified\nand the results are requested in descending order, the end_time field is required.", + "deprecated": true, + "launch_stage": "GA" + }, + "order": { + "description": "The order to list events in; either \"ASC\" or \"DESC\". Defaults to \"DESC\".", + "ref": "compute.GetEventsOrder", + "launch_stage": "GA" + }, + "page_size": { + "description": "The maximum number of events to include in a page of events.\nThe server may further constrain the maximum number of results returned in a single page.\nIf the page_size is empty or 0, the server will decide the number of results to be returned.\nThe field has to be in the range [0,500]. If the value is outside the range, the server enforces 0 or 500.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively.\nIf page_token is empty, the first page is returned.", + "launch_stage": "GA" + }, + "start_time": { + "description": "The start time in epoch milliseconds.\nIf empty, returns events starting from the beginning of time.", + "launch_stage": "GA" + } + } + }, + "compute.GetEventsOrder": { + "enum": [ + "DESC", + "ASC" + ], + "enum_launch_stages": { + "ASC": "GA", + "DESC": "GA" + } + }, + "compute.GetEventsResponse": { + "fields": { + "events": { + "launch_stage": "GA" + }, + "next_page": { + "description": "Deprecated: use next_page_token or prev_page_token instead.\n\nThe parameters required to retrieve the next page of events.\nOmitted if there are no more events to read.", + "ref": "compute.GetEvents", + "deprecated": true, + "launch_stage": "GA" + }, + "next_page_token": { + "description": "This field represents the pagination token to retrieve the next page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "This field represents the pagination token to retrieve the previous page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + }, + "total_count": { + "description": "Deprecated: Returns 0 when request uses page_token. Will start returning zero when request uses offset/limit soon.\n\nThe total number of events filtered by the start_time, end_time, and event_types.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "compute.GetInstancePool": { + "fields": { + "aws_attributes": { + "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAzureAttributes", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "launch_stage": "GA" + }, + "default_tags": { + "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- InstancePoolCreator: \u003cuser_id_of_creator\u003e\n\n- InstancePoolName: \u003cname_of_pool\u003e\n\n- InstancePoolId: \u003cid_of_pool\u003e", + "launch_stage": "GA" + }, + "disk_spec": { + "description": "Defines the specification of the disks that will be attached to all spark containers.", + "ref": "compute.DiskSpec", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolGcpAttributes", + "launch_stage": "GA" + }, + "idle_instance_autotermination_minutes": { + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "Canonical unique identifier for the pool.", + "launch_stage": "GA" + }, + "instance_pool_name": { + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "max_capacity": { + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "launch_stage": "GA" + }, + "min_idle_instances": { + "description": "Minimum number of idle instances to keep in the instance pool", + "launch_stage": "GA" + }, + "node_type_flexibility": { + "description": "Flexible node type configuration for the pool.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "preloaded_docker_images": { + "description": "Custom Docker Image BYOC", + "launch_stage": "GA" + }, + "preloaded_spark_versions": { + "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the instance pool.", + "ref": "compute.InstancePoolState", + "launch_stage": "GA" + }, + "stats": { + "description": "Usage statistics about the instance pool.", + "ref": "compute.InstancePoolStats", + "launch_stage": "GA" + }, + "status": { + "description": "Status of failed pending instances in the pool.", + "ref": "compute.InstancePoolStatus", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + } + } + }, + "compute.GetInstancePoolPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "compute.GetSparkVersionsResponse": { + "fields": { + "versions": { + "description": "All the available Spark versions.", + "launch_stage": "GA" + } + } + }, + "compute.GlobalInitScriptCreateRequest": { + "fields": { + "enabled": { + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the script", + "launch_stage": "GA" + }, + "position": { + "description": "The position of a global init script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.\n\nIf you omit the numeric position for a new global init script, it defaults to last position. It will run after all current scripts.\nSetting any value greater than the position of the last script is equivalent to the last position. Example: Take three existing scripts with positions 0, 1, and 2. Any position of (3) or greater puts the script in the last position.\nIf an explicit position value conflicts with an existing script value, your request succeeds, but the original script at that position and all later scripts have their positions incremented by 1.", + "launch_stage": "GA" + }, + "script": { + "description": "The Base64-encoded content of the script.", + "launch_stage": "GA" + } + } + }, + "compute.GlobalInitScriptDetails": { + "fields": { + "created_at": { + "description": "Time when the script was created, represented as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "The username of the user who created the script.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the script", + "launch_stage": "GA" + }, + "position": { + "description": "The position of a script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.", + "launch_stage": "GA" + }, + "script_id": { + "description": "The global init script ID.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time when the script was updated, represented as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "The username of the user who last updated the script", + "launch_stage": "GA" + } + } + }, + "compute.GlobalInitScriptDetailsWithContent": { + "fields": { + "created_at": { + "description": "Time when the script was created, represented as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "The username of the user who created the script.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the script", + "launch_stage": "GA" + }, + "position": { + "description": "The position of a script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.", + "launch_stage": "GA" + }, + "script": { + "description": "The Base64-encoded content of the script.", + "launch_stage": "GA" + }, + "script_id": { + "description": "The global init script ID.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time when the script was updated, represented as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "The username of the user who last updated the script", + "launch_stage": "GA" + } + } + }, + "compute.GlobalInitScriptUpdateRequest": { + "fields": { + "enabled": { + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the script", + "launch_stage": "GA" + }, + "position": { + "description": "The position of a script, where 0 represents the first script to run,\n1 is the second script to run, in ascending order.\nTo move the script to run first, set its position to 0.\n\nTo move the script to the end, set its position to any value\ngreater or equal to the position of the last script.\nExample, three existing scripts with positions 0, 1, and 2.\nAny position value of 2 or greater puts the script in the last position (2).\n\nIf an explicit position value conflicts with an existing script, your request succeeds,\nbut the original script at that position and all later scripts have their positions\nincremented by 1.", + "launch_stage": "GA" + }, + "script": { + "description": "The Base64-encoded content of the script.", + "launch_stage": "GA" + } + } + }, + "compute.HardwareAcceleratorType": { + "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" + ], + "enum_launch_stages": { + "GPU_1xA10": "PUBLIC_BETA", + "GPU_8xH100": "PUBLIC_BETA" + } + }, + "compute.InitScriptEventDetails": { + "fields": { + "cluster": { + "description": "The cluster scoped init scripts associated with this cluster event.", + "launch_stage": "GA" + }, + "global": { + "description": "The global init scripts associated with this cluster event.", + "launch_stage": "GA" + }, + "reported_for_node": { + "description": "The private ip of the node we are reporting init script execution details for\n(we will select the execution details from only one node rather than\nreporting the execution details from every node to keep these event\ndetails small)\n\nThis should only be defined for the INIT_SCRIPTS_FINISHED event", + "launch_stage": "GA" + } + } + }, + "compute.InitScriptExecutionDetailsInitScriptExecutionStatus": { + "description": "Result of attempted script execution", + "enum": [ + "UNKNOWN", + "FAILED_FETCH", + "FAILED_EXECUTION", + "NOT_EXECUTED", + "SKIPPED", + "SUCCEEDED", + "FUSE_MOUNT_FAILED" + ], + "enum_launch_stages": { + "FAILED_EXECUTION": "GA", + "FAILED_FETCH": "GA", + "FUSE_MOUNT_FAILED": "GA", + "NOT_EXECUTED": "GA", + "SKIPPED": "GA", + "SUCCEEDED": "GA", + "UNKNOWN": "GA" + } + }, + "compute.InitScriptInfo": { + "description": "Config for an individual init script\nNext ID: 11", + "fields": { + "abfss": { + "description": "destination needs to be provided, e.g.\n`abfss://\u003ccontainer-name\u003e@\u003cstorage-account-name\u003e.dfs.core.windows.net/\u003cdirectory-name\u003e`", + "ref": "compute.Adlsgen2Info", + "launch_stage": "GA" + }, + "dbfs": { + "description": "destination needs to be provided. e.g.\n`{ \"dbfs\": { \"destination\" : \"dbfs:/home/cluster_log\" } }`", + "ref": "compute.DbfsStorageInfo", + "deprecated": true, + "launch_stage": "GA" + }, + "file": { + "description": "destination needs to be provided, e.g.\n`{ \"file\": { \"destination\": \"file:/my/local/file.sh\" } }`", + "ref": "compute.LocalFileInfo", + "launch_stage": "GA" + }, + "gcs": { + "description": "destination needs to be provided, e.g.\n`{ \"gcs\": { \"destination\": \"gs://my-bucket/file.sh\" } }`", + "ref": "compute.GcsStorageInfo", + "launch_stage": "GA" + }, + "s3": { + "description": "destination and either the region or endpoint need to be provided. e.g.\n`{ \\\"s3\\\": { \\\"destination\\\": \\\"s3://cluster_log_bucket/prefix\\\", \\\"region\\\": \\\"us-west-2\\\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.", + "ref": "compute.S3StorageInfo", + "launch_stage": "GA" + }, + "volumes": { + "description": "destination needs to be provided. e.g.\n`{ \\\"volumes\\\" : { \\\"destination\\\" : \\\"/Volumes/my-init.sh\\\" } }`", + "ref": "compute.VolumesStorageInfo", + "launch_stage": "GA" + }, + "workspace": { + "description": "destination needs to be provided, e.g.\n`{ \"workspace\": { \"destination\": \"/cluster-init-scripts/setup-datadog.sh\" } }`", + "ref": "compute.WorkspaceStorageInfo", + "launch_stage": "GA" + } + } + }, + "compute.InitScriptInfoAndExecutionDetails": { + "fields": { + "abfss": { + "description": "destination needs to be provided, e.g.\n`abfss://\u003ccontainer-name\u003e@\u003cstorage-account-name\u003e.dfs.core.windows.net/\u003cdirectory-name\u003e`", + "ref": "compute.Adlsgen2Info", + "launch_stage": "GA" + }, + "dbfs": { + "description": "destination needs to be provided. e.g.\n`{ \"dbfs\": { \"destination\" : \"dbfs:/home/cluster_log\" } }`", + "ref": "compute.DbfsStorageInfo", + "deprecated": true, + "launch_stage": "GA" + }, + "error_message": { + "description": "Additional details regarding errors (such as a file not found message\nif the status is FAILED_FETCH). This field should only be used to\nprovide *additional* information to the status field, not duplicate it.", + "launch_stage": "GA" + }, + "execution_duration_seconds": { + "description": "The number duration of the script execution in seconds", + "launch_stage": "GA" + }, + "file": { + "description": "destination needs to be provided, e.g.\n`{ \"file\": { \"destination\": \"file:/my/local/file.sh\" } }`", + "ref": "compute.LocalFileInfo", + "launch_stage": "GA" + }, + "gcs": { + "description": "destination needs to be provided, e.g.\n`{ \"gcs\": { \"destination\": \"gs://my-bucket/file.sh\" } }`", + "ref": "compute.GcsStorageInfo", + "launch_stage": "GA" + }, + "s3": { + "description": "destination and either the region or endpoint need to be provided. e.g.\n`{ \\\"s3\\\": { \\\"destination\\\": \\\"s3://cluster_log_bucket/prefix\\\", \\\"region\\\": \\\"us-west-2\\\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.", + "ref": "compute.S3StorageInfo", + "launch_stage": "GA" + }, + "status": { + "description": "The current status of the script", + "ref": "compute.InitScriptExecutionDetailsInitScriptExecutionStatus", + "launch_stage": "GA" + }, + "stderr": { + "description": "The stderr output from the init script execution.\nOnly populated when init scripts debug is enabled and script execution fails.", + "launch_stage": "GA" + }, + "volumes": { + "description": "destination needs to be provided. e.g.\n`{ \\\"volumes\\\" : { \\\"destination\\\" : \\\"/Volumes/my-init.sh\\\" } }`", + "ref": "compute.VolumesStorageInfo", + "launch_stage": "GA" + }, + "workspace": { + "description": "destination needs to be provided, e.g.\n`{ \"workspace\": { \"destination\": \"/cluster-init-scripts/setup-datadog.sh\" } }`", + "ref": "compute.WorkspaceStorageInfo", + "launch_stage": "GA" + } + } + }, + "compute.InstallLibraries": { + "fields": { + "cluster_id": { + "description": "Unique identifier for the cluster on which to install these libraries.", + "launch_stage": "GA" + }, + "libraries": { + "description": "The libraries to install.", + "launch_stage": "GA" + } + } + }, + "compute.InstallLibrariesResponse": {}, + "compute.InstancePoolAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.InstancePoolPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolAndStats": { + "fields": { + "aws_attributes": { + "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolAzureAttributes", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "launch_stage": "GA" + }, + "default_tags": { + "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- InstancePoolCreator: \u003cuser_id_of_creator\u003e\n\n- InstancePoolName: \u003cname_of_pool\u003e\n\n- InstancePoolId: \u003cid_of_pool\u003e", + "launch_stage": "GA" + }, + "disk_spec": { + "description": "Defines the specification of the disks that will be attached to all spark containers.", + "ref": "compute.DiskSpec", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", + "ref": "compute.InstancePoolGcpAttributes", + "launch_stage": "GA" + }, + "idle_instance_autotermination_minutes": { + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "Canonical unique identifier for the pool.", + "launch_stage": "GA" + }, + "instance_pool_name": { + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "max_capacity": { + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "launch_stage": "GA" + }, + "min_idle_instances": { + "description": "Minimum number of idle instances to keep in the instance pool", + "launch_stage": "GA" + }, + "node_type_flexibility": { + "description": "Flexible node type configuration for the pool.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "preloaded_docker_images": { + "description": "Custom Docker Image BYOC", + "launch_stage": "GA" + }, + "preloaded_spark_versions": { + "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the instance pool.", + "ref": "compute.InstancePoolState", + "launch_stage": "GA" + }, + "stats": { + "description": "Usage statistics about the instance pool.", + "ref": "compute.InstancePoolStats", + "launch_stage": "GA" + }, + "status": { + "description": "Status of failed pending instances in the pool.", + "ref": "compute.InstancePoolStatus", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolAwsAttributes": { + "description": "Attributes set during instance pool creation which are related to Amazon Web Services.", + "fields": { + "availability": { + "description": "Availability type used for the spot nodes.", + "ref": "compute.InstancePoolAwsAttributesAvailability", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances\nwill initially be launched with the workspace's default instance profile. If defined, clusters that use the\npool will inherit the instance profile, and must not specify their own instance profile on cluster creation or\nupdate. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.\nThe instance profile must have previously been added to the Databricks environment by an account administrator.\n\nThis feature may only be available to certain customer plans.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "spot_bid_price_percent": { + "description": "Calculates the bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.", + "launch_stage": "GA" + }, + "zone_id": { + "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method.", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolAwsAttributesAvailability": { + "description": "The set of AWS availability types supported when setting up nodes for a cluster.", + "enum": [ + "SPOT", + "ON_DEMAND" + ], + "enum_launch_stages": { + "ON_DEMAND": "GA", + "SPOT": "GA" + } + }, + "compute.InstancePoolAzureAttributes": { + "description": "Attributes set during instance pool creation which are related to Azure.", + "fields": { + "availability": { + "description": "Availability type used for the spot nodes.", + "ref": "compute.InstancePoolAzureAttributesAvailability", + "launch_stage": "GA" + }, + "spot_bid_max_price": { + "description": "With variable pricing, you have option to set a max price, in US dollars (USD)\nFor example, the value 2 would be a max price of $2.00 USD per hour.\nIf you set the max price to be -1, the VM won't be evicted based on price.\nThe price for the VM will be the current price for spot or the price for a standard VM,\nwhich ever is less, as long as there is capacity and quota available.", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolAzureAttributesAvailability": { + "description": "The set of Azure availability types supported when setting up nodes for a cluster.", + "enum": [ + "SPOT_AZURE", + "ON_DEMAND_AZURE" + ], + "enum_launch_stages": { + "ON_DEMAND_AZURE": "GA", + "SPOT_AZURE": "GA" + } + }, + "compute.InstancePoolGcpAttributes": { + "description": "Attributes set during instance pool creation which are related to GCP.", + "fields": { + "gcp_availability": { + "ref": "compute.GcpAvailability", + "launch_stage": "GA" + }, + "local_ssd_count": { + "description": "If provided, each node in the instance pool will have this number of local SSDs attached.\nEach local SSD is 375GB in size. Refer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds)\nfor the supported number of local SSDs for each instance type.", + "launch_stage": "GA" + }, + "zone_id": { + "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west1-a\". The provided availability\nzone must be in the same region as the Databricks workspace. For example, \"us-west1-a\"\nis not a valid zone id if the Databricks workspace resides in the \"us-east1\" region.\nThis is an optional field at instance pool creation, and if not specified, a default zone will be used.\n\nThis field can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. \"us-west1-a\").\n\nIf empty, Databricks picks an availability zone to schedule the cluster on.", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.InstancePoolPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_ATTACH_TO" + ] + }, + "compute.InstancePoolPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "compute.InstancePoolPermissionLevel", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolState": { + "description": "The state of a Cluster. The current allowable state transitions are as follows:\n\n- ``ACTIVE`` -\u003e ``STOPPED``\n- ``ACTIVE`` -\u003e ``DELETED``\n- ``STOPPED`` -\u003e ``ACTIVE``\n- ``STOPPED`` -\u003e ``DELETED``", + "enum": [ + "ACTIVE", + "STOPPED", + "DELETED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "DELETED": "GA", + "STOPPED": "GA" + } + }, + "compute.InstancePoolStats": { + "fields": { + "idle_count": { + "description": "Number of active instances in the pool that are NOT part of a cluster.", + "launch_stage": "GA" + }, + "pending_idle_count": { + "description": "Number of pending instances in the pool that are NOT part of a cluster.", + "launch_stage": "GA" + }, + "pending_used_count": { + "description": "Number of pending instances in the pool that are part of a cluster.", + "launch_stage": "GA" + }, + "used_count": { + "description": "Number of active instances in the pool that are part of a cluster.", + "launch_stage": "GA" + } + } + }, + "compute.InstancePoolStatus": { + "fields": { + "pending_instance_errors": { + "description": "List of error messages for the failed pending instances.\nThe pending_instance_errors follows FIFO with maximum length of the min_idle of the pool.\nThe pending_instance_errors is emptied once the number of exiting available instances reaches\nthe min_idle of the pool.", + "launch_stage": "GA" + } + } + }, + "compute.InstanceProfile": { + "fields": { + "iam_role_arn": { + "description": "The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "launch_stage": "GA" + }, + "is_meta_instance_profile": { + "description": "Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.", + "launch_stage": "GA" + } + } + }, + "compute.Language": { + "enum": [ + "python", + "scala", + "sql", + "r" + ], + "enum_launch_stages": { + "python": "GA", + "r": "GA", + "scala": "GA", + "sql": "GA" + } + }, + "compute.Library": { + "fields": { + "cran": { + "description": "Specification of a CRAN library to be installed as part of the library", + "ref": "compute.RCranLibrary", + "launch_stage": "GA" + }, + "egg": { + "description": "Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.", + "deprecated": true, + "launch_stage": "GA" + }, + "jar": { + "description": "URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"jar\": \"/Workspace/path/to/library.jar\" }`, `{ \"jar\" : \"/Volumes/path/to/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI.", + "launch_stage": "GA" + }, + "maven": { + "description": "Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`", + "ref": "compute.MavenLibrary", + "launch_stage": "GA" + }, + "pypi": { + "description": "Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", + "ref": "compute.PythonPyPiLibrary", + "launch_stage": "GA" + }, + "requirements": { + "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`", + "launch_stage": "GA" + }, + "whl": { + "description": "URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"whl\": \"/Workspace/path/to/library.whl\" }`, `{ \"whl\" : \"/Volumes/path/to/library.whl\" }` or\n`{ \"whl\": \"s3://my-bucket/library.whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI.", + "launch_stage": "GA" + } + } + }, + "compute.LibraryFullStatus": { + "description": "The status of the library on a specific cluster.", + "fields": { + "is_library_for_all_clusters": { + "description": "Whether the library was set to be installed on all clusters via the libraries UI.", + "launch_stage": "GA" + }, + "library": { + "description": "Unique identifier for the library.", + "ref": "compute.Library", + "launch_stage": "GA" + }, + "messages": { + "description": "All the info and warning messages that have occurred so far for this library.", + "launch_stage": "GA" + }, + "status": { + "description": "Status of installing the library on the cluster.", + "ref": "compute.LibraryInstallStatus", + "launch_stage": "GA" + } + } + }, + "compute.LibraryInstallStatus": { + "description": "The status of a library on a specific cluster.", + "enum": [ + "PENDING", + "RESOLVING", + "INSTALLING", + "INSTALLED", + "FAILED", + "UNINSTALL_ON_RESTART", + "SKIPPED", + "RESTORED" + ], + "enum_launch_stages": { + "FAILED": "GA", + "INSTALLED": "GA", + "INSTALLING": "GA", + "PENDING": "GA", + "RESOLVING": "GA", + "RESTORED": "GA", + "SKIPPED": "GA", + "UNINSTALL_ON_RESTART": "GA" + } + }, + "compute.ListAllClusterLibraryStatusesResponse": { + "fields": { + "statuses": { + "description": "A list of cluster statuses.", + "launch_stage": "GA" + } + } + }, + "compute.ListAvailableZonesResponse": { + "fields": { + "default_zone": { + "description": "The availability zone if no ``zone_id`` is provided in the cluster creation request.", + "launch_stage": "GA" + }, + "zones": { + "description": "The list of available zones (e.g., ['us-west-2c', 'us-east-2']).", + "launch_stage": "GA" + } + } + }, + "compute.ListClusterCompliancesResponse": { + "fields": { + "clusters": { + "description": "A list of clusters and their policy compliance statuses.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "This field represents the pagination token to retrieve the next page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "This field represents the pagination token to retrieve the previous page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + } + } + }, + "compute.ListClustersFilterBy": { + "fields": { + "cluster_sources": { + "description": "The source of cluster creation.", + "launch_stage": "GA" + }, + "cluster_states": { + "description": "The current state of the clusters.", + "launch_stage": "GA" + }, + "is_pinned": { + "description": "Whether the clusters are pinned or not.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + } + } + }, + "compute.ListClustersResponse": { + "fields": { + "clusters": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "This field represents the pagination token to retrieve the next page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "This field represents the pagination token to retrieve the previous page of results.\nIf the value is \"\", it means no further results for the request.", + "launch_stage": "GA" + } + } + }, + "compute.ListClustersSortBy": { + "fields": { + "direction": { + "description": "The direction to sort by.", + "ref": "compute.ListClustersSortByDirection", + "launch_stage": "GA" + }, + "field": { + "description": "The sorting criteria. By default, clusters are sorted by 3 columns from highest to lowest precedence: cluster state, pinned or unpinned, then cluster name.", + "ref": "compute.ListClustersSortByField", + "launch_stage": "GA" + } + } + }, + "compute.ListClustersSortByDirection": { + "enum": [ + "ASC", + "DESC" + ], + "enum_launch_stages": { + "ASC": "GA", + "DESC": "GA" + } + }, + "compute.ListClustersSortByField": { + "enum": [ + "DEFAULT", + "CLUSTER_NAME" + ], + "enum_launch_stages": { + "CLUSTER_NAME": "GA", + "DEFAULT": "GA" + } + }, + "compute.ListGlobalInitScriptsResponse": { + "fields": { + "scripts": { + "launch_stage": "GA" + } + } + }, + "compute.ListInstancePools": { + "fields": { + "instance_pools": { + "launch_stage": "GA" + } + } + }, + "compute.ListInstanceProfilesResponse": { + "fields": { + "instance_profiles": { + "description": "A list of instance profiles that the user can access.", + "launch_stage": "GA" + } + } + }, + "compute.ListNodeTypesResponse": { + "fields": { + "node_types": { + "description": "The list of available Spark node types.", + "launch_stage": "GA" + } + } + }, + "compute.ListPoliciesResponse": { + "fields": { + "policies": { + "description": "List of policies.", + "launch_stage": "GA" + } + } + }, + "compute.ListPolicyFamiliesResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "launch_stage": "GA" + }, + "policy_families": { + "description": "List of policy families.", + "launch_stage": "GA" + } + } + }, + "compute.ListSortColumn": { + "enum": [ + "POLICY_CREATION_TIME", + "POLICY_NAME" + ], + "enum_launch_stages": { + "POLICY_CREATION_TIME": "GA", + "POLICY_NAME": "GA" + } + }, + "compute.ListSortOrder": { + "enum": [ + "DESC", + "ASC" + ], + "enum_launch_stages": { + "ASC": "GA", + "DESC": "GA" + } + }, + "compute.LocalFileInfo": { + "fields": { + "destination": { + "description": "local file destination, e.g. `file:/my/local/file.sh`", + "launch_stage": "GA" + } + } + }, + "compute.LogAnalyticsInfo": { + "fields": { + "log_analytics_primary_key": { + "launch_stage": "GA" + }, + "log_analytics_workspace_id": { + "launch_stage": "GA" + } + } + }, + "compute.LogSyncStatus": { + "description": "The log delivery status", + "fields": { + "last_attempted": { + "description": "The timestamp of last attempt. If the last attempt fails, `last_exception` will contain the\nexception in the last attempt.", + "launch_stage": "GA" + }, + "last_exception": { + "description": "The exception thrown in the last attempt, it would be null (omitted in the response) if\nthere is no exception in last attempted.", + "launch_stage": "GA" + } + } + }, + "compute.MapAny": { + "launch_stage": "GA" + }, + "compute.MavenLibrary": { + "fields": { + "coordinates": { + "description": "Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\".", + "launch_stage": "GA" + }, + "exclusions": { + "description": "List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", + "launch_stage": "GA" + }, + "repo": { + "description": "Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched.", + "launch_stage": "GA" + } + } + }, + "compute.NodeInstanceType": { + "description": "This structure embodies the machine type that hosts spark containers\nNote: this should be an internal data structure for now\nIt is defined in proto in case we want to send it over the wire in the future (which is likely)", + "fields": { + "instance_type_id": { + "description": "Unique identifier across instance types", + "launch_stage": "GA" + }, + "local_disk_size_gb": { + "description": "Size of the individual local disks attached to this instance (i.e. per local disk).", + "launch_stage": "GA" + }, + "local_disks": { + "description": "Number of local disks that are present on this instance.", + "launch_stage": "GA" + }, + "local_nvme_disk_size_gb": { + "description": "Size of the individual local nvme disks attached to this instance (i.e. per local disk).", + "launch_stage": "GA" + }, + "local_nvme_disks": { + "description": "Number of local nvme disks that are present on this instance.", + "launch_stage": "GA" + } + } + }, + "compute.NodeType": { + "description": "A description of a Spark node type including both the dimensions of the node and the\ninstance type on which it will be hosted.", + "fields": { + "category": { + "description": "A descriptive category for this node type. Examples include \"Memory Optimized\" and\n\"Compute Optimized\".", + "launch_stage": "GA" + }, + "description": { + "description": "A string description associated with this node type, e.g., \"r3.xlarge\".", + "launch_stage": "GA" + }, + "display_order": { + "description": "An optional hint at the display order of node types in the UI.\nWithin a node type category, lowest numbers come first.", + "launch_stage": "GA" + }, + "instance_type_id": { + "description": "An identifier for the type of hardware that this node runs on, e.g., \"r3.2xlarge\" in AWS.", + "launch_stage": "GA" + }, + "is_deprecated": { + "description": "Whether the node type is deprecated. Non-deprecated node types offer greater performance.", + "launch_stage": "GA" + }, + "is_encrypted_in_transit": { + "description": "AWS specific, whether this instance supports encryption in transit, used for hipaa and pci\nworkloads.", + "launch_stage": "GA" + }, + "is_graviton": { + "description": "Whether this is an Arm-based instance.", + "launch_stage": "GA" + }, + "is_hidden": { + "description": "Whether this node is hidden from presentation in the UI.", + "launch_stage": "GA" + }, + "is_io_cache_enabled": { + "description": "Whether this node comes with IO cache enabled by default.", + "launch_stage": "GA" + }, + "memory_mb": { + "description": "Memory (in MB) available for this node type.", + "launch_stage": "GA" + }, + "node_info": { + "description": "A collection of node type info reported by the cloud provider", + "ref": "compute.CloudProviderNodeInfo", + "launch_stage": "GA" + }, + "node_instance_type": { + "description": "The NodeInstanceType object corresponding to instance_type_id", + "ref": "compute.NodeInstanceType", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "Unique identifier for this node type.", + "launch_stage": "GA" + }, + "num_cores": { + "description": "Number of CPU cores available for this node type.\nNote that this can be fractional, e.g., 2.5 cores, if the the number of cores on a\nmachine instance is not divisible by the number of Spark nodes on that machine.", + "launch_stage": "GA" + }, + "num_gpus": { + "description": "Number of GPUs available for this node type.", + "launch_stage": "GA" + }, + "photon_driver_capable": { + "launch_stage": "GA" + }, + "photon_worker_capable": { + "launch_stage": "GA" + }, + "support_cluster_tags": { + "description": "Whether this node type support cluster tags.", + "launch_stage": "GA" + }, + "support_ebs_volumes": { + "description": "Whether this node type support EBS volumes. EBS volumes is disabled for node types that\nwe could place multiple corresponding containers on the same hosting instance.", + "launch_stage": "GA" + }, + "support_port_forwarding": { + "description": "Whether this node type supports port forwarding.", + "launch_stage": "GA" + } + } + }, + "compute.NodeTypeFlexibility": { + "description": "Configuration for flexible node types, allowing fallback to alternate node types during cluster launch and upscale.", + "fields": { + "alternate_node_type_ids": { + "description": "A list of node type IDs to use as fallbacks when the primary node type is unavailable.", + "launch_stage": "GA" + } + } + }, + "compute.PendingInstanceError": { + "description": "Error message of a failed pending instances", + "fields": { + "instance_id": { + "launch_stage": "GA" + }, + "message": { + "launch_stage": "GA" + } + } + }, + "compute.PermanentDeleteCluster": { + "fields": { + "cluster_id": { + "description": "The cluster to be deleted.", + "launch_stage": "GA" + } + } + }, + "compute.PermanentDeleteClusterResponse": {}, + "compute.PinCluster": { + "fields": { + "cluster_id": { + "launch_stage": "GA" + } + } + }, + "compute.PinClusterResponse": {}, + "compute.Policy": { + "description": "Describes a Cluster Policy entity.", + "fields": { + "created_at_timestamp": { + "description": "Creation time. The timestamp (in millisecond) when this Cluster Policy was created.", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "Creator user name.\nThe field won't be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "definition": { + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "launch_stage": "GA" + }, + "description": { + "description": "Additional human-readable description of the cluster policy.", + "launch_stage": "GA" + }, + "is_default": { + "description": "If true, policy is a default policy created and managed by Databricks.\nDefault policies cannot be deleted, and their policy families cannot be changed.", + "launch_stage": "GA" + }, + "libraries": { + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "launch_stage": "GA" + }, + "max_clusters_per_user": { + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "launch_stage": "GA" + }, + "name": { + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "launch_stage": "GA" + }, + "policy_family_definition_overrides": { + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "launch_stage": "GA" + }, + "policy_family_id": { + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "Canonical unique identifier for the Cluster Policy.", + "launch_stage": "GA" + } + } + }, + "compute.PolicyFamily": { + "fields": { + "definition": { + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "launch_stage": "GA" + }, + "description": { + "description": "Human-readable description of the purpose of the policy family.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the policy family.", + "launch_stage": "GA" + }, + "policy_family_id": { + "description": "Unique identifier for the policy family.", + "launch_stage": "GA" + } + } + }, + "compute.PythonPyPiLibrary": { + "fields": { + "package": { + "description": "The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", + "launch_stage": "GA" + }, + "repo": { + "description": "The repository where the package can be found. If not specified, the default pip index is\nused.", + "launch_stage": "GA" + } + } + }, + "compute.RCranLibrary": { + "fields": { + "package": { + "description": "The name of the CRAN package to install.", + "launch_stage": "GA" + }, + "repo": { + "description": "The repository where the package can be found. If not specified, the default CRAN repo is used.", + "launch_stage": "GA" + } + } + }, + "compute.RemoveInstanceProfile": { + "fields": { + "instance_profile_arn": { + "description": "The ARN of the instance profile to remove. This field is required.", + "launch_stage": "GA" + } + } + }, + "compute.RemoveResponse": {}, + "compute.ResizeCluster": { + "fields": { + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "The cluster to be resized.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + } + } + }, + "compute.ResizeClusterResponse": {}, + "compute.RestartCluster": { + "fields": { + "cluster_id": { + "description": "The cluster to be started.", + "launch_stage": "GA" + }, + "restart_user": { + "launch_stage": "GA" + } + } + }, + "compute.RestartClusterResponse": {}, + "compute.ResultType": { + "enum": [ + "error", + "image", + "images", + "table", + "text" + ], + "enum_launch_stages": { + "error": "GA", + "image": "GA", + "images": "GA", + "table": "GA", + "text": "GA" + } + }, + "compute.Results": { + "fields": { + "cause": { + "description": "The cause of the error", + "launch_stage": "GA" + }, + "data": { + "launch_stage": "GA" + }, + "fileName": { + "description": "The image data in one of the following formats:\n\n1. A Data URL with base64-encoded image data: `data:image/{type};base64,{base64-data}`.\nExample: `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...`\n\n2. A FileStore file path for large images: `/plots/{filename}.png`.\nExample: `/plots/b6a7ad70-fb2c-4353-8aed-3f1e015174a4.png`", + "launch_stage": "GA" + }, + "fileNames": { + "description": "List of image data for multiple images. Each element follows the same format as file_name.", + "launch_stage": "GA" + }, + "isJsonSchema": { + "description": "true if a JSON schema is returned instead of a string representation of the Hive type.", + "launch_stage": "GA" + }, + "pos": { + "description": "internal field used by SDK", + "launch_stage": "GA" + }, + "resultType": { + "ref": "compute.ResultType", + "launch_stage": "GA" + }, + "schema": { + "description": "The table schema", + "launch_stage": "GA" + }, + "summary": { + "description": "The summary of the error", + "launch_stage": "GA" + }, + "truncated": { + "description": "true if partial results are returned.", + "launch_stage": "GA" + } + } + }, + "compute.RuntimeEngine": { + "enum": [ + "NULL", + "STANDARD", + "PHOTON" + ], + "enum_launch_stages": { + "NULL": "GA", + "PHOTON": "GA", + "STANDARD": "GA" + } + }, + "compute.S3StorageInfo": { + "description": "A storage location in Amazon S3", + "fields": { + "canned_acl": { + "description": "(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs.", + "launch_stage": "GA" + }, + "destination": { + "description": "S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs.", + "launch_stage": "GA" + }, + "enable_encryption": { + "description": "(Optional) Flag to enable server side encryption, `false` by default.", + "launch_stage": "GA" + }, + "encryption_type": { + "description": "(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`.", + "launch_stage": "GA" + }, + "endpoint": { + "description": "S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used.", + "launch_stage": "GA" + }, + "kms_key": { + "description": "(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`.", + "launch_stage": "GA" + }, + "region": { + "description": "S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used.", + "launch_stage": "GA" + } + } + }, + "compute.SparkNode": { + "description": "Describes a specific Spark driver or executor.", + "fields": { + "host_private_ip": { + "description": "The private IP address of the host instance.", + "launch_stage": "GA" + }, + "instance_id": { + "description": "Globally unique identifier for the host instance from the cloud provider.", + "launch_stage": "GA" + }, + "node_aws_attributes": { + "description": "Attributes specific to AWS for a Spark node.", + "ref": "compute.SparkNodeAwsAttributes", + "launch_stage": "GA" + }, + "node_id": { + "description": "Globally unique identifier for this node.", + "launch_stage": "GA" + }, + "private_ip": { + "description": "Private IP address (typically a 10.x.x.x address) of the Spark node.\nNote that this is different from the private IP address of the host instance.", + "launch_stage": "GA" + }, + "public_dns": { + "description": "Public DNS address of this node. This address can be used to access\nthe Spark JDBC server on the driver node. To communicate with the JDBC server, traffic must\nbe manually authorized by adding security group rules to the \"worker-unmanaged\" security\ngroup via the AWS console.", + "launch_stage": "GA" + }, + "start_timestamp": { + "description": "The timestamp (in millisecond) when the Spark node is launched.", + "launch_stage": "GA" + } + } + }, + "compute.SparkNodeAwsAttributes": { + "description": "Attributes specific to AWS for a Spark node.", + "fields": { + "is_spot": { + "description": "Whether this node is on an Amazon spot instance.", + "launch_stage": "GA" + } + } + }, + "compute.SparkVersion": { + "fields": { + "key": { + "description": "Spark version key, for example \"2.1.x-scala2.11\". This is the value which should be provided\nas the \"spark_version\" when creating a new cluster.\nNote that the exact Spark version may change over time for a \"wildcard\" version\n(i.e., \"2.1.x-scala2.11\" is a \"wildcard\" version) with minor bug fixes.", + "launch_stage": "GA" + }, + "name": { + "description": "A descriptive name for this Spark version, for example \"Spark 2.1\".", + "launch_stage": "GA" + } + } + }, + "compute.StartCluster": { + "fields": { + "cluster_id": { + "description": "The cluster to be started.", + "launch_stage": "GA" + } + } + }, + "compute.StartClusterResponse": {}, + "compute.State": { + "description": "The state of a Cluster. The current allowable state transitions are as follows:\n\n- `PENDING` -\u003e `RUNNING`\n- `PENDING` -\u003e `TERMINATING`\n- `RUNNING` -\u003e `RESIZING`\n- `RUNNING` -\u003e `RESTARTING`\n- `RUNNING` -\u003e `TERMINATING`\n- `RESTARTING` -\u003e `RUNNING`\n- `RESTARTING` -\u003e `TERMINATING`\n- `RESIZING` -\u003e `RUNNING`\n- `RESIZING` -\u003e `TERMINATING`\n- `TERMINATING` -\u003e `TERMINATED`", + "enum": [ + "PENDING", + "RUNNING", + "RESTARTING", + "RESIZING", + "TERMINATING", + "TERMINATED", + "ERROR", + "UNKNOWN" + ], + "enum_launch_stages": { + "ERROR": "GA", + "PENDING": "GA", + "RESIZING": "GA", + "RESTARTING": "GA", + "RUNNING": "GA", + "TERMINATED": "GA", + "TERMINATING": "GA", + "UNKNOWN": "GA" + } + }, + "compute.TerminationReason": { + "fields": { + "code": { + "description": "status code indicating why the cluster was terminated", + "ref": "compute.TerminationReasonCode", + "launch_stage": "GA" + }, + "parameters": { + "description": "list of parameters that provide additional information about why the cluster was terminated", + "launch_stage": "GA" + }, + "type": { + "description": "type of the termination", + "ref": "compute.TerminationReasonType", + "launch_stage": "GA" + } + } + }, + "compute.TerminationReasonCode": { + "description": "The status code indicating why the cluster was terminated", + "enum": [ + "UNKNOWN", + "USER_REQUEST", + "JOB_FINISHED", + "INACTIVITY", + "CLOUD_PROVIDER_SHUTDOWN", + "COMMUNICATION_LOST", + "CLOUD_PROVIDER_LAUNCH_FAILURE", + "INIT_SCRIPT_FAILURE", + "SPARK_STARTUP_FAILURE", + "INVALID_ARGUMENT", + "UNEXPECTED_LAUNCH_FAILURE", + "INTERNAL_ERROR", + "INSTANCE_UNREACHABLE", + "REQUEST_REJECTED", + "TRIAL_EXPIRED", + "DRIVER_UNREACHABLE", + "SPARK_ERROR", + "DRIVER_UNRESPONSIVE", + "METASTORE_COMPONENT_UNHEALTHY", + "DBFS_COMPONENT_UNHEALTHY", + "EXECUTION_COMPONENT_UNHEALTHY", + "AZURE_RESOURCE_MANAGER_THROTTLING", + "AZURE_RESOURCE_PROVIDER_THROTTLING", + "NETWORK_CONFIGURATION_FAILURE", + "CONTAINER_LAUNCH_FAILURE", + "INSTANCE_POOL_CLUSTER_FAILURE", + "SKIPPED_SLOW_NODES", + "ATTACH_PROJECT_FAILURE", + "UPDATE_INSTANCE_PROFILE_FAILURE", + "DATABASE_CONNECTION_FAILURE", + "REQUEST_THROTTLED", + "SELF_BOOTSTRAP_FAILURE", + "GLOBAL_INIT_SCRIPT_FAILURE", + "SLOW_IMAGE_DOWNLOAD", + "INVALID_SPARK_IMAGE", + "NPIP_TUNNEL_TOKEN_FAILURE", + "HIVE_METASTORE_PROVISIONING_FAILURE", + "AZURE_INVALID_DEPLOYMENT_TEMPLATE", + "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE", + "SUBNET_EXHAUSTED_FAILURE", + "BOOTSTRAP_TIMEOUT", + "STORAGE_DOWNLOAD_FAILURE", + "CONTROL_PLANE_REQUEST_FAILURE", + "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION", + "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE", + "DOCKER_IMAGE_PULL_FAILURE", + "AZURE_VNET_CONFIGURATION_FAILURE", + "NPIP_TUNNEL_SETUP_FAILURE", + "AWS_AUTHORIZATION_FAILURE", + "NEPHOS_RESOURCE_MANAGEMENT", + "STS_CLIENT_SETUP_FAILURE", + "SECURITY_DAEMON_REGISTRATION_EXCEPTION", + "AWS_REQUEST_LIMIT_EXCEEDED", + "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE", + "AWS_UNSUPPORTED_FAILURE", + "AZURE_QUOTA_EXCEEDED_EXCEPTION", + "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION", + "NFS_MOUNT_FAILURE", + "K8S_AUTOSCALING_FAILURE", + "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT", + "SPARK_IMAGE_DOWNLOAD_FAILURE", + "AZURE_VM_EXTENSION_FAILURE", + "WORKSPACE_CANCELLED_ERROR", + "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE", + "TEMPORARILY_UNAVAILABLE", + "WORKER_SETUP_FAILURE", + "IP_EXHAUSTION_FAILURE", + "GCP_QUOTA_EXCEEDED", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT", + "GCP_SERVICE_ACCOUNT_DELETED", + "AZURE_BYOK_KEY_PERMISSION_FAILURE", + "SPOT_INSTANCE_TERMINATION", + "AZURE_EPHEMERAL_DISK_FAILURE", + "ABUSE_DETECTED", + "IMAGE_PULL_PERMISSION_DENIED", + "WORKSPACE_CONFIGURATION_ERROR", + "SECRET_RESOLUTION_ERROR", + "UNSUPPORTED_INSTANCE_TYPE", + "CLOUD_PROVIDER_DISK_SETUP_FAILURE", + "SSH_BOOTSTRAP_FAILURE", + "AWS_INACCESSIBLE_KMS_KEY_FAILURE", + "INIT_CONTAINER_NOT_FINISHED", + "SPARK_IMAGE_DOWNLOAD_THROTTLED", + "SPARK_IMAGE_NOT_FOUND", + "CLUSTER_OPERATION_THROTTLED", + "CLUSTER_OPERATION_TIMEOUT", + "SERVERLESS_LONG_RUNNING_TERMINATED", + "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE", + "INVALID_WORKER_IMAGE_FAILURE", + "WORKSPACE_UPDATE", + "INVALID_AWS_PARAMETER", + "DRIVER_OUT_OF_DISK", + "DRIVER_OUT_OF_MEMORY", + "DRIVER_LAUNCH_TIMEOUT", + "DRIVER_UNEXPECTED_FAILURE", + "UNEXPECTED_POD_RECREATION", + "GCP_INACCESSIBLE_KMS_KEY_FAILURE", + "GCP_KMS_KEY_PERMISSION_DENIED", + "DRIVER_EVICTION", + "USER_INITIATED_VM_TERMINATION", + "GCP_IAM_TIMEOUT", + "AWS_RESOURCE_QUOTA_EXCEEDED", + "CLOUD_ACCOUNT_SETUP_FAILURE", + "AWS_INVALID_KEY_PAIR", + "DRIVER_POD_CREATION_FAILURE", + "MAINTENANCE_MODE", + "INTERNAL_CAPACITY_FAILURE", + "EXECUTOR_POD_UNSCHEDULED", + "STORAGE_DOWNLOAD_FAILURE_SLOW", + "STORAGE_DOWNLOAD_FAILURE_THROTTLED", + "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED", + "AWS_INSTANCE_PROFILE_UPDATE_FAILURE", + "INSTANCE_POOL_NOT_FOUND", + "INSTANCE_POOL_MAX_CAPACITY_REACHED", + "AWS_INVALID_KMS_KEY_STATE", + "GCP_INSUFFICIENT_CAPACITY", + "GCP_API_RATE_QUOTA_EXCEEDED", + "GCP_RESOURCE_QUOTA_EXCEEDED", + "GCP_IP_SPACE_EXHAUSTED", + "GCP_SERVICE_ACCOUNT_ACCESS_DENIED", + "GCP_SERVICE_ACCOUNT_NOT_FOUND", + "GCP_FORBIDDEN", + "GCP_NOT_FOUND", + "RESOURCE_USAGE_BLOCKED", + "DATA_ACCESS_CONFIG_CHANGED", + "ACCESS_TOKEN_FAILURE", + "INVALID_INSTANCE_PLACEMENT_PROTOCOL", + "BUDGET_POLICY_RESOLUTION_FAILURE", + "IN_PENALTY_BOX", + "DISASTER_RECOVERY_REPLICATION", + "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG", + "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG", + "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG", + "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG", + "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG", + "GCP_SUBNET_NOT_READY", + "CLOUD_OPERATION_CANCELLED", + "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED", + "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED", + "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED", + "EOS_SPARK_IMAGE", + "NO_MATCHED_K8S", + "LAZY_ALLOCATION_TIMEOUT", + "DRIVER_NODE_UNREACHABLE", + "SECRET_CREATION_FAILURE", + "POD_SCHEDULING_FAILURE", + "POD_ASSIGNMENT_FAILURE", + "ALLOCATION_TIMEOUT", + "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS", + "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY", + "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS", + "NETVISOR_SETUP_TIMEOUT", + "NO_MATCHED_K8S_TESTING_TAG", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG", + "GKE_BASED_CLUSTER_TERMINATION", + "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS", + "DOCKER_INVALID_OS_EXCEPTION", + "DOCKER_CONTAINER_CREATION_EXCEPTION", + "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION", + "DNS_RESOLUTION_ERROR", + "GCP_DENIED_BY_ORG_POLICY", + "SECRET_PERMISSION_DENIED", + "NETWORK_CHECK_NIC_FAILURE", + "NETWORK_CHECK_DNS_SERVER_FAILURE", + "NETWORK_CHECK_STORAGE_FAILURE", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE", + "DRIVER_UNHEALTHY", + "USAGE_POLICY_ENTITLEMENT_DENIED", + "K8S_ACTIVE_POD_QUOTA_EXCEEDED", + "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED", + "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG", + "DBR_IMAGE_RESOLUTION_FAILURE", + "CONTROL_PLANE_CONNECTION_FAILURE", + "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG", + "RATE_LIMITED", + "MTLS_PORT_CONNECTIVITY_FAILURE", + "HIVEMETASTORE_CONNECTIVITY_FAILURE" + ], + "enum_launch_stages": { + "ABUSE_DETECTED": "GA", + "ACCESS_TOKEN_FAILURE": "GA", + "ALLOCATION_TIMEOUT": "GA", + "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY": "GA", + "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS": "GA", + "ATTACH_PROJECT_FAILURE": "GA", + "AWS_AUTHORIZATION_FAILURE": "GA", + "AWS_INACCESSIBLE_KMS_KEY_FAILURE": "GA", + "AWS_INSTANCE_PROFILE_UPDATE_FAILURE": "GA", + "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE": "GA", + "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE": "GA", + "AWS_INVALID_KEY_PAIR": "GA", + "AWS_INVALID_KMS_KEY_STATE": "GA", + "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE": "GA", + "AWS_REQUEST_LIMIT_EXCEEDED": "GA", + "AWS_RESOURCE_QUOTA_EXCEEDED": "GA", + "AWS_UNSUPPORTED_FAILURE": "GA", + "AZURE_BYOK_KEY_PERMISSION_FAILURE": "GA", + "AZURE_EPHEMERAL_DISK_FAILURE": "GA", + "AZURE_INVALID_DEPLOYMENT_TEMPLATE": "GA", + "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION": "GA", + "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE": "GA", + "AZURE_QUOTA_EXCEEDED_EXCEPTION": "GA", + "AZURE_RESOURCE_MANAGER_THROTTLING": "GA", + "AZURE_RESOURCE_PROVIDER_THROTTLING": "GA", + "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE": "GA", + "AZURE_VM_EXTENSION_FAILURE": "GA", + "AZURE_VNET_CONFIGURATION_FAILURE": "GA", + "BOOTSTRAP_TIMEOUT": "GA", + "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION": "GA", + "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG": "GA", + "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED": "GA", + "BUDGET_POLICY_RESOLUTION_FAILURE": "GA", + "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED": "GA", + "CLOUD_ACCOUNT_SETUP_FAILURE": "GA", + "CLOUD_OPERATION_CANCELLED": "GA", + "CLOUD_PROVIDER_DISK_SETUP_FAILURE": "GA", + "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED": "GA", + "CLOUD_PROVIDER_LAUNCH_FAILURE": "GA", + "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG": "GA", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT": "GA", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG": "GA", + "CLOUD_PROVIDER_SHUTDOWN": "GA", + "CLUSTER_OPERATION_THROTTLED": "GA", + "CLUSTER_OPERATION_TIMEOUT": "GA", + "COMMUNICATION_LOST": "GA", + "CONTAINER_LAUNCH_FAILURE": "GA", + "CONTROL_PLANE_CONNECTION_FAILURE": "GA", + "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG": "GA", + "CONTROL_PLANE_REQUEST_FAILURE": "GA", + "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG": "GA", + "DATABASE_CONNECTION_FAILURE": "GA", + "DATA_ACCESS_CONFIG_CHANGED": "GA", + "DBFS_COMPONENT_UNHEALTHY": "GA", + "DBR_IMAGE_RESOLUTION_FAILURE": "GA", + "DISASTER_RECOVERY_REPLICATION": "GA", + "DNS_RESOLUTION_ERROR": "GA", + "DOCKER_CONTAINER_CREATION_EXCEPTION": "GA", + "DOCKER_IMAGE_PULL_FAILURE": "GA", + "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION": "GA", + "DOCKER_INVALID_OS_EXCEPTION": "GA", + "DRIVER_EVICTION": "GA", + "DRIVER_LAUNCH_TIMEOUT": "GA", + "DRIVER_NODE_UNREACHABLE": "GA", + "DRIVER_OUT_OF_DISK": "GA", + "DRIVER_OUT_OF_MEMORY": "GA", + "DRIVER_POD_CREATION_FAILURE": "GA", + "DRIVER_UNEXPECTED_FAILURE": "GA", + "DRIVER_UNHEALTHY": "GA", + "DRIVER_UNREACHABLE": "GA", + "DRIVER_UNRESPONSIVE": "GA", + "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED": "GA", + "EOS_SPARK_IMAGE": "GA", + "EXECUTION_COMPONENT_UNHEALTHY": "GA", + "EXECUTOR_POD_UNSCHEDULED": "GA", + "GCP_API_RATE_QUOTA_EXCEEDED": "GA", + "GCP_DENIED_BY_ORG_POLICY": "GA", + "GCP_FORBIDDEN": "GA", + "GCP_IAM_TIMEOUT": "GA", + "GCP_INACCESSIBLE_KMS_KEY_FAILURE": "GA", + "GCP_INSUFFICIENT_CAPACITY": "GA", + "GCP_IP_SPACE_EXHAUSTED": "GA", + "GCP_KMS_KEY_PERMISSION_DENIED": "GA", + "GCP_NOT_FOUND": "GA", + "GCP_QUOTA_EXCEEDED": "GA", + "GCP_RESOURCE_QUOTA_EXCEEDED": "GA", + "GCP_SERVICE_ACCOUNT_ACCESS_DENIED": "GA", + "GCP_SERVICE_ACCOUNT_DELETED": "GA", + "GCP_SERVICE_ACCOUNT_NOT_FOUND": "GA", + "GCP_SUBNET_NOT_READY": "GA", + "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED": "GA", + "GKE_BASED_CLUSTER_TERMINATION": "GA", + "GLOBAL_INIT_SCRIPT_FAILURE": "GA", + "HIVEMETASTORE_CONNECTIVITY_FAILURE": "GA", + "HIVE_METASTORE_PROVISIONING_FAILURE": "GA", + "IMAGE_PULL_PERMISSION_DENIED": "GA", + "INACTIVITY": "GA", + "INIT_CONTAINER_NOT_FINISHED": "GA", + "INIT_SCRIPT_FAILURE": "GA", + "INSTANCE_POOL_CLUSTER_FAILURE": "GA", + "INSTANCE_POOL_MAX_CAPACITY_REACHED": "GA", + "INSTANCE_POOL_NOT_FOUND": "GA", + "INSTANCE_UNREACHABLE": "GA", + "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG": "GA", + "INTERNAL_CAPACITY_FAILURE": "GA", + "INTERNAL_ERROR": "GA", + "INVALID_ARGUMENT": "GA", + "INVALID_AWS_PARAMETER": "GA", + "INVALID_INSTANCE_PLACEMENT_PROTOCOL": "GA", + "INVALID_SPARK_IMAGE": "GA", + "INVALID_WORKER_IMAGE_FAILURE": "GA", + "IN_PENALTY_BOX": "GA", + "IP_EXHAUSTION_FAILURE": "GA", + "JOB_FINISHED": "GA", + "K8S_ACTIVE_POD_QUOTA_EXCEEDED": "GA", + "K8S_AUTOSCALING_FAILURE": "GA", + "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT": "GA", + "LAZY_ALLOCATION_TIMEOUT": "GA", + "MAINTENANCE_MODE": "GA", + "METASTORE_COMPONENT_UNHEALTHY": "GA", + "MTLS_PORT_CONNECTIVITY_FAILURE": "GA", + "NEPHOS_RESOURCE_MANAGEMENT": "GA", + "NETVISOR_SETUP_TIMEOUT": "GA", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE": "GA", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_DNS_SERVER_FAILURE": "GA", + "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE": "GA", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE": "GA", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_NIC_FAILURE": "GA", + "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_STORAGE_FAILURE": "GA", + "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CONFIGURATION_FAILURE": "GA", + "NFS_MOUNT_FAILURE": "GA", + "NO_MATCHED_K8S": "GA", + "NO_MATCHED_K8S_TESTING_TAG": "GA", + "NPIP_TUNNEL_SETUP_FAILURE": "GA", + "NPIP_TUNNEL_TOKEN_FAILURE": "GA", + "POD_ASSIGNMENT_FAILURE": "GA", + "POD_SCHEDULING_FAILURE": "GA", + "RATE_LIMITED": "GA", + "REQUEST_REJECTED": "GA", + "REQUEST_THROTTLED": "GA", + "RESOURCE_USAGE_BLOCKED": "GA", + "SECRET_CREATION_FAILURE": "GA", + "SECRET_PERMISSION_DENIED": "GA", + "SECRET_RESOLUTION_ERROR": "GA", + "SECURITY_DAEMON_REGISTRATION_EXCEPTION": "GA", + "SELF_BOOTSTRAP_FAILURE": "GA", + "SERVERLESS_LONG_RUNNING_TERMINATED": "GA", + "SKIPPED_SLOW_NODES": "GA", + "SLOW_IMAGE_DOWNLOAD": "GA", + "SPARK_ERROR": "GA", + "SPARK_IMAGE_DOWNLOAD_FAILURE": "GA", + "SPARK_IMAGE_DOWNLOAD_THROTTLED": "GA", + "SPARK_IMAGE_NOT_FOUND": "GA", + "SPARK_STARTUP_FAILURE": "GA", + "SPOT_INSTANCE_TERMINATION": "GA", + "SSH_BOOTSTRAP_FAILURE": "GA", + "STORAGE_DOWNLOAD_FAILURE": "GA", + "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG": "GA", + "STORAGE_DOWNLOAD_FAILURE_SLOW": "GA", + "STORAGE_DOWNLOAD_FAILURE_THROTTLED": "GA", + "STS_CLIENT_SETUP_FAILURE": "GA", + "SUBNET_EXHAUSTED_FAILURE": "GA", + "TEMPORARILY_UNAVAILABLE": "GA", + "TRIAL_EXPIRED": "GA", + "UNEXPECTED_LAUNCH_FAILURE": "GA", + "UNEXPECTED_POD_RECREATION": "GA", + "UNKNOWN": "GA", + "UNSUPPORTED_INSTANCE_TYPE": "GA", + "UPDATE_INSTANCE_PROFILE_FAILURE": "GA", + "USAGE_POLICY_ENTITLEMENT_DENIED": "GA", + "USER_INITIATED_VM_TERMINATION": "GA", + "USER_REQUEST": "GA", + "WORKER_SETUP_FAILURE": "GA", + "WORKSPACE_CANCELLED_ERROR": "GA", + "WORKSPACE_CONFIGURATION_ERROR": "GA", + "WORKSPACE_UPDATE": "GA" + } + }, + "compute.TerminationReasonType": { + "description": "type of the termination", + "enum": [ + "SUCCESS", + "CLIENT_ERROR", + "SERVICE_FAULT", + "CLOUD_FAILURE" + ], + "enum_launch_stages": { + "CLIENT_ERROR": "GA", + "CLOUD_FAILURE": "GA", + "SERVICE_FAULT": "GA", + "SUCCESS": "GA" + } + }, + "compute.UninstallLibraries": { + "fields": { + "cluster_id": { + "description": "Unique identifier for the cluster on which to uninstall these libraries.", + "launch_stage": "GA" + }, + "libraries": { + "description": "The libraries to uninstall.", + "launch_stage": "GA" + } + } + }, + "compute.UninstallLibrariesResponse": {}, + "compute.UnpinCluster": { + "fields": { + "cluster_id": { + "launch_stage": "GA" + } + } + }, + "compute.UnpinClusterResponse": {}, + "compute.UpdateCluster": { + "fields": { + "cluster": { + "description": "The cluster to be updated.", + "ref": "compute.UpdateClusterResource", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "ID of the cluster.", + "launch_stage": "GA" + }, + "update_mask": { + "description": "Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "compute.UpdateClusterResource": { + "fields": { + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "compute.AutoScale", + "launch_stage": "GA" + }, + "autotermination_minutes": { + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "cluster_name": { + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "data_security_mode": { + "ref": "compute.DataSecurityMode", + "launch_stage": "GA" + }, + "docker_image": { + "description": "Custom docker image BYOC", + "ref": "compute.DockerImage", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_flexibility": { + "description": "Flexible node type configuration for the driver node.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "launch_stage": "GA" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable LUKS on cluster VMs' local disks", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "is_single_node": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "launch_stage": "GA" + }, + "kind": { + "ref": "compute.kind", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "remote_disk_throughput": { + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "ref": "compute.RuntimeEngine", + "launch_stage": "GA" + }, + "single_user_name": { + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "spark_version": { + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + }, + "total_initial_remote_disk_size": { + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "launch_stage": "GA" + }, + "use_ml_runtime": { + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "launch_stage": "GA" + }, + "worker_node_type_flexibility": { + "description": "Flexible node type configuration for worker nodes.", + "ref": "compute.NodeTypeFlexibility", + "launch_stage": "GA" + }, + "workload_type": { + "ref": "compute.WorkloadType", + "launch_stage": "GA" + } + } + }, + "compute.UpdateClusterResponse": {}, + "compute.UpdateResponse": {}, + "compute.VolumesStorageInfo": { + "description": "A storage location back by UC Volumes.", + "fields": { + "destination": { + "description": "UC Volumes destination, e.g. `/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh`\nor `dbfs:/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh`", + "launch_stage": "GA" + } + } + }, + "compute.WorkloadType": { + "description": "Cluster Attributes showing for clusters workload types.", + "fields": { + "clients": { + "description": "defined what type of clients can use the cluster. E.g. Notebooks, Jobs", + "ref": "compute.ClientsTypes", + "launch_stage": "GA" + } + } + }, + "compute.WorkspaceStorageInfo": { + "description": "A storage location in Workspace Filesystem (WSFS)", + "fields": { + "destination": { + "description": "wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh`", + "launch_stage": "GA" + } + } + }, + "compute.kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", + "enum": [ + "CLASSIC_PREVIEW" + ], + "enum_launch_stages": { + "CLASSIC_PREVIEW": "GA" + } + }, + "dashboards.AuthorizationDetails": { + "fields": { + "grant_rules": { + "description": "Represents downscoped permission rules with specific access rights.\nThis field is specific to `workspace_rule_set` constraint.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "resource_legacy_acl_path": { + "description": "The acl path of the tree store resource resource.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "resource_name": { + "description": "The resource name to which the authorization rule applies.\nThis field is specific to `workspace_rule_set` constraint.\nFormat: `workspaces/{workspace_id}/dashboards/{dashboard_id}`", + "launch_stage": "PUBLIC_PREVIEW" + }, + "type": { + "description": "The type of authorization downscoping policy.\nEx: `workspace_rule_set` defines access rules for a specific workspace resource", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dashboards.AuthorizationDetailsGrantRule": { + "fields": { + "permission_set": { + "description": "Permission sets for dashboard are defined in\niam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets\nEx: `permissionSets/dashboard.runner`", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dashboards.CronSchedule": { + "fields": { + "quartz_cron_expression": { + "description": "A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am.\nSee [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details.", + "launch_stage": "GA" + }, + "timezone_id": { + "description": "A Java timezone id. The schedule will be resolved with respect to this timezone.\nSee [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.", + "launch_stage": "GA" + } + } + }, + "dashboards.Dashboard": { + "fields": { + "create_time": { + "description": "The timestamp of when the dashboard was created.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "dashboard_id": { + "description": "UUID identifying the dashboard.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "The display name of the dashboard.", + "launch_stage": "GA" + }, + "etag": { + "description": "The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.", + "launch_stage": "GA" + }, + "lifecycle_state": { + "description": "The state of the dashboard resource. Used for tracking trashed status.", + "ref": "dashboards.LifecycleState", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parent_path": { + "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "path": { + "description": "The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "serialized_dashboard": { + "description": "The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.", + "launch_stage": "GA" + }, + "update_time": { + "description": "The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "warehouse_id": { + "description": "The warehouse ID used to run the dashboard.", + "launch_stage": "GA" + } + } + }, + "dashboards.DashboardView": { + "enum": [ + "DASHBOARD_VIEW_BASIC" + ], + "enum_launch_stages": { + "DASHBOARD_VIEW_BASIC": "GA" + } + }, + "dashboards.EvaluationStatusType": { + "enum": [ + "RUNNING", + "DONE", + "NOT_STARTED", + "EVALUATION_FAILED", + "EVALUATION_CANCELLED", + "EVALUATION_TIMEOUT" + ], + "enum_launch_stages": { + "DONE": "PUBLIC_BETA", + "EVALUATION_CANCELLED": "PUBLIC_BETA", + "EVALUATION_FAILED": "PUBLIC_BETA", + "EVALUATION_TIMEOUT": "PUBLIC_BETA", + "NOT_STARTED": "PUBLIC_BETA", + "RUNNING": "PUBLIC_BETA" + } + }, + "dashboards.GenieAttachment": { + "description": "Genie AI Response", + "fields": { + "attachment_id": { + "description": "Attachment ID", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "query": { + "description": "Query Attachment if Genie responds with a SQL query", + "ref": "dashboards.GenieQueryAttachment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "suggested_questions": { + "description": "Follow-up questions suggested by Genie", + "ref": "dashboards.GenieSuggestedQuestionsAttachment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "text": { + "description": "Text Attachment if Genie responds with text\nThis also contains the final summary when available.", + "ref": "dashboards.TextAttachment", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieConversation": { + "fields": { + "conversation_id": { + "description": "Conversation ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "created_timestamp": { + "description": "Timestamp when the message was created", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "Conversation ID.\nLegacy identifier, use conversation_id instead", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_updated_timestamp": { + "description": "Timestamp when the message was last updated", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "space_id": { + "description": "Genie space ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "title": { + "description": "Conversation title", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "user_id": { + "description": "ID of the user who created the conversation", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieConversationSummary": { + "fields": { + "conversation_id": { + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "created_timestamp": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "title": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieCreateConversationMessageRequest": { + "fields": { + "content": { + "description": "User message content.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieCreateEvalRunRequest": { + "fields": { + "benchmark_question_ids": { + "description": "List of benchmark question IDs to evaluate. These questions must exist in the specified Genie space. If none are specified, then all benchmark questions are evaluated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GenieCreateMessageCommentRequest": { + "fields": { + "content": { + "description": "Comment text content.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieCreateSpaceRequest": { + "fields": { + "description": { + "description": "Optional description", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "parent_path": { + "description": "Parent folder path where the space will be registered", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "serialized_space": { + "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "title": { + "description": "Optional title override", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "warehouse_id": { + "description": "Warehouse to associate with the new space", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieEvalAssessment": { + "enum": [ + "GOOD", + "BAD", + "NEEDS_REVIEW" + ], + "enum_launch_stages": { + "BAD": "PUBLIC_BETA", + "GOOD": "PUBLIC_BETA", + "NEEDS_REVIEW": "PUBLIC_BETA" + } + }, + "dashboards.GenieEvalResponse": { + "fields": { + "response": { + "description": "The response content (either text or SQL query).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "response_type": { + "description": "Type of response", + "ref": "dashboards.GenieEvalResponseType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sql_execution_result": { + "description": "SQL Statement Execution response.", + "ref": "sql.StatementResponse", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieEvalResponseType": { + "enum": [ + "TEXT", + "SQL" + ], + "enum_launch_stages": { + "SQL": "PUBLIC_BETA", + "TEXT": "PUBLIC_BETA" + } + }, + "dashboards.GenieEvalResult": { + "description": "Shows summary information for an evaluation result.\nFor detailed information including SQL execution results, actual/expected responses, and assessment scores, use GenieGetEvalResultDetails.", + "fields": { + "benchmark_answer": { + "description": "Stored snapshot of original benchmark answer text.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "benchmark_question_id": { + "description": "The ID of the benchmark question that was evaluated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "created_by_user": { + "description": "User ID who created evaluation result.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "question": { + "description": "Stored snapshot of original benchmark question text.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "result_id": { + "description": "Unique identifier for this evaluation result.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "space_id": { + "description": "The ID of the space the evaluation result belongs to.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "status": { + "description": "Current status of this evaluation result.", + "ref": "dashboards.EvaluationStatusType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieEvalResultDetails": { + "description": "Shows detailed information for an evaluation result.", + "fields": { + "actual_response": { + "description": "The actual response generated by Genie.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "assessment": { + "description": "Assessment of the evaluation result: good, bad, or needs review", + "ref": "dashboards.GenieEvalAssessment", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "assessment_reasons": { + "description": "Reasons for the assessment score.\n\nAssessment reasons describe why a Genie response was scored as BAD.\n\nDeterministic values (compared against the ground truth result):\n- EMPTY_RESULT: Genie's generated SQL results were empty for this benchmark question.\n- RESULT_MISSING_ROWS: Genie's generated SQL response is missing rows from the provided ground truth SQL.\n- RESULT_EXTRA_ROWS: Genie's generated SQL response has more rows than the provided ground truth SQL.\n- RESULT_MISSING_COLUMNS: Genie's generated SQL response is missing columns from the provided ground truth SQL.\n- RESULT_EXTRA_COLUMNS: Genie's generated SQL response has more columns than the provided ground truth SQL.\n- SINGLE_CELL_DIFFERENCE: Single value result was produced but differs from ground truth result.\n- EMPTY_GOOD_SQL: The benchmark SQL returned an empty result.\n- COLUMN_TYPE_DIFFERENCE: The values between the results match but the column type is different.\n\nLLM judge ratings explain the factors driving BAD results:\n- LLM_JUDGE_MISSING_OR_INCORRECT_FILTER: Genie's generated SQL is missing a WHERE clause condition or has incorrect filter logic that excludes/includes wrong data.\n- LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT: Genie's generated SQL returns only some of the requested data or columns, missing parts of what the ground truth SQL returns.\n- LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST: Genie's generated SQL fundamentally misunderstands what the user is asking for, addressing the wrong question or goal.\n- LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC: Genie's generated SQL fails to apply specified instructions or business logic that should be followed.\n- LLM_JUDGE_INCORRECT_METRIC_CALCULATION: Genie's generated SQL uses incorrect logic or makes wrong assumptions when calculating metrics.\n- LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE: Genie's generated SQL references wrong tables, columns, or uses fields that don't match the ground truth SQL's intent.\n- LLM_JUDGE_INCORRECT_FUNCTION_USAGE: Genie's generated SQL uses SQL functions incorrectly or inappropriately (wrong parameters, wrong function for the task, etc.).\n- LLM_JUDGE_MISSING_OR_INCORRECT_JOIN: Genie's generated SQL is missing necessary joins between tables or has incorrect join conditions/types that produce wrong results.\n- LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION: Genie's generated SQL is missing GROUP BY clauses or has incorrect grouping that doesn't match the requested aggregation level.\n- LLM_JUDGE_FORMATTING_ERROR: Genie's generated SQL output has incorrect formatting, ordering (ORDER BY), or presentation issues that don't match expectations.\n- LLM_JUDGE_OTHER: LLM judge identified an error that doesn't fall into other categories.\n\nDeprecated LLM judge values (kept for backward compatibility, do not use):\n- LLM_JUDGE_MISSING_JOIN (deprecated)\n- LLM_JUDGE_WRONG_FILTER (deprecated)\n- LLM_JUDGE_WRONG_AGGREGATION (deprecated)\n- LLM_JUDGE_WRONG_COLUMNS (deprecated)\n- LLM_JUDGE_SYNTAX_ERROR (deprecated)\n- LLM_JUDGE_SEMANTIC_ERROR (deprecated)", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "benchmark_question_id": { + "description": "The ID of the benchmark question that was evaluated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "eval_run_status": { + "description": "Current status of the evaluation run.", + "ref": "dashboards.EvaluationStatusType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expected_response": { + "description": "The expected responses from the benchmark.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "manual_assessment": { + "description": "Whether this evaluation was manually assessed.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "result_id": { + "description": "The unique identifier for the evaluation result.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "space_id": { + "description": "The ID of the space the evaluation result belongs to.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieEvalRunResponse": { + "fields": { + "created_timestamp": { + "description": "Timestamp when the evaluation run was created (milliseconds since epoch).", + "launch_stage": "PUBLIC_BETA" + }, + "eval_run_id": { + "description": "The unique identifier for the evaluation run.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "eval_run_status": { + "description": "Current status of the evaluation run.", + "ref": "dashboards.EvaluationStatusType", + "launch_stage": "PUBLIC_BETA" + }, + "last_updated_timestamp": { + "description": "Timestamp when the evaluation run was last updated (milliseconds since epoch).", + "launch_stage": "PUBLIC_BETA" + }, + "num_correct": { + "description": "Number of questions answered correctly.", + "launch_stage": "PUBLIC_BETA" + }, + "num_done": { + "description": "Number of questions that have been completed.", + "launch_stage": "PUBLIC_BETA" + }, + "num_needs_review": { + "description": "Number of questions that need manual review.", + "launch_stage": "PUBLIC_BETA" + }, + "num_questions": { + "description": "Total number of questions in the evaluation run.", + "launch_stage": "PUBLIC_BETA" + }, + "run_by_user": { + "description": "User ID who initiated the evaluation run.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dashboards.GenieExecuteMessageAttachmentQueryRequest": {}, + "dashboards.GenieExecuteMessageQueryRequest": {}, + "dashboards.GenieFeedback": { + "description": "Feedback containing rating and optional comment", + "fields": { + "comment": { + "description": "Optional feedback comment text", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "rating": { + "description": "The feedback rating", + "ref": "dashboards.GenieFeedbackRating", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GenieFeedbackRating": { + "description": "Feedback rating for Genie messages", + "enum": [ + "POSITIVE", + "NEGATIVE", + "NONE" + ], + "enum_launch_stages": { + "NEGATIVE": "GA", + "NONE": "GA", + "POSITIVE": "GA" + } + }, + "dashboards.GenieGenerateDownloadFullQueryResultRequest": {}, + "dashboards.GenieGenerateDownloadFullQueryResultResponse": { + "fields": { + "download_id": { + "description": "Download ID. Use this ID to track the download request in subsequent polling calls", + "launch_stage": "GA" + }, + "download_id_signature": { + "description": "JWT signature for the download_id to ensure secure access to query results", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieGetDownloadFullQueryResultResponse": { + "fields": { + "statement_response": { + "description": "SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details.", + "ref": "sql.StatementResponse", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieGetMessageQueryResultResponse": { + "fields": { + "statement_response": { + "description": "SQL Statement Execution response. See [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) for more details.", + "ref": "sql.StatementResponse", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieListConversationCommentsResponse": { + "fields": { + "comments": { + "description": "List of comments in the conversation.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "description": "Token to get the next page of results.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dashboards.GenieListConversationMessagesResponse": { + "fields": { + "messages": { + "description": "List of messages in the conversation.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "The token to use for retrieving the next page of results.", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieListConversationsResponse": { + "fields": { + "conversations": { + "description": "List of conversations in the Genie space", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Token to get the next page of results", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieListEvalResultsResponse": { + "fields": { + "eval_results": { + "description": "List of evaluation results for the specified run.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "The token to use for retrieving the next page of results.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dashboards.GenieListEvalRunsResponse": { + "fields": { + "eval_runs": { + "description": "List of evaluation runs for a space on provided page token and page size", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "The token to use for retrieving the next page of results.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dashboards.GenieListMessageCommentsResponse": { + "fields": { + "comments": { + "description": "List of comments on the message.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "description": "Token to get the next page of results.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dashboards.GenieListSpacesResponse": { + "fields": { + "next_page_token": { + "description": "Token to get the next page of results", + "launch_stage": "GA" + }, + "spaces": { + "description": "List of Genie spaces", + "launch_stage": "GA" + } + } + }, + "dashboards.GenieMessage": { + "fields": { + "attachments": { + "description": "AI-generated response to the message", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "content": { + "description": "User message content", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "conversation_id": { + "description": "Conversation ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "created_timestamp": { + "description": "Timestamp when the message was created", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "error": { + "description": "Error message if Genie failed to respond to the message", + "ref": "dashboards.MessageError", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "feedback": { + "description": "User feedback for the message if provided", + "ref": "dashboards.GenieFeedback", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "Message ID.\nLegacy identifier, use message_id instead", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_updated_timestamp": { + "description": "Timestamp when the message was last updated", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message_id": { + "description": "Message ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "query_result": { + "description": "The result of SQL query if the message includes a query attachment.\nDeprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead.", + "ref": "dashboards.Result", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "space_id": { + "description": "Genie space ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "status": { + "ref": "dashboards.MessageStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "user_id": { + "description": "ID of the user who created the message", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieMessageComment": { + "description": "A comment on a Genie conversation message.", + "fields": { + "content": { + "description": "Comment text content", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "conversation_id": { + "description": "Conversation ID", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "created_timestamp": { + "description": "Timestamp when the comment was created", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message_comment_id": { + "description": "Comment ID", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "message_id": { + "description": "Message ID", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "space_id": { + "description": "Genie space ID", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "user_id": { + "description": "ID of the user who created the comment", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieQueryAttachment": { + "fields": { + "description": { + "description": "Description of the query", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_updated_timestamp": { + "description": "Time when the user updated the query last", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parameters": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "query": { + "description": "AI generated SQL query", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "query_result_metadata": { + "description": "Metadata associated with the query result.", + "ref": "dashboards.GenieResultMetadata", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "statement_id": { + "description": "Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "thoughts": { + "description": "Insights into how Genie came to generate the SQL.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "title": { + "description": "Name of the query", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GenieResultMetadata": { + "fields": { + "is_truncated": { + "description": "Indicates whether the result set is truncated.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "row_count": { + "description": "The number of rows in the result set.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieSendMessageFeedbackRequest": { + "fields": { + "comment": { + "description": "Optional text feedback that will be stored as a comment.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "rating": { + "description": "The rating (POSITIVE, NEGATIVE, or NONE).", + "ref": "dashboards.GenieFeedbackRating", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieSpace": { + "fields": { + "description": { + "description": "Description of the Genie Space", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "etag": { + "description": "ETag for this space. Pass this value back in the update request to prevent overwriting\nconcurrent changes.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parent_path": { + "description": "Parent folder path of the Genie Space", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "serialized_space": { + "description": "The contents of the Genie Space in serialized string form.\nThis field is excluded in List Genie spaces responses.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "space_id": { + "description": "Genie space ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "title": { + "description": "Title of the Genie Space", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "warehouse_id": { + "description": "Warehouse associated with the Genie Space", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GenieStartConversationMessageRequest": { + "fields": { + "content": { + "description": "The text of the message that starts the conversation.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieStartConversationResponse": { + "fields": { + "conversation": { + "ref": "dashboards.GenieConversation", + "launch_stage": "GA" + }, + "conversation_id": { + "description": "Conversation ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "message": { + "ref": "dashboards.GenieMessage", + "launch_stage": "GA" + }, + "message_id": { + "description": "Message ID", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dashboards.GenieSuggestedQuestionsAttachment": { + "description": "Follow-up questions suggested by Genie", + "fields": { + "questions": { + "description": "The suggested follow-up questions", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.GenieUpdateSpaceRequest": { + "fields": { + "description": { + "description": "Optional description", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "etag": { + "description": "ETag returned by a previous GET or UPDATE. When set, the update will fail if the space\nhas been modified since. Omit to apply the update unconditionally.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "parent_path": { + "description": "Parent workspace folder path to move this Genie space under.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "serialized_space": { + "description": "The contents of the Genie Space in serialized string form (full replacement).\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "title": { + "description": "Optional title override", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "warehouse_id": { + "description": "Optional warehouse override", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GetPublishedDashboardTokenInfoResponse": { + "fields": { + "authorization_details": { + "description": "Authorization constraints for accessing the published dashboard.\nCurrently includes `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before\noAuth token generation.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "custom_claim": { + "description": "Custom claim generated from external_value and external_viewer_id.\nFormat: `urn:aibi:external_data:\u003cexternal_value\u003e:\u003cexternal_viewer_id\u003e:\u003cdashboard_id\u003e`", + "launch_stage": "PUBLIC_PREVIEW" + }, + "scope": { + "description": "Scope defining access permissions.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dashboards.LifecycleState": { + "enum": [ + "ACTIVE", + "TRASHED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "TRASHED": "GA" + } + }, + "dashboards.ListDashboardsResponse": { + "fields": { + "dashboards": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent dashboards.", + "launch_stage": "GA" + } + } + }, + "dashboards.ListSchedulesResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results.\nIf this field is omitted, there are no subsequent schedules.", + "launch_stage": "GA" + }, + "schedules": { + "launch_stage": "GA" + } + } + }, + "dashboards.ListSubscriptionsResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results.\nIf this field is omitted, there are no subsequent subscriptions.", + "launch_stage": "GA" + }, + "subscriptions": { + "launch_stage": "GA" + } + } + }, + "dashboards.MessageError": { + "fields": { + "error": { + "launch_stage": "GA" + }, + "type": { + "ref": "dashboards.MessageErrorType", + "launch_stage": "GA" + } + } + }, + "dashboards.MessageErrorType": { + "enum": [ + "UNEXPECTED_REPLY_PROCESS_EXCEPTION", + "GENERIC_CHAT_COMPLETION_EXCEPTION", + "CONTEXT_EXCEEDED_EXCEPTION", + "DEPLOYMENT_NOT_FOUND_EXCEPTION", + "FUNCTIONS_NOT_AVAILABLE_EXCEPTION", + "INVALID_COMPLETION_REQUEST_EXCEPTION", + "CONTENT_FILTER_EXCEPTION", + "FUNCTION_ARGUMENTS_INVALID_JSON_EXCEPTION", + "RETRYABLE_PROCESSING_EXCEPTION", + "INVALID_FUNCTION_CALL_EXCEPTION", + "LOCAL_CONTEXT_EXCEEDED_EXCEPTION", + "CHAT_COMPLETION_NETWORK_EXCEPTION", + "INVALID_CHAT_COMPLETION_JSON_EXCEPTION", + "GENERIC_CHAT_COMPLETION_SERVICE_EXCEPTION", + "WAREHOUSE_ACCESS_MISSING_EXCEPTION", + "WAREHOUSE_NOT_FOUND_EXCEPTION", + "NO_TABLES_TO_QUERY_EXCEPTION", + "SQL_EXECUTION_EXCEPTION", + "REPLY_PROCESS_TIMEOUT_EXCEPTION", + "COULD_NOT_GET_UC_SCHEMA_EXCEPTION", + "INVALID_TABLE_IDENTIFIER_EXCEPTION", + "TOO_MANY_TABLES_EXCEPTION", + "FUNCTION_ARGUMENTS_INVALID_EXCEPTION", + "GENERIC_SQL_EXEC_API_CALL_EXCEPTION", + "CHAT_COMPLETION_CLIENT_EXCEPTION", + "CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION", + "UNKNOWN_AI_MODEL", + "TABLES_MISSING_EXCEPTION", + "MESSAGE_DELETED_WHILE_EXECUTING_EXCEPTION", + "MESSAGE_UPDATED_WHILE_EXECUTING_EXCEPTION", + "BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION", + "INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION", + "TOO_MANY_CERTIFIED_ANSWERS_EXCEPTION", + "RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION", + "RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION", + "FUNCTION_CALL_MISSING_PARAMETER_EXCEPTION", + "INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION", + "ILLEGAL_PARAMETER_DEFINITION_EXCEPTION", + "NO_QUERY_TO_VISUALIZE_EXCEPTION", + "NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE", + "STOP_PROCESS_DUE_TO_AUTO_REGENERATE", + "FUNCTION_ARGUMENTS_INVALID_TYPE_EXCEPTION", + "MESSAGE_CANCELLED_WHILE_EXECUTING_EXCEPTION", + "COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION", + "GENERATED_SQL_QUERY_TOO_LONG_EXCEPTION", + "MISSING_SQL_QUERY_EXCEPTION", + "DESCRIBE_QUERY_UNEXPECTED_FAILURE", + "DESCRIBE_QUERY_TIMEOUT", + "DESCRIBE_QUERY_INVALID_SQL_ERROR", + "INVALID_SQL_UNKNOWN_TABLE_EXCEPTION", + "INVALID_SQL_MULTIPLE_STATEMENTS_EXCEPTION", + "INVALID_SQL_MULTIPLE_DATASET_REFERENCES_EXCEPTION", + "MESSAGE_ATTACHMENT_TOO_LONG_ERROR", + "INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION", + "INTERNAL_CATALOG_MISSING_UC_PATH_EXCEPTION", + "EXCEEDED_MAX_TOKEN_LENGTH_EXCEPTION", + "INTERNAL_CATALOG_ASSET_CREATION_ONGOING_EXCEPTION", + "INTERNAL_CATALOG_ASSET_CREATION_FAILED_EXCEPTION", + "INTERNAL_CATALOG_ASSET_CREATION_UNSUPPORTED_EXCEPTION", + "UNSUPPORTED_CONVERSATION_TYPE_EXCEPTION", + "COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION" + ], + "enum_launch_stages": { + "BLOCK_MULTIPLE_EXECUTIONS_EXCEPTION": "GA", + "CHAT_COMPLETION_CLIENT_EXCEPTION": "GA", + "CHAT_COMPLETION_CLIENT_TIMEOUT_EXCEPTION": "GA", + "CHAT_COMPLETION_NETWORK_EXCEPTION": "GA", + "CONTENT_FILTER_EXCEPTION": "GA", + "CONTEXT_EXCEEDED_EXCEPTION": "GA", + "COULD_NOT_GET_DASHBOARD_SCHEMA_EXCEPTION": "GA", + "COULD_NOT_GET_MODEL_DEPLOYMENTS_EXCEPTION": "GA", + "COULD_NOT_GET_UC_SCHEMA_EXCEPTION": "GA", + "DEPLOYMENT_NOT_FOUND_EXCEPTION": "GA", + "DESCRIBE_QUERY_INVALID_SQL_ERROR": "GA", + "DESCRIBE_QUERY_TIMEOUT": "GA", + "DESCRIBE_QUERY_UNEXPECTED_FAILURE": "GA", + "EXCEEDED_MAX_TOKEN_LENGTH_EXCEPTION": "GA", + "FUNCTIONS_NOT_AVAILABLE_EXCEPTION": "GA", + "FUNCTION_ARGUMENTS_INVALID_EXCEPTION": "GA", + "FUNCTION_ARGUMENTS_INVALID_JSON_EXCEPTION": "GA", + "FUNCTION_ARGUMENTS_INVALID_TYPE_EXCEPTION": "GA", + "FUNCTION_CALL_MISSING_PARAMETER_EXCEPTION": "GA", + "GENERATED_SQL_QUERY_TOO_LONG_EXCEPTION": "GA", + "GENERIC_CHAT_COMPLETION_EXCEPTION": "GA", + "GENERIC_CHAT_COMPLETION_SERVICE_EXCEPTION": "GA", + "GENERIC_SQL_EXEC_API_CALL_EXCEPTION": "GA", + "ILLEGAL_PARAMETER_DEFINITION_EXCEPTION": "GA", + "INTERNAL_CATALOG_ASSET_CREATION_FAILED_EXCEPTION": "GA", + "INTERNAL_CATALOG_ASSET_CREATION_ONGOING_EXCEPTION": "GA", + "INTERNAL_CATALOG_ASSET_CREATION_UNSUPPORTED_EXCEPTION": "GA", + "INTERNAL_CATALOG_MISSING_UC_PATH_EXCEPTION": "GA", + "INTERNAL_CATALOG_PATH_OVERLAP_EXCEPTION": "GA", + "INVALID_CERTIFIED_ANSWER_FUNCTION_EXCEPTION": "GA", + "INVALID_CERTIFIED_ANSWER_IDENTIFIER_EXCEPTION": "GA", + "INVALID_CHAT_COMPLETION_JSON_EXCEPTION": "GA", + "INVALID_COMPLETION_REQUEST_EXCEPTION": "GA", + "INVALID_FUNCTION_CALL_EXCEPTION": "GA", + "INVALID_SQL_MULTIPLE_DATASET_REFERENCES_EXCEPTION": "GA", + "INVALID_SQL_MULTIPLE_STATEMENTS_EXCEPTION": "GA", + "INVALID_SQL_UNKNOWN_TABLE_EXCEPTION": "GA", + "INVALID_TABLE_IDENTIFIER_EXCEPTION": "GA", + "LOCAL_CONTEXT_EXCEEDED_EXCEPTION": "GA", + "MESSAGE_ATTACHMENT_TOO_LONG_ERROR": "GA", + "MESSAGE_CANCELLED_WHILE_EXECUTING_EXCEPTION": "GA", + "MESSAGE_DELETED_WHILE_EXECUTING_EXCEPTION": "GA", + "MESSAGE_UPDATED_WHILE_EXECUTING_EXCEPTION": "GA", + "MISSING_SQL_QUERY_EXCEPTION": "GA", + "NO_DEPLOYMENTS_AVAILABLE_TO_WORKSPACE": "GA", + "NO_QUERY_TO_VISUALIZE_EXCEPTION": "GA", + "NO_TABLES_TO_QUERY_EXCEPTION": "GA", + "RATE_LIMIT_EXCEEDED_GENERIC_EXCEPTION": "GA", + "RATE_LIMIT_EXCEEDED_SPECIFIED_WAIT_EXCEPTION": "GA", + "REPLY_PROCESS_TIMEOUT_EXCEPTION": "GA", + "RETRYABLE_PROCESSING_EXCEPTION": "GA", + "SQL_EXECUTION_EXCEPTION": "GA", + "STOP_PROCESS_DUE_TO_AUTO_REGENERATE": "GA", + "TABLES_MISSING_EXCEPTION": "GA", + "TOO_MANY_CERTIFIED_ANSWERS_EXCEPTION": "GA", + "TOO_MANY_TABLES_EXCEPTION": "GA", + "UNEXPECTED_REPLY_PROCESS_EXCEPTION": "GA", + "UNKNOWN_AI_MODEL": "GA", + "UNSUPPORTED_CONVERSATION_TYPE_EXCEPTION": "GA", + "WAREHOUSE_ACCESS_MISSING_EXCEPTION": "GA", + "WAREHOUSE_NOT_FOUND_EXCEPTION": "GA" + } + }, + "dashboards.MessageStatus": { + "description": "MessageStatus.\nThe possible values are:\n* `FETCHING_METADATA`: Fetching metadata from the data sources.\n* `FILTERING_CONTEXT`: Running smart context step to determine relevant context.\n* `ASKING_AI`: Waiting for the LLM to respond to the user's question.\n* `PENDING_WAREHOUSE`: Waiting for warehouse before the SQL query can start executing.\n* `EXECUTING_QUERY`: Executing a generated SQL query. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API.\n* `FAILED`: The response generation or query execution failed. See `error` field.\n* `COMPLETED`: Message processing is completed. Results are in the `attachments` field. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API.\n* `SUBMITTED`: Message has been submitted.\n* `QUERY_RESULT_EXPIRED`: SQL result is not available anymore. The user needs to rerun the query. Rerun the SQL query result by calling [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API.\n* `CANCELLED`: Message has been cancelled.", + "enum": [ + "FETCHING_METADATA", + "FILTERING_CONTEXT", + "ASKING_AI", + "PENDING_WAREHOUSE", + "EXECUTING_QUERY", + "FAILED", + "COMPLETED", + "SUBMITTED", + "QUERY_RESULT_EXPIRED", + "CANCELLED" + ], + "enum_launch_stages": { + "ASKING_AI": "GA", + "CANCELLED": "GA", + "COMPLETED": "GA", + "EXECUTING_QUERY": "GA", + "FAILED": "GA", + "FETCHING_METADATA": "GA", + "FILTERING_CONTEXT": "GA", + "PENDING_WAREHOUSE": "GA", + "QUERY_RESULT_EXPIRED": "GA", + "SUBMITTED": "GA" + }, + "enum_descriptions": { + "ASKING_AI": "Waiting for the LLM to respond to the user's question.", + "CANCELLED": "Message has been cancelled.", + "COMPLETED": "Message processing is completed. Results are in the `attachments` field. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API.", + "EXECUTING_QUERY": "Executing a generated SQL query. Get the SQL query result by calling [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) API.", + "FAILED": "The response generation or query execution failed. See `error` field.", + "FETCHING_METADATA": "Fetching metadata from the data sources.", + "FILTERING_CONTEXT": "Running smart context step to determine relevant context.", + "PENDING_WAREHOUSE": "Waiting for warehouse before the SQL query can start executing.", + "QUERY_RESULT_EXPIRED": "SQL result is not available anymore. The user needs to rerun the query. Rerun the SQL query result by calling [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) API.", + "SUBMITTED": "Message has been submitted." + } + }, + "dashboards.MigrateDashboardRequest": { + "fields": { + "display_name": { + "description": "Display name for the new Lakeview dashboard.", + "launch_stage": "GA" + }, + "parent_path": { + "description": "The workspace path of the folder to contain the migrated Lakeview dashboard.", + "launch_stage": "GA" + }, + "source_dashboard_id": { + "description": "UUID of the dashboard to be migrated.", + "launch_stage": "GA" + }, + "update_parameter_syntax": { + "description": "Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated\nto named syntax (:param) when converting datasets in the dashboard.", + "launch_stage": "GA" + } + } + }, + "dashboards.PublishRequest": { + "fields": { + "embed_credentials": { + "description": "Flag to indicate if the publisher's credentials should be embedded in the\npublished dashboard. These embedded credentials will be used to execute the\npublished dashboard's queries.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "The ID of the warehouse that can be used to override the warehouse which\nwas set in the draft.", + "launch_stage": "GA" + } + } + }, + "dashboards.PublishedDashboard": { + "fields": { + "display_name": { + "description": "The display name of the published dashboard.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "embed_credentials": { + "description": "Indicates whether credentials are embedded in the published dashboard.", + "launch_stage": "GA" + }, + "revision_create_time": { + "description": "The timestamp of when the published dashboard was last revised.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "warehouse_id": { + "description": "The warehouse ID used to run the published dashboard.", + "launch_stage": "GA" + } + } + }, + "dashboards.QueryAttachmentParameter": { + "fields": { + "keyword": { + "launch_stage": "GA" + }, + "sql_type": { + "launch_stage": "GA" + }, + "value": { + "launch_stage": "GA" + } + } + }, + "dashboards.Result": { + "fields": { + "is_truncated": { + "description": "If result is truncated", + "launch_stage": "GA" + }, + "row_count": { + "description": "Row count of the result", + "launch_stage": "GA" + }, + "statement_id": { + "description": "Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data.", + "launch_stage": "GA" + }, + "statement_id_signature": { + "description": "JWT corresponding to the statement contained in this result", + "launch_stage": "GA" + } + } + }, + "dashboards.RevertDashboardRequest": { + "description": "Request to revert a dashboard draft to its last published state.", + "fields": { + "etag": { + "description": "The etag for the dashboard. Optionally, it can be provided to verify that the dashboard\nhas not been modified from its last retrieval.\nTODO(TSE-3937): update to new non-CMK-encrypted label when available", + "launch_stage": "GA" + } + } + }, + "dashboards.RevertDashboardResponse": { + "description": "Response to revert a dashboard draft to its last published state.", + "fields": { + "dashboard": { + "description": "The reverted dashboard.", + "ref": "dashboards.Dashboard", + "launch_stage": "GA" + } + } + }, + "dashboards.Schedule": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the schedule was created.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "cron_schedule": { + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "ref": "dashboards.CronSchedule", + "launch_stage": "GA" + }, + "dashboard_id": { + "description": "UUID identifying the dashboard to which the schedule belongs.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "The display name for schedule.", + "launch_stage": "GA" + }, + "etag": { + "description": "The etag for the schedule. Must be left empty on create, must be provided on updates to ensure\nthat the schedule has not been modified since the last read, and can be optionally provided on delete.", + "launch_stage": "GA" + }, + "pause_status": { + "description": "The status indicates whether this schedule is paused or not.", + "ref": "dashboards.SchedulePauseStatus", + "launch_stage": "GA" + }, + "schedule_id": { + "description": "UUID identifying the schedule.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the schedule was last updated.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "warehouse_id": { + "description": "The warehouse id to run the dashboard with for the schedule.", + "launch_stage": "GA" + } + } + }, + "dashboards.SchedulePauseStatus": { + "enum": [ + "UNPAUSED", + "PAUSED" + ], + "enum_launch_stages": { + "PAUSED": "GA", + "UNPAUSED": "GA" + } + }, + "dashboards.ScoreReason": { + "enum": [ + "EMPTY_RESULT", + "RESULT_MISSING_ROWS", + "RESULT_EXTRA_ROWS", + "RESULT_MISSING_COLUMNS", + "RESULT_EXTRA_COLUMNS", + "SINGLE_CELL_DIFFERENCE", + "EMPTY_GOOD_SQL", + "COLUMN_TYPE_DIFFERENCE", + "LLM_JUDGE_MISSING_JOIN", + "LLM_JUDGE_WRONG_FILTER", + "LLM_JUDGE_WRONG_AGGREGATION", + "LLM_JUDGE_WRONG_COLUMNS", + "LLM_JUDGE_SYNTAX_ERROR", + "LLM_JUDGE_SEMANTIC_ERROR", + "LLM_JUDGE_OTHER", + "LLM_JUDGE_MISSING_OR_INCORRECT_FILTER", + "LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT", + "LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST", + "LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC", + "LLM_JUDGE_INCORRECT_METRIC_CALCULATION", + "LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE", + "LLM_JUDGE_INCORRECT_FUNCTION_USAGE", + "LLM_JUDGE_MISSING_OR_INCORRECT_JOIN", + "LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION", + "LLM_JUDGE_FORMATTING_ERROR" + ], + "enum_launch_stages": { + "COLUMN_TYPE_DIFFERENCE": "PUBLIC_BETA", + "EMPTY_GOOD_SQL": "PUBLIC_BETA", + "EMPTY_RESULT": "PUBLIC_BETA", + "LLM_JUDGE_FORMATTING_ERROR": "PUBLIC_BETA", + "LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT": "PUBLIC_BETA", + "LLM_JUDGE_INCORRECT_FUNCTION_USAGE": "PUBLIC_BETA", + "LLM_JUDGE_INCORRECT_METRIC_CALCULATION": "PUBLIC_BETA", + "LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE": "PUBLIC_BETA", + "LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC": "PUBLIC_BETA", + "LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST": "PUBLIC_BETA", + "LLM_JUDGE_MISSING_JOIN": "PUBLIC_BETA", + "LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION": "PUBLIC_BETA", + "LLM_JUDGE_MISSING_OR_INCORRECT_FILTER": "PUBLIC_BETA", + "LLM_JUDGE_MISSING_OR_INCORRECT_JOIN": "PUBLIC_BETA", + "LLM_JUDGE_OTHER": "PUBLIC_BETA", + "LLM_JUDGE_SEMANTIC_ERROR": "PUBLIC_BETA", + "LLM_JUDGE_SYNTAX_ERROR": "PUBLIC_BETA", + "LLM_JUDGE_WRONG_AGGREGATION": "PUBLIC_BETA", + "LLM_JUDGE_WRONG_COLUMNS": "PUBLIC_BETA", + "LLM_JUDGE_WRONG_FILTER": "PUBLIC_BETA", + "RESULT_EXTRA_COLUMNS": "PUBLIC_BETA", + "RESULT_EXTRA_ROWS": "PUBLIC_BETA", + "RESULT_MISSING_COLUMNS": "PUBLIC_BETA", + "RESULT_MISSING_ROWS": "PUBLIC_BETA", + "SINGLE_CELL_DIFFERENCE": "PUBLIC_BETA" + } + }, + "dashboards.Subscriber": { + "fields": { + "destination_subscriber": { + "description": "The destination to receive the subscription email.\nThis parameter is mutually exclusive with `user_subscriber`.", + "ref": "dashboards.SubscriptionSubscriberDestination", + "launch_stage": "GA" + }, + "user_subscriber": { + "description": "The user to receive the subscription email.\nThis parameter is mutually exclusive with `destination_subscriber`.", + "ref": "dashboards.SubscriptionSubscriberUser", + "launch_stage": "GA" + } + } + }, + "dashboards.Subscription": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the subscription was created.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by_user_id": { + "description": "UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "dashboard_id": { + "description": "UUID identifying the dashboard to which the subscription belongs.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "etag": { + "description": "The etag for the subscription. Must be left empty on create, can be optionally provided on delete\nto ensure that the subscription has not been deleted since the last read.", + "launch_stage": "GA" + }, + "schedule_id": { + "description": "UUID identifying the schedule to which the subscription belongs.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "skip_notify": { + "description": "Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.\nIf not defined, defaults to false in the backend to match the current behavior (refresh and notify)", + "launch_stage": "GA" + }, + "subscriber": { + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "ref": "dashboards.Subscriber", + "launch_stage": "GA" + }, + "subscription_id": { + "description": "UUID identifying the subscription.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the subscription was last updated.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.SubscriptionSubscriberDestination": { + "fields": { + "destination_id": { + "description": "The canonical identifier of the destination to receive email notification.", + "launch_stage": "GA" + } + } + }, + "dashboards.SubscriptionSubscriberUser": { + "fields": { + "user_id": { + "description": "UserId of the subscriber.", + "launch_stage": "GA" + } + } + }, + "dashboards.TextAttachment": { + "fields": { + "content": { + "description": "AI generated message", + "launch_stage": "GA" + }, + "id": { + "launch_stage": "GA" + }, + "purpose": { + "description": "Purpose/intent of this text attachment", + "ref": "dashboards.TextAttachmentPurpose", + "launch_stage": "GA" + } + } + }, + "dashboards.TextAttachmentPurpose": { + "description": "Purpose/intent of a text attachment", + "enum": [ + "FOLLOW_UP_QUESTION" + ], + "enum_launch_stages": { + "FOLLOW_UP_QUESTION": "GA" + } + }, + "dashboards.Thought": { + "description": "A single thought in the AI's reasoning process for a query.", + "fields": { + "content": { + "description": "The md formatted content for this thought.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "thought_type": { + "description": "The category of this thought.\nThe possible values are:\n* `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question was interpreted.\n* `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were resolved.\n* `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as relevant.\n* `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were referenced.\n* `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer.", + "ref": "dashboards.ThoughtType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dashboards.ThoughtType": { + "description": "ThoughtType.\nThe possible values are:\n* `THOUGHT_TYPE_UNSPECIFIED`: Default value that should not be used.\n* `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question was interpreted.\n* `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were resolved.\n* `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as relevant.\n* `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were referenced.\n* `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer.\nThe category of a Thought.\nAdditional values may be added in the future.", + "enum": [ + "THOUGHT_TYPE_DESCRIPTION", + "THOUGHT_TYPE_UNDERSTANDING", + "THOUGHT_TYPE_DATA_SOURCING", + "THOUGHT_TYPE_INSTRUCTIONS", + "THOUGHT_TYPE_STEPS" + ], + "enum_launch_stages": { + "THOUGHT_TYPE_DATA_SOURCING": "PUBLIC_PREVIEW", + "THOUGHT_TYPE_DESCRIPTION": "PUBLIC_PREVIEW", + "THOUGHT_TYPE_INSTRUCTIONS": "PUBLIC_PREVIEW", + "THOUGHT_TYPE_STEPS": "PUBLIC_PREVIEW", + "THOUGHT_TYPE_UNDERSTANDING": "PUBLIC_PREVIEW" + }, + "enum_descriptions": { + "THOUGHT_TYPE_DATA_SOURCING": "Which tables or datasets were identified as relevant.", + "THOUGHT_TYPE_DESCRIPTION": "A high-level description of how the question was interpreted.", + "THOUGHT_TYPE_INSTRUCTIONS": "Which author-defined instructions were referenced.", + "THOUGHT_TYPE_STEPS": "The logical steps taken to compute the answer.", + "THOUGHT_TYPE_UNDERSTANDING": "How ambiguous parts of the question were resolved." + } + }, + "dashboards.TrashDashboardResponse": {}, + "dashboards.UnpublishDashboardResponse": {}, + "database.CustomTag": { + "fields": { + "key": { + "description": "The key of the custom tag.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "value": { + "description": "The value of the custom tag.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.DatabaseCatalog": { + "fields": { + "create_database_if_not_exists": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "database_instance_name": { + "description": "The name of the DatabaseInstance housing the database.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "database_name": { + "description": "The name of the database (in a instance) associated with the catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The name of the catalog in UC.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "uid": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.DatabaseCredential": { + "fields": { + "expiration_time": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.DatabaseInstance": { + "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", + "fields": { + "capacity": { + "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "child_instance_refs": { + "description": "The refs of the child instances. This is only available if the instance is\nparent instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creation_time": { + "description": "The timestamp when the instance was created.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The email of the creator of the instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "custom_tags": { + "description": "Custom tags associated with the instance. This field is only included on create and update responses.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "effective_capacity": { + "description": "Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_custom_tags": { + "description": "The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_enable_pg_native_login": { + "description": "Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_enable_readable_secondaries": { + "description": "Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_stopped": { + "description": "Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_usage_policy_id": { + "description": "The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "enable_pg_native_login": { + "description": "Whether to enable PG native password login on the instance. Defaults to false.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "enable_readable_secondaries": { + "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "name": { + "description": "The name of the instance. This is the unique identifier for the instance.", + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "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": "database.DatabaseInstanceRef", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + }, + "pg_version": { + "description": "The version of Postgres running on the instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "read_only_dns": { + "description": "The DNS endpoint to connect to the instance for read only access. This is only available if\nenable_readable_secondaries is true.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "read_write_dns": { + "description": "The DNS endpoint to connect to the instance for read+write access.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "state": { + "description": "The current state of the instance.", + "ref": "database.DatabaseInstanceState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "stopped": { + "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "uid": { + "description": "An immutable UUID identifier for the instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "description": "The desired usage policy to associate with the instance.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + } + } + }, + "database.DatabaseInstanceRef": { + "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.", + "fields": { + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_lsn": { + "description": "For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "name": { + "description": "Name of the ref database instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "uid": { + "description": "Id of the ref database instance.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.DatabaseInstanceRole": { + "description": "A DatabaseInstanceRole represents a Postgres role in a database instance.", + "fields": { + "attributes": { + "description": "The desired API-exposed Postgres role attribute to associate with the role. Optional.", + "ref": "database.DatabaseInstanceRoleAttributes", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_attributes": { + "description": "The attributes that are applied to the role.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "ref": "database.DatabaseInstanceRoleAttributes", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "identity_type": { + "description": "The type of the role.", + "ref": "database.DatabaseInstanceRoleIdentityType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "instance_name": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "membership_role": { + "description": "An enum value for a standard role that this role is a member of.", + "ref": "database.DatabaseInstanceRoleMembershipRole", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "database.DatabaseInstanceRoleAttributes": { + "description": "Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref:\nhttps://www.postgresql.org/docs/16/sql-createrole.html\nThe values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical\nunderscores between words. We were requested to make this a nested object/struct representation since these are\nknobs from an external spec.", + "fields": { + "bypassrls": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "createdb": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "createrole": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.DatabaseInstanceRoleIdentityType": { + "enum": [ + "PG_ONLY", + "USER", + "SERVICE_PRINCIPAL", + "GROUP" + ], + "enum_launch_stages": { + "GROUP": "PRIVATE_PREVIEW", + "PG_ONLY": "PRIVATE_PREVIEW", + "SERVICE_PRINCIPAL": "PRIVATE_PREVIEW", + "USER": "PRIVATE_PREVIEW" + } + }, + "database.DatabaseInstanceRoleMembershipRole": { + "description": "Roles that the DatabaseInstanceRole can be a member of.", + "enum": [ + "DATABRICKS_SUPERUSER" + ], + "enum_launch_stages": { + "DATABRICKS_SUPERUSER": "PRIVATE_PREVIEW" + } + }, + "database.DatabaseInstanceState": { + "enum": [ + "STARTING", + "AVAILABLE", + "DELETING", + "STOPPED", + "UPDATING", + "FAILING_OVER" + ], + "enum_launch_stages": { + "AVAILABLE": "PUBLIC_PREVIEW", + "DELETING": "PUBLIC_PREVIEW", + "FAILING_OVER": "PUBLIC_PREVIEW", + "STARTING": "PUBLIC_PREVIEW", + "STOPPED": "PUBLIC_PREVIEW", + "UPDATING": "PUBLIC_PREVIEW" + } + }, + "database.DatabaseTable": { + "fields": { + "database_instance_name": { + "description": "Name of the target database instance. This is required when creating database tables in standard catalogs.\nThis is optional when creating database tables in registered catalogs. If this field is specified\nwhen creating database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", + "launch_stage": "PUBLIC_PREVIEW" + }, + "logical_database_name": { + "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\n\nRegistration of database tables via /database/tables is currently only supported in standard catalogs.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Full three-part (catalog, schema, table) name of the table.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.DeltaTableSyncInfo": { + "fields": { + "delta_commit_timestamp": { + "description": "The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "delta_commit_version": { + "description": "The Delta Lake commit version that was last successfully synced.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.GenerateDatabaseCredentialRequest": { + "description": "Generates a credential that can be used to access database instances", + "fields": { + "claims": { + "description": "A set of UC permissions to add to the credential. We verify that the caller has the necessary\npermissions in UC and include a reference in the token. Postgres uses that token to give the\nconnecting user additional grants to the Postgres resources that correspond to the UC resources.\nThe UC resources need to be something that have a Postgres counterpart. For example, a synced table or\na table in a UC database catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "instance_names": { + "description": "Instances to request a credential for. At least one of instance_names or claims must be specified.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "request_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.ListDatabaseCatalogsResponse": { + "fields": { + "database_catalogs": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "Pagination token to request the next page of database catalogs.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "database.ListDatabaseInstanceRolesResponse": { + "fields": { + "database_instance_roles": { + "description": "List of database instance roles.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "next_page_token": { + "description": "Pagination token to request the next page of instances.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.ListDatabaseInstancesResponse": { + "fields": { + "database_instances": { + "description": "List of instances.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "description": "Pagination token to request the next page of instances.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.ListSyncedDatabaseTablesResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of synced tables.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "synced_tables": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "database.NewPipelineSpec": { + "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", + "fields": { + "budget_policy_id": { + "description": "Budget policy to set on the newly created pipeline.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.ProvisioningInfoState": { + "enum": [ + "PROVISIONING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING", + "DEGRADED" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_PREVIEW", + "DEGRADED": "PUBLIC_PREVIEW", + "DELETING": "PUBLIC_PREVIEW", + "FAILED": "PUBLIC_PREVIEW", + "PROVISIONING": "PUBLIC_PREVIEW", + "UPDATING": "PUBLIC_PREVIEW" + } + }, + "database.ProvisioningPhase": { + "enum": [ + "PROVISIONING_PHASE_MAIN", + "PROVISIONING_PHASE_INDEX_SCAN", + "PROVISIONING_PHASE_INDEX_SORT" + ], + "enum_launch_stages": { + "PROVISIONING_PHASE_INDEX_SCAN": "PUBLIC_PREVIEW", + "PROVISIONING_PHASE_INDEX_SORT": "PUBLIC_PREVIEW", + "PROVISIONING_PHASE_MAIN": "PUBLIC_PREVIEW" + } + }, + "database.RequestedClaims": { + "fields": { + "permission_set": { + "ref": "database.RequestedClaimsPermissionSet", + "launch_stage": "PUBLIC_PREVIEW" + }, + "resources": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.RequestedClaimsPermissionSet": { + "description": "Might add WRITE in the future", + "enum": [ + "READ_ONLY" + ], + "enum_launch_stages": { + "READ_ONLY": "PUBLIC_PREVIEW" + } + }, + "database.RequestedResource": { + "fields": { + "table_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "unspecified_resource_name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.SyncedDatabaseTable": { + "fields": { + "data_synchronization_status": { + "description": "Synced Table data synchronization status", + "ref": "database.SyncedTableStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "database_instance_name": { + "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "effective_database_instance_name": { + "description": "The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_logical_database_name": { + "description": "The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "logical_database_name": { + "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "name": { + "description": "Full three-part (catalog, schema, table) name of the table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "spec": { + "ref": "database.SyncedTableSpec", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "unity_catalog_provisioning_state": { + "description": "The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).", + "ref": "database.ProvisioningInfoState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTableContinuousUpdateStatus": { + "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.", + "fields": { + "initial_pipeline_sync_progress": { + "description": "Progress of the initial data synchronization.", + "ref": "database.SyncedTablePipelineProgress", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_processed_commit_version": { + "description": "The last source table Delta version that was successfully synced to the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "timestamp": { + "description": "The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTableFailedStatus": { + "description": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", + "fields": { + "last_processed_commit_version": { + "description": "The last source table Delta version that was successfully synced to the synced table.\nThe last source table Delta version that was synced to the synced table.\nOnly populated if the table is still\nsynced and available for serving.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "timestamp": { + "description": "The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. Only populated if the table is still synced and available for serving.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTablePipelineProgress": { + "description": "Progress information of the Synced Table data synchronization pipeline.", + "fields": { + "estimated_completion_time_seconds": { + "description": "The estimated time remaining to complete this update in seconds.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "latest_version_currently_processing": { + "description": "The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "provisioning_phase": { + "description": "The current phase of the data synchronization pipeline.", + "ref": "database.ProvisioningPhase", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_progress_completion": { + "description": "The completion ratio of this update. This is a number between 0 and 1.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "synced_row_count": { + "description": "The number of rows that have been synced in this update.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "total_row_count": { + "description": "The total number of rows that need to be synced in this update. This number may be an estimate.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTablePosition": { + "fields": { + "delta_table_sync_info": { + "ref": "database.DeltaTableSyncInfo", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_end_timestamp": { + "description": "The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_start_timestamp": { + "description": "The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTableProvisioningStatus": { + "description": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "fields": { + "initial_pipeline_sync_progress": { + "description": "Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state.", + "ref": "database.SyncedTablePipelineProgress", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "database.SyncedTableSchedulingPolicy": { + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ], + "enum_launch_stages": { + "CONTINUOUS": "PUBLIC_PREVIEW", + "SNAPSHOT": "PUBLIC_PREVIEW", + "TRIGGERED": "PUBLIC_PREVIEW" + } + }, + "database.SyncedTableSpec": { + "description": "Specification of a synced database table.", + "fields": { + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "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": "database.NewPipelineSpec", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "primary_key_columns": { + "description": "Primary Key columns to be used for data insert/update in the destination.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "scheduling_policy": { + "description": "Scheduling policy of the underlying pipeline.", + "ref": "database.SyncedTableSchedulingPolicy", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source_table_full_name": { + "description": "Three-part (catalog, schema, table) name of the source Delta table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "timeseries_key": { + "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.SyncedTableState": { + "description": "The state of a synced table.", + "enum": [ + "SYNCED_TABLE_PROVISIONING", + "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES", + "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT", + "SYNCED_TABLE_ONLINE", + "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE", + "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE", + "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE", + "SYNCED_TABLED_OFFLINE", + "SYNCED_TABLE_OFFLINE_FAILED", + "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", + "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "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" + } + }, + "database.SyncedTableStatus": { + "description": "Status of a synced table.", + "fields": { + "continuous_update_status": { + "ref": "database.SyncedTableContinuousUpdateStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "detailed_state": { + "description": "The state of the synced table.", + "ref": "database.SyncedTableState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "failed_status": { + "ref": "database.SyncedTableFailedStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "last_sync": { + "description": "Summary of the last successful synchronization from source to destination.\n\nWill always be present if there has been a successful sync. Even if the most recent syncs have failed.\n\nLimitation:\nThe only exception is if the synced table is doing a FULL REFRESH, then the last sync information\nwill not be available until the full refresh is complete. This limitation will be addressed in a future version.\n\nThis top-level field is a convenience for consumers who want easy access to last sync information\nwithout having to traverse detailed_status.", + "ref": "database.SyncedTablePosition", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "A text description of the current state of the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pipeline_id": { + "description": "ID of the associated pipeline. The pipeline ID may have been provided by the client\n(in the case of bin packing), or generated by the server (when creating a new pipeline).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "provisioning_status": { + "ref": "database.SyncedTableProvisioningStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "triggered_update_status": { + "ref": "database.SyncedTableTriggeredUpdateStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.SyncedTableTriggeredUpdateStatus": { + "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.", + "fields": { + "last_processed_commit_version": { + "description": "The last source table Delta version that was successfully synced to the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "timestamp": { + "description": "The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "triggered_update_progress": { + "description": "Progress of the active data synchronization pipeline.", + "ref": "database.SyncedTablePipelineProgress", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dataclassification.AutoTaggingConfig": { + "description": "Auto-tagging configuration for a classification tag.\nWhen enabled, detected columns are automatically tagged with Unity Catalog\ntags.", + "fields": { + "auto_tagging_mode": { + "description": "Whether auto-tagging is enabled or disabled for this classification tag.", + "ref": "dataclassification.AutoTaggingConfigAutoTaggingMode", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "classification_tag": { + "description": "The Classification Tag. For built-in classes this is a system tag (e.g., \"class.name\",\n\"class.location\"); for custom classes it is a user-defined governance tag key.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataclassification.AutoTaggingConfigAutoTaggingMode": { + "description": "Auto-tagging mode.", + "enum": [ + "AUTO_TAGGING_DISABLED", + "AUTO_TAGGING_ENABLED" + ], + "enum_launch_stages": { + "AUTO_TAGGING_DISABLED": "PUBLIC_BETA", + "AUTO_TAGGING_ENABLED": "PUBLIC_BETA" + } + }, + "dataclassification.CatalogConfig": { + "description": "Data Classification configuration for a Unity Catalog catalog. This message follows the \"At Most One Resource\" pattern: at most one CatalogConfig exists per catalog.\n- Full CRUD operations are supported: Create enables Data Classification, Delete disables it\n- It has no unique identifier of its own and uses its parent catalog's identifier (catalog_name)", + "fields": { + "auto_tag_configs": { + "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "included_schemas": { + "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If `included_schemas` is not set, all schemas are scanned.", + "ref": "dataclassification.CatalogConfigSchemaNames", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dataclassification.CatalogConfigSchemaNames": { + "description": "Wrapper message for a list of schema names.", + "fields": { + "names": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataquality.AggregationGranularity": { + "description": "The granularity for aggregating data into time windows based on their timestamp.", + "enum": [ + "AGGREGATION_GRANULARITY_5_MINUTES", + "AGGREGATION_GRANULARITY_30_MINUTES", + "AGGREGATION_GRANULARITY_1_HOUR", + "AGGREGATION_GRANULARITY_1_DAY", + "AGGREGATION_GRANULARITY_1_WEEK", + "AGGREGATION_GRANULARITY_2_WEEKS", + "AGGREGATION_GRANULARITY_3_WEEKS", + "AGGREGATION_GRANULARITY_4_WEEKS", + "AGGREGATION_GRANULARITY_1_MONTH", + "AGGREGATION_GRANULARITY_1_YEAR" + ], + "enum_launch_stages": { + "AGGREGATION_GRANULARITY_1_DAY": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_1_HOUR": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_1_MONTH": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_1_WEEK": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_1_YEAR": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_2_WEEKS": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_30_MINUTES": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_3_WEEKS": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_4_WEEKS": "PUBLIC_PREVIEW", + "AGGREGATION_GRANULARITY_5_MINUTES": "PUBLIC_PREVIEW" + } + }, + "dataquality.AnomalyDetectionConfig": { + "description": "Anomaly Detection Configurations.", + "fields": { + "excluded_table_full_names": { + "description": "List of fully qualified table names to exclude from anomaly detection.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dataquality.CancelRefreshRequest": { + "description": "Request to cancel a refresh." + }, + "dataquality.CancelRefreshResponse": { + "description": "Response to cancelling a refresh.", + "fields": { + "refresh": { + "description": "The refresh to cancel.", + "ref": "dataquality.Refresh", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dataquality.CronSchedule": { + "description": "The data quality monitoring workflow cron schedule.", + "fields": { + "pause_status": { + "description": "Read only field that indicates whether the schedule is paused or not.", + "ref": "dataquality.CronSchedulePauseStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "quartz_cron_expression": { + "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "timezone_id": { + "description": "A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataquality.CronSchedulePauseStatus": { + "description": "The data quality monitoring workflow cron schedule pause status.", + "enum": [ + "CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED", + "CRON_SCHEDULE_PAUSE_STATUS_PAUSED" + ], + "enum_launch_stages": { + "CRON_SCHEDULE_PAUSE_STATUS_PAUSED": "PUBLIC_PREVIEW", + "CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED": "PUBLIC_PREVIEW" + } + }, + "dataquality.DataProfilingConfig": { + "description": "Data Profiling Configurations.", + "fields": { + "assets_dir": { + "description": "Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "baseline_table_name": { + "description": "Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_metrics": { + "description": "Custom metrics.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "dashboard_id": { + "description": "Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "drift_metrics_table_name": { + "description": "Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_warehouse_id": { + "description": "The warehouse for dashboard creation", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "inference_log": { + "description": "`Analysis Configuration` for monitoring inference log tables.", + "ref": "dataquality.InferenceLogConfig", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "latest_monitor_failure_message": { + "description": "The latest error message for a monitor failure.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "monitor_version": { + "description": "Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "monitored_table_name": { + "description": "Unity Catalog table to monitor. Format: `catalog.schema.table_name`", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "notification_settings": { + "description": "Field for specifying notification settings.", + "ref": "dataquality.NotificationSettings", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "output_schema_id": { + "description": "ID of the schema where output tables are created.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "profile_metrics_table_name": { + "description": "Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "schedule": { + "description": "The cron schedule.", + "ref": "dataquality.CronSchedule", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "skip_builtin_dashboard": { + "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "slicing_exprs": { + "description": "List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "snapshot": { + "description": "`Analysis Configuration` for monitoring snapshot tables.", + "ref": "dataquality.SnapshotConfig", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "status": { + "description": "The data profiling monitor status.", + "ref": "dataquality.DataProfilingStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "time_series": { + "description": "`Analysis Configuration` for monitoring time series tables.", + "ref": "dataquality.TimeSeriesConfig", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "warehouse_id": { + "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dataquality.DataProfilingCustomMetric": { + "description": "Custom metric definition.", + "fields": { + "definition": { + "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "input_columns": { + "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "name": { + "description": "Name of the metric in the output tables.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "output_data_type": { + "description": "The output type of the custom metric.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "type": { + "description": "The type of the custom metric.", + "ref": "dataquality.DataProfilingCustomMetricType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataquality.DataProfilingCustomMetricType": { + "description": "The custom metric type.", + "enum": [ + "DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT" + ], + "enum_launch_stages": { + "DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE": "PUBLIC_PREVIEW", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED": "PUBLIC_PREVIEW", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT": "PUBLIC_PREVIEW" + } + }, + "dataquality.DataProfilingStatus": { + "description": "The status of the data profiling monitor.", + "enum": [ + "DATA_PROFILING_STATUS_ACTIVE", + "DATA_PROFILING_STATUS_PENDING", + "DATA_PROFILING_STATUS_DELETE_PENDING", + "DATA_PROFILING_STATUS_ERROR", + "DATA_PROFILING_STATUS_FAILED" + ], + "enum_launch_stages": { + "DATA_PROFILING_STATUS_ACTIVE": "PUBLIC_PREVIEW", + "DATA_PROFILING_STATUS_DELETE_PENDING": "PUBLIC_PREVIEW", + "DATA_PROFILING_STATUS_ERROR": "PUBLIC_PREVIEW", + "DATA_PROFILING_STATUS_FAILED": "PUBLIC_PREVIEW", + "DATA_PROFILING_STATUS_PENDING": "PUBLIC_PREVIEW" + } + }, + "dataquality.InferenceLogConfig": { + "description": "Inference log configuration.", + "fields": { + "granularities": { + "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "label_column": { + "description": "Column for the label.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "model_id_column": { + "description": "Column for the model identifier.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "prediction_column": { + "description": "Column for the prediction.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "problem_type": { + "description": "Problem type the model aims to solve.", + "ref": "dataquality.InferenceProblemType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "timestamp_column": { + "description": "Column for the timestamp.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataquality.InferenceProblemType": { + "description": "Inference problem type the model aims to solve.", + "enum": [ + "INFERENCE_PROBLEM_TYPE_CLASSIFICATION", + "INFERENCE_PROBLEM_TYPE_REGRESSION" + ], + "enum_launch_stages": { + "INFERENCE_PROBLEM_TYPE_CLASSIFICATION": "PUBLIC_PREVIEW", + "INFERENCE_PROBLEM_TYPE_REGRESSION": "PUBLIC_PREVIEW" + } + }, + "dataquality.ListMonitorResponse": { + "description": "Response for listing Monitors.", + "fields": { + "monitors": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dataquality.ListRefreshResponse": { + "description": "Response for listing refreshes.", + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "refreshes": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dataquality.Monitor": { + "description": "Monitor for the data quality of unity catalog entities such as schema or table.", + "fields": { + "anomaly_detection_config": { + "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "ref": "dataquality.AnomalyDetectionConfig", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "data_profiling_config": { + "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "ref": "dataquality.DataProfilingConfig", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "object_id": { + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "object_type": { + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "dataquality.NotificationDestination": { + "description": "Destination of the data quality monitoring notification.", + "fields": { + "email_addresses": { + "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dataquality.NotificationSettings": { + "description": "Settings for sending notifications on the data quality monitoring.", + "fields": { + "on_failure": { + "description": "Destinations to send notifications on failure/timeout.", + "ref": "dataquality.NotificationDestination", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dataquality.Refresh": { + "description": "The Refresh object gives information on a refresh of the data quality monitoring pipeline.", + "fields": { + "end_time_ms": { + "description": "Time when the refresh ended (milliseconds since 1/1/1970 UTC).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "An optional message to give insight into the current state of the refresh (e.g. FAILURE messages).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "object_id": { + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "object_type": { + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "refresh_id": { + "description": "Unique id of the refresh operation.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "start_time_ms": { + "description": "Time when the refresh started (milliseconds since 1/1/1970 UTC).", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "The current state of the refresh.", + "ref": "dataquality.RefreshState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "trigger": { + "description": "What triggered the refresh.", + "ref": "dataquality.RefreshTrigger", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "dataquality.RefreshState": { + "description": "The state of the refresh.", + "enum": [ + "MONITOR_REFRESH_STATE_UNKNOWN", + "MONITOR_REFRESH_STATE_PENDING", + "MONITOR_REFRESH_STATE_RUNNING", + "MONITOR_REFRESH_STATE_SUCCESS", + "MONITOR_REFRESH_STATE_FAILED", + "MONITOR_REFRESH_STATE_CANCELED" + ], + "enum_launch_stages": { + "MONITOR_REFRESH_STATE_CANCELED": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_STATE_FAILED": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_STATE_PENDING": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_STATE_RUNNING": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_STATE_SUCCESS": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_STATE_UNKNOWN": "PUBLIC_PREVIEW" + } + }, + "dataquality.RefreshTrigger": { + "description": "The trigger of the refresh.", + "enum": [ + "MONITOR_REFRESH_TRIGGER_UNKNOWN", + "MONITOR_REFRESH_TRIGGER_MANUAL", + "MONITOR_REFRESH_TRIGGER_SCHEDULE", + "MONITOR_REFRESH_TRIGGER_DATA_CHANGE" + ], + "enum_launch_stages": { + "MONITOR_REFRESH_TRIGGER_DATA_CHANGE": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_TRIGGER_MANUAL": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_TRIGGER_SCHEDULE": "PUBLIC_PREVIEW", + "MONITOR_REFRESH_TRIGGER_UNKNOWN": "PUBLIC_PREVIEW" + } + }, + "dataquality.SnapshotConfig": { + "description": "Snapshot analysis configuration." + }, + "dataquality.TimeSeriesConfig": { + "description": "Time series analysis configuration.", + "fields": { + "granularities": { + "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "timestamp_column": { + "description": "Column for the timestamp.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.FailoverFailoverGroupRequest": { + "description": "Request to failover a failover group to a new primary region.", + "fields": { + "etag": { + "description": "Opaque version string for optimistic locking. If provided, must match the\ncurrent etag. If omitted, the failover proceeds regardless of current state.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "failover_type": { + "description": "The type of failover to perform.", + "ref": "disasterrecovery.FailoverFailoverGroupRequestFailoverType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "target_primary_region": { + "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.FailoverFailoverGroupRequestFailoverType": { + "description": "The type of failover to perform.", + "enum": [ + "FORCED" + ], + "enum_launch_stages": { + "FORCED": "PRIVATE_PREVIEW" + } + }, + "disasterrecovery.FailoverGroup": { + "description": "A failover group manages disaster recovery across workspace sets,\ncoordinating UCDR and CPDR replication.", + "fields": { + "create_time": { + "description": "Time at which this failover group was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_primary_region": { + "description": "Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "etag": { + "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "initial_primary_region": { + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "INPUT_ONLY", + "IMMUTABLE" + ] + }, + "name": { + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "regions": { + "description": "List of all regions participating in this failover group.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "replication_point": { + "description": "The latest point in time to which data has been replicated.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "Aggregate state of the failover group.", + "ref": "disasterrecovery.FailoverGroupState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "unity_catalog_assets": { + "description": "Unity Catalog replication configuration.", + "ref": "disasterrecovery.UcReplicationConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "Time at which this failover group was last modified.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "workspace_sets": { + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.FailoverGroupState": { + "description": "The aggregate state of a FailoverGroup.", + "enum": [ + "CREATING", + "CREATION_FAILED", + "INITIAL_REPLICATION", + "ACTIVE", + "FAILING_OVER", + "DELETING", + "FAILOVER_FAILED", + "DELETION_FAILED" + ], + "enum_launch_stages": { + "ACTIVE": "PRIVATE_PREVIEW", + "CREATING": "PRIVATE_PREVIEW", + "CREATION_FAILED": "PRIVATE_PREVIEW", + "DELETING": "PRIVATE_PREVIEW", + "DELETION_FAILED": "PRIVATE_PREVIEW", + "FAILING_OVER": "PRIVATE_PREVIEW", + "FAILOVER_FAILED": "PRIVATE_PREVIEW", + "INITIAL_REPLICATION": "PRIVATE_PREVIEW" + } + }, + "disasterrecovery.ListFailoverGroupsResponse": { + "description": "Response for listing failover groups.", + "fields": { + "failover_groups": { + "description": "The failover groups for this account.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "A token that can be sent as page_token to retrieve the next page.\nIf omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "disasterrecovery.ListStableUrlsResponse": { + "description": "Response for listing stable URLs.", + "fields": { + "next_page_token": { + "description": "A token that can be sent as page_token to retrieve the next page.\nIf omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "stable_urls": { + "description": "The stable URLs for this account.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "disasterrecovery.LocationMapping": { + "description": "A location mapping identified by a name, with URIs per region.\nThe system derives replication direction from effective_primary_region.", + "fields": { + "name": { + "description": "Resource name for this location.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "uri_by_region": { + "description": "URI for each region. Each entry maps a region name to a storage URI.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.LocationMappingEntry": { + "description": "A single entry in a location mapping, mapping a region to a storage URI.\nUsed instead of map\u003cstring, string\u003e for proto2 compatibility.", + "fields": { + "region": { + "description": "The region name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "uri": { + "description": "The storage URI for this region.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.StableUrl": { + "description": "A stable URL provides a failover-aware endpoint for accessing a workspace.\nIts lifecycle is independent of any failover group.", + "fields": { + "failover_group_name": { + "description": "Fully qualified resource name of the FailoverGroup this stable URL is\ncurrently linked to, in the format\n`accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when\nthe stable URL is not attached to any failover group. Server-controlled:\nwritten by CreateFailoverGroup / UpdateFailoverGroup on link, cleared by\nDeleteFailoverGroup / UpdateFailoverGroup on unlink.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "initial_workspace_id": { + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "INPUT_ONLY", + "IMMUTABLE" + ] + }, + "name": { + "description": "Fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "url": { + "description": "The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + } + } + }, + "disasterrecovery.UcCatalog": { + "description": "A Unity Catalog catalog to replicate.", + "fields": { + "name": { + "description": "The name of the UC catalog to replicate.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "disasterrecovery.UcReplicationConfig": { + "description": "Unity Catalog replication configuration (top-level, not per-set).", + "fields": { + "catalogs": { + "description": "UC catalogs to replicate.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "data_replication_workspace_set": { + "description": "The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "location_mappings": { + "description": "Location mappings - storage URI per region for each location.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "disasterrecovery.WorkspaceSet": { + "description": "A set of workspaces that replicate to each other across regions.", + "fields": { + "name": { + "description": "Resource name for this workspace set.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "replicate_workspace_assets": { + "description": "Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nRequires all workspaces in the set to be Mission Critical tier.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "stable_url_names": { + "description": "Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "workspace_ids": { + "description": "Workspace IDs in this set. The system derives and validates regions.\nEA: exactly 2 workspaces (one per region).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "environments.BaseEnvironmentType": { + "description": "If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto", + "enum": [ + "CPU", + "GPU" + ], + "enum_launch_stages": { + "CPU": "GA", + "GPU": "GA" + } + }, + "environments.DatabricksServiceExceptionWithDetailsProto": { + "description": "Databricks Error that is returned by all Databricks APIs.", + "fields": { + "details": { + "launch_stage": "GA" + }, + "error_code": { + "ref": "environments.ErrorCode", + "launch_stage": "GA" + }, + "message": { + "launch_stage": "GA" + }, + "stack_trace": { + "launch_stage": "GA" + } + } + }, + "environments.DefaultWorkspaceBaseEnvironment": { + "description": "A singleton resource representing the default workspace base environment configuration.\nThis resource contains the workspace base environments that are used as defaults\nfor serverless notebooks and jobs in the workspace, for both CPU and GPU compute types.", + "fields": { + "cpu_workspace_base_environment": { + "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "gpu_workspace_base_environment": { + "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + } + } + }, + "environments.ErrorCode": { + "description": "Error codes returned by Databricks APIs to indicate specific failure conditions.", + "enum": [ + "UNKNOWN", + "INTERNAL_ERROR", + "TEMPORARILY_UNAVAILABLE", + "IO_ERROR", + "BAD_REQUEST", + "SERVICE_UNDER_MAINTENANCE", + "WORKSPACE_TEMPORARILY_UNAVAILABLE", + "DEADLINE_EXCEEDED", + "CANCELLED", + "RESOURCE_EXHAUSTED", + "ABORTED", + "NOT_FOUND", + "ALREADY_EXISTS", + "UNAUTHENTICATED", + "UNAVAILABLE", + "INVALID_PARAMETER_VALUE", + "ENDPOINT_NOT_FOUND", + "MALFORMED_REQUEST", + "INVALID_STATE", + "PERMISSION_DENIED", + "FEATURE_DISABLED", + "CUSTOMER_UNAUTHORIZED", + "REQUEST_LIMIT_EXCEEDED", + "RESOURCE_CONFLICT", + "UNPARSEABLE_HTTP_ERROR", + "NOT_IMPLEMENTED", + "DATA_LOSS", + "INVALID_STATE_TRANSITION", + "COULD_NOT_ACQUIRE_LOCK", + "RESOURCE_ALREADY_EXISTS", + "RESOURCE_DOES_NOT_EXIST", + "QUOTA_EXCEEDED", + "MAX_BLOCK_SIZE_EXCEEDED", + "MAX_READ_SIZE_EXCEEDED", + "PARTIAL_DELETE", + "MAX_LIST_SIZE_EXCEEDED", + "DRY_RUN_FAILED", + "RESOURCE_LIMIT_EXCEEDED", + "DIRECTORY_NOT_EMPTY", + "DIRECTORY_PROTECTED", + "MAX_NOTEBOOK_SIZE_EXCEEDED", + "MAX_CHILD_NODE_SIZE_EXCEEDED", + "SEARCH_QUERY_TOO_LONG", + "SEARCH_QUERY_TOO_SHORT", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST", + "PERMISSION_NOT_PROPAGATED", + "DEPLOYMENT_TIMEOUT", + "GIT_CONFLICT", + "GIT_UNKNOWN_REF", + "GIT_SENSITIVE_TOKEN_DETECTED", + "GIT_URL_NOT_ON_ALLOW_LIST", + "GIT_REMOTE_ERROR", + "PROJECTS_OPERATION_TIMEOUT", + "IPYNB_FILE_IN_REPO", + "INSECURE_PARTNER_RESPONSE", + "MALFORMED_PARTNER_RESPONSE", + "METASTORE_DOES_NOT_EXIST", + "DAC_DOES_NOT_EXIST", + "CATALOG_DOES_NOT_EXIST", + "SCHEMA_DOES_NOT_EXIST", + "TABLE_DOES_NOT_EXIST", + "SHARE_DOES_NOT_EXIST", + "RECIPIENT_DOES_NOT_EXIST", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST", + "EXTERNAL_LOCATION_DOES_NOT_EXIST", + "PRINCIPAL_DOES_NOT_EXIST", + "PROVIDER_DOES_NOT_EXIST", + "METASTORE_ALREADY_EXISTS", + "DAC_ALREADY_EXISTS", + "CATALOG_ALREADY_EXISTS", + "SCHEMA_ALREADY_EXISTS", + "TABLE_ALREADY_EXISTS", + "SHARE_ALREADY_EXISTS", + "RECIPIENT_ALREADY_EXISTS", + "STORAGE_CREDENTIAL_ALREADY_EXISTS", + "EXTERNAL_LOCATION_ALREADY_EXISTS", + "PROVIDER_ALREADY_EXISTS", + "CATALOG_NOT_EMPTY", + "SCHEMA_NOT_EMPTY", + "METASTORE_NOT_EMPTY", + "PROVIDER_SHARE_NOT_ACCESSIBLE" + ], + "enum_launch_stages": { + "ABORTED": "GA", + "ALREADY_EXISTS": "GA", + "BAD_REQUEST": "GA", + "CANCELLED": "GA", + "CATALOG_ALREADY_EXISTS": "GA", + "CATALOG_DOES_NOT_EXIST": "GA", + "CATALOG_NOT_EMPTY": "GA", + "COULD_NOT_ACQUIRE_LOCK": "GA", + "CUSTOMER_UNAUTHORIZED": "GA", + "DAC_ALREADY_EXISTS": "GA", + "DAC_DOES_NOT_EXIST": "GA", + "DATA_LOSS": "GA", + "DEADLINE_EXCEEDED": "GA", + "DEPLOYMENT_TIMEOUT": "GA", + "DIRECTORY_NOT_EMPTY": "GA", + "DIRECTORY_PROTECTED": "GA", + "DRY_RUN_FAILED": "GA", + "ENDPOINT_NOT_FOUND": "GA", + "EXTERNAL_LOCATION_ALREADY_EXISTS": "GA", + "EXTERNAL_LOCATION_DOES_NOT_EXIST": "GA", + "FEATURE_DISABLED": "GA", + "GIT_CONFLICT": "GA", + "GIT_REMOTE_ERROR": "GA", + "GIT_SENSITIVE_TOKEN_DETECTED": "GA", + "GIT_UNKNOWN_REF": "GA", + "GIT_URL_NOT_ON_ALLOW_LIST": "GA", + "INSECURE_PARTNER_RESPONSE": "GA", + "INTERNAL_ERROR": "GA", + "INVALID_PARAMETER_VALUE": "GA", + "INVALID_STATE": "GA", + "INVALID_STATE_TRANSITION": "GA", + "IO_ERROR": "GA", + "IPYNB_FILE_IN_REPO": "GA", + "MALFORMED_PARTNER_RESPONSE": "GA", + "MALFORMED_REQUEST": "GA", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST": "GA", + "MAX_BLOCK_SIZE_EXCEEDED": "GA", + "MAX_CHILD_NODE_SIZE_EXCEEDED": "GA", + "MAX_LIST_SIZE_EXCEEDED": "GA", + "MAX_NOTEBOOK_SIZE_EXCEEDED": "GA", + "MAX_READ_SIZE_EXCEEDED": "GA", + "METASTORE_ALREADY_EXISTS": "GA", + "METASTORE_DOES_NOT_EXIST": "GA", + "METASTORE_NOT_EMPTY": "GA", + "NOT_FOUND": "GA", + "NOT_IMPLEMENTED": "GA", + "PARTIAL_DELETE": "GA", + "PERMISSION_DENIED": "GA", + "PERMISSION_NOT_PROPAGATED": "GA", + "PRINCIPAL_DOES_NOT_EXIST": "GA", + "PROJECTS_OPERATION_TIMEOUT": "GA", + "PROVIDER_ALREADY_EXISTS": "GA", + "PROVIDER_DOES_NOT_EXIST": "GA", + "PROVIDER_SHARE_NOT_ACCESSIBLE": "GA", + "QUOTA_EXCEEDED": "GA", + "RECIPIENT_ALREADY_EXISTS": "GA", + "RECIPIENT_DOES_NOT_EXIST": "GA", + "REQUEST_LIMIT_EXCEEDED": "GA", + "RESOURCE_ALREADY_EXISTS": "GA", + "RESOURCE_CONFLICT": "GA", + "RESOURCE_DOES_NOT_EXIST": "GA", + "RESOURCE_EXHAUSTED": "GA", + "RESOURCE_LIMIT_EXCEEDED": "GA", + "SCHEMA_ALREADY_EXISTS": "GA", + "SCHEMA_DOES_NOT_EXIST": "GA", + "SCHEMA_NOT_EMPTY": "GA", + "SEARCH_QUERY_TOO_LONG": "GA", + "SEARCH_QUERY_TOO_SHORT": "GA", + "SERVICE_UNDER_MAINTENANCE": "GA", + "SHARE_ALREADY_EXISTS": "GA", + "SHARE_DOES_NOT_EXIST": "GA", + "STORAGE_CREDENTIAL_ALREADY_EXISTS": "GA", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST": "GA", + "TABLE_ALREADY_EXISTS": "GA", + "TABLE_DOES_NOT_EXIST": "GA", + "TEMPORARILY_UNAVAILABLE": "GA", + "UNAUTHENTICATED": "GA", + "UNAVAILABLE": "GA", + "UNKNOWN": "GA", + "UNPARSEABLE_HTTP_ERROR": "GA", + "WORKSPACE_TEMPORARILY_UNAVAILABLE": "GA" + } + }, + "environments.ListWorkspaceBaseEnvironmentsResponse": { + "description": "Response message for ListWorkspaceBaseEnvironments.", + "fields": { + "next_page_token": { + "description": "Token to retrieve the next page of results.\nEmpty if there are no more results.", + "launch_stage": "GA" + }, + "workspace_base_environments": { + "description": "The list of workspace base environments.", + "launch_stage": "GA" + } + } + }, + "environments.Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "fields": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "launch_stage": "GA" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "ref": "environments.DatabricksServiceExceptionWithDetailsProto", + "launch_stage": "GA" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata.", + "launch_stage": "GA" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "launch_stage": "GA" + }, + "response": { + "description": "The normal, successful response of the operation.", + "launch_stage": "GA" + } + } + }, + "environments.RefreshWorkspaceBaseEnvironmentRequest": { + "description": "Request message for RefreshWorkspaceBaseEnvironments." + }, + "environments.WorkspaceBaseEnvironment": { + "description": "A WorkspaceBaseEnvironment defines a workspace-level environment configuration\nconsisting of an environment version and a list of dependencies.", + "fields": { + "base_environment_type": { + "description": "The type of base environment (CPU or GPU).", + "ref": "environments.BaseEnvironmentType", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "create_time": { + "description": "Timestamp when the environment was created.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator_user_id": { + "description": "User ID of the creator.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "Human-readable display name for the workspace base environment.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "filepath": { + "description": "The WSFS or UC Volumes path to the environment YAML file.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "is_default": { + "description": "Whether this is the default environment for the workspace.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_updated_user_id": { + "description": "User ID of the last user who updated the environment.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "Status message providing additional details about the environment status.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "launch_stage": "GA" + }, + "status": { + "description": "The status of the materialized workspace base environment.", + "ref": "environments.WorkspaceBaseEnvironmentCacheStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "Timestamp when the environment was last updated.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "environments.WorkspaceBaseEnvironmentCacheStatus": { + "description": "Status of the environment materialization.", + "enum": [ + "PENDING", + "CREATED", + "FAILED", + "EXPIRED", + "INVALID", + "REFRESHING" + ], + "enum_launch_stages": { + "CREATED": "GA", + "EXPIRED": "GA", + "FAILED": "GA", + "INVALID": "GA", + "PENDING": "GA", + "REFRESHING": "GA" + } + }, + "environments.WorkspaceBaseEnvironmentOperationMetadata": { + "description": "Metadata for the WorkspaceBaseEnvironment long-running operations.\nThis message tracks the progress of the workspace base environment long-running process." + }, + "files.AddBlock": { + "fields": { + "data": { + "description": "The base64-encoded data to append to the stream. This has a limit of 1 MB.", + "launch_stage": "GA" + }, + "handle": { + "description": "The handle on an open stream.", + "launch_stage": "GA" + } + } + }, + "files.AddBlockResponse": {}, + "files.Close": { + "fields": { + "handle": { + "description": "The handle on an open stream.", + "launch_stage": "GA" + } + } + }, + "files.CloseResponse": {}, + "files.Create": { + "fields": { + "overwrite": { + "description": "The flag that specifies whether to overwrite existing file/files.", + "launch_stage": "GA" + }, + "path": { + "description": "The path of the new file. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.CreateResponse": { + "fields": { + "handle": { + "description": "Handle which should subsequently be passed into the AddBlock and Close calls when writing to a file through a stream.", + "launch_stage": "GA" + } + } + }, + "files.Delete": { + "fields": { + "path": { + "description": "The path of the file or directory to delete. The path should be the absolute DBFS path.", + "launch_stage": "GA" + }, + "recursive": { + "description": "Whether or not to recursively delete the directory's contents. Deleting empty directories can be done without providing the recursive flag.", + "launch_stage": "GA" + } + } + }, + "files.DeleteResponse": {}, + "files.DirectoryEntry": { + "fields": { + "file_size": { + "description": "The length of the file in bytes. This field is omitted for directories.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_directory": { + "description": "True if the path is a directory.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "last_modified": { + "description": "Last modification time of given file in milliseconds since unix epoch.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The name of the file or directory. This is the last component of the path.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "path": { + "description": "The absolute path of the file or directory.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "files.FileInfo": { + "fields": { + "file_size": { + "description": "The length of the file in bytes. This field is omitted for directories.", + "launch_stage": "GA" + }, + "is_dir": { + "description": "True if the path is a directory.", + "launch_stage": "GA" + }, + "modification_time": { + "description": "Last modification time of given file in milliseconds since epoch.", + "launch_stage": "GA" + }, + "path": { + "description": "The absolute path of the file or directory.", + "launch_stage": "GA" + } + } + }, + "files.ListDirectoryResponse": { + "fields": { + "contents": { + "description": "Array of DirectoryEntry.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "files.ListStatusResponse": { + "fields": { + "files": { + "description": "A list of FileInfo's that describe contents of directory or file. See example above.", + "launch_stage": "GA" + } + } + }, + "files.MkDirs": { + "fields": { + "path": { + "description": "The path of the new directory. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.MkDirsResponse": {}, + "files.Move": { + "fields": { + "destination_path": { + "description": "The destination path of the file or directory. The path should be the absolute DBFS path.", + "launch_stage": "GA" + }, + "source_path": { + "description": "The source path of the file or directory. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.MoveResponse": {}, + "files.Put": { + "fields": { + "contents": { + "description": "This parameter might be absent, and instead a posted file will be used.", + "launch_stage": "GA" + }, + "overwrite": { + "description": "The flag that specifies whether to overwrite existing file/files.", + "launch_stage": "GA" + }, + "path": { + "description": "The path of the new file. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.PutResponse": {}, + "files.ReadResponse": { + "fields": { + "bytes_read": { + "description": "The number of bytes read (could be less than ``length`` if we hit end of file). This refers to\nnumber of bytes read in unencoded version (response data is base64-encoded).", + "launch_stage": "GA" + }, + "data": { + "description": "The base64-encoded contents of the file read.", + "launch_stage": "GA" + } + } + }, + "iam.AccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "iam.PermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "iam.AccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "iam.AccountGroup": { + "fields": { + "account_id": { + "description": "Databricks account ID", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "GA" + }, + "externalId": { + "description": "external_id should be unique for identifying groups", + "launch_stage": "GA" + }, + "id": { + "description": "Databricks group ID", + "launch_stage": "GA" + }, + "members": { + "launch_stage": "GA" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.AccountServicePrincipal": { + "fields": { + "account_id": { + "description": "Databricks account ID", + "launch_stage": "GA" + }, + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "GA" + }, + "externalId": { + "launch_stage": "GA" + }, + "id": { + "description": "Databricks service principal ID.", + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.AccountUser": { + "fields": { + "account_id": { + "description": "Databricks account ID", + "launch_stage": "GA" + }, + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`.", + "launch_stage": "GA" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "GA" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "GA" + }, + "id": { + "description": "Databricks user ID.", + "launch_stage": "GA" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "GA" + } + } + }, + "iam.Actor": { + "description": "represents an identity trying to access a resource - user or a service principal\ngroup can be a principal of a permission set assignment but an actor is always a user or a service principal", + "fields": { + "actor_id": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.AutoscopeState": { + "description": "State of inferred scope collection (autoscope) for an external PAT.\nMirrored in databricks.identity.AutoscopeState in common/principal-context/api/proto/tokendetails.proto.\nToken store and token management proto can depend on this.\nPrincipal context proto should NOT depend on this proto definitions because too many services depend on the principal context proto.", + "enum": [ + "AUTOSCOPE_STATE_DISABLED", + "AUTOSCOPE_STATE_RUNNING", + "AUTOSCOPE_STATE_COMPLETED", + "AUTOSCOPE_STATE_BACKFILLED", + "AUTOSCOPE_STATE_USER_SELECTED", + "AUTOSCOPE_STATE_API_NOT_COVERED" + ], + "enum_launch_stages": { + "AUTOSCOPE_STATE_API_NOT_COVERED": "PRIVATE_PREVIEW", + "AUTOSCOPE_STATE_BACKFILLED": "PRIVATE_PREVIEW", + "AUTOSCOPE_STATE_COMPLETED": "PRIVATE_PREVIEW", + "AUTOSCOPE_STATE_DISABLED": "PRIVATE_PREVIEW", + "AUTOSCOPE_STATE_RUNNING": "PRIVATE_PREVIEW", + "AUTOSCOPE_STATE_USER_SELECTED": "PRIVATE_PREVIEW" + } + }, + "iam.CheckPolicyResponse": { + "fields": { + "consistency_token": { + "ref": "iam.ConsistencyToken", + "launch_stage": "PRIVATE_PREVIEW" + }, + "is_permitted": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.ComplexValue": { + "fields": { + "$ref": { + "launch_stage": "GA" + }, + "display": { + "launch_stage": "GA" + }, + "primary": { + "launch_stage": "GA" + }, + "type": { + "launch_stage": "GA" + }, + "value": { + "launch_stage": "GA" + } + } + }, + "iam.ConsistencyToken": { + "fields": { + "value": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.CreateAccountGroupRequest": { + "fields": { + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "GA" + }, + "externalId": { + "launch_stage": "GA" + }, + "id": { + "description": "Databricks group ID", + "launch_stage": "GA" + }, + "members": { + "launch_stage": "GA" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.CreateAccountServicePrincipalRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "GA" + }, + "externalId": { + "launch_stage": "GA" + }, + "id": { + "description": "Databricks service principal ID.", + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.CreateAccountUserRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`.", + "launch_stage": "GA" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "GA" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "GA" + }, + "id": { + "description": "Databricks user ID.", + "launch_stage": "GA" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "GA" + } + } + }, + "iam.CreateGroupRequest": { + "fields": { + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks group ID", + "launch_stage": "PUBLIC_PREVIEW" + }, + "members": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the group.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.CreateServicePrincipalRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks service principal ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the List response.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.CreateUserRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks user ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.DeleteWorkspacePermissionAssignmentResponse": {}, + "iam.GetAssignableRolesForResourceResponse": { + "fields": { + "roles": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.GetPasswordPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.GetPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "iam.GrantRule": { + "fields": { + "principals": { + "description": "Principals this grant rule applies to.\nA principal can be a user (for end users), a service principal (for applications and\ncompute workloads), or an account group. Each principal has its own identifier format:\n* users/\u003cUSERNAME\u003e\n* groups/\u003cGROUP_NAME\u003e\n* servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e", + "launch_stage": "PUBLIC_PREVIEW" + }, + "role": { + "description": "Role that is assigned to the list of principals.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.Group": { + "fields": { + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "description": "external_id should be unique for identifying groups", + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks group ID", + "launch_stage": "PUBLIC_PREVIEW" + }, + "members": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the group.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.GroupSchema": { + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "enum_launch_stages": { + "urn:ietf:params:scim:schemas:core:2.0:Group": "PUBLIC_PREVIEW" + } + }, + "iam.ListAccountGroupsResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "GA" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "GA" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "GA" + } + } + }, + "iam.ListAccountServicePrincipalsResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "GA" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "GA" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "GA" + } + } + }, + "iam.ListAccountUsersResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "GA" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "GA" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "GA" + } + } + }, + "iam.ListGroupsResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the service principal.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.ListResponseSchema": { + "enum": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "enum_launch_stages": { + "urn:ietf:params:scim:api:messages:2.0:ListResponse": "PUBLIC_PREVIEW" + } + }, + "iam.ListServicePrincipalResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the List response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.ListUsersResponse": { + "fields": { + "Resources": { + "description": "User objects returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "itemsPerPage": { + "description": "Total results returned in the response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the List response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Starting index of all the results that matched the request filters. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "totalResults": { + "description": "Total results that match the request filters.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.MigratePermissionsRequest": { + "fields": { + "from_workspace_group_name": { + "description": "The name of the workspace group that permissions will be migrated from.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "size": { + "description": "The maximum number of permissions that will be migrated.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "to_account_group_name": { + "description": "The name of the account group that permissions will be migrated to.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "workspace_id": { + "description": "WorkspaceId of the associated workspace where the permission migration will occur.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.MigratePermissionsResponse": { + "fields": { + "permissions_migrated": { + "description": "Number of permissions migrated.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.Name": { + "fields": { + "familyName": { + "description": "Family name of the Databricks user.", + "launch_stage": "GA" + }, + "givenName": { + "description": "Given name of the Databricks user.", + "launch_stage": "GA" + } + } + }, + "iam.ObjectPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "iam.PasswordAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_PREVIEW" + }, + "permission_level": { + "description": "Permission level", + "ref": "iam.PasswordPermissionLevel", + "launch_stage": "PUBLIC_PREVIEW" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PasswordAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_PREVIEW" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PasswordPermission": { + "fields": { + "inherited": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "inherited_from_object": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "permission_level": { + "description": "Permission level", + "ref": "iam.PasswordPermissionLevel", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PasswordPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_USE" + ], + "enum_launch_stages": { + "CAN_USE": "PUBLIC_PREVIEW" + } + }, + "iam.PasswordPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "object_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "object_type": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PasswordPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "permission_level": { + "description": "Permission level", + "ref": "iam.PasswordPermissionLevel", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PasswordPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.Patch": { + "fields": { + "op": { + "description": "Type of patch operation.", + "ref": "iam.PatchOp", + "launch_stage": "GA" + }, + "path": { + "description": "Selection of patch operation", + "launch_stage": "GA" + }, + "value": { + "description": "Value to modify", + "launch_stage": "GA" + } + } + }, + "iam.PatchAccountGroupRequest": { + "fields": { + "Operations": { + "launch_stage": "GA" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "GA" + } + } + }, + "iam.PatchAccountServicePrincipalRequest": { + "fields": { + "Operations": { + "launch_stage": "GA" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "GA" + } + } + }, + "iam.PatchAccountUserRequest": { + "fields": { + "Operations": { + "launch_stage": "GA" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "GA" + } + } + }, + "iam.PatchGroupRequest": { + "fields": { + "Operations": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PatchOp": { + "description": "Type of patch operation.", + "enum": [ + "add", + "remove", + "replace" + ], + "enum_launch_stages": { + "add": "GA", + "remove": "GA", + "replace": "GA" + } + }, + "iam.PatchSchema": { + "enum": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "enum_launch_stages": { + "urn:ietf:params:scim:api:messages:2.0:PatchOp": "GA" + } + }, + "iam.PatchServicePrincipalRequest": { + "fields": { + "Operations": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.PatchUserRequest": { + "fields": { + "Operations": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.Permission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "iam.PermissionLevel", + "launch_stage": "GA" + } + } + }, + "iam.PermissionAssignment": { + "description": "The output format for existing workspace PermissionAssignment records, which contains some info for\nuser consumption.", + "fields": { + "error": { + "description": "Error response associated with a workspace permission assignment, if any.", + "launch_stage": "GA" + }, + "permissions": { + "description": "The permissions level of the principal.", + "launch_stage": "GA" + }, + "principal": { + "description": "Information about the principal assigned to the workspace.", + "ref": "iam.PrincipalOutput", + "launch_stage": "GA" + } + } + }, + "iam.PermissionAssignments": { + "fields": { + "permission_assignments": { + "description": "Array of permissions assignments defined for a workspace.", + "launch_stage": "GA" + } + } + }, + "iam.PermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_RESTART", + "CAN_ATTACH_TO", + "IS_OWNER", + "CAN_MANAGE_RUN", + "CAN_VIEW", + "CAN_READ", + "CAN_RUN", + "CAN_EDIT", + "CAN_USE", + "CAN_MANAGE_STAGING_VERSIONS", + "CAN_MANAGE_PRODUCTION_VERSIONS", + "CAN_EDIT_METADATA", + "CAN_VIEW_METADATA", + "CAN_BIND", + "CAN_QUERY", + "CAN_MONITOR", + "CAN_CREATE", + "CAN_MONITOR_ONLY", + "CAN_CREATE_APP" + ], + "enum_launch_stages": { + "CAN_ATTACH_TO": "GA", + "CAN_BIND": "GA", + "CAN_CREATE": "GA", + "CAN_CREATE_APP": "PRIVATE_PREVIEW", + "CAN_EDIT": "GA", + "CAN_EDIT_METADATA": "GA", + "CAN_MANAGE": "GA", + "CAN_MANAGE_PRODUCTION_VERSIONS": "GA", + "CAN_MANAGE_RUN": "GA", + "CAN_MANAGE_STAGING_VERSIONS": "GA", + "CAN_MONITOR": "GA", + "CAN_MONITOR_ONLY": "PRIVATE_PREVIEW", + "CAN_QUERY": "GA", + "CAN_READ": "GA", + "CAN_RESTART": "GA", + "CAN_RUN": "GA", + "CAN_USE": "GA", + "CAN_VIEW": "GA", + "CAN_VIEW_METADATA": "GA", + "IS_OWNER": "GA" + } + }, + "iam.PermissionOutput": { + "fields": { + "description": { + "description": "The results of a permissions query.", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "iam.WorkspacePermission", + "launch_stage": "GA" + } + } + }, + "iam.PermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "iam.PermissionLevel", + "launch_stage": "GA" + } + } + }, + "iam.PrincipalOutput": { + "description": "Information about the principal assigned to the workspace.", + "fields": { + "display_name": { + "description": "The display name of the principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "The group name of the group. Present only if the principal is a group.", + "launch_stage": "GA" + }, + "principal_id": { + "description": "The unique, opaque id of the principal.", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "The name of the service principal. Present only if the principal is a service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "The username of the user. Present only if the principal is a user.", + "launch_stage": "GA" + } + } + }, + "iam.RequestAuthzIdentity": { + "description": "Defines the identity to be used for authZ of the request on the server side. See one pager for\nfor more information: http://go/acl/service-identity", + "enum": [ + "REQUEST_AUTHZ_IDENTITY_USER_CONTEXT", + "REQUEST_AUTHZ_IDENTITY_SERVICE_IDENTITY" + ], + "enum_launch_stages": { + "REQUEST_AUTHZ_IDENTITY_SERVICE_IDENTITY": "PRIVATE_PREVIEW", + "REQUEST_AUTHZ_IDENTITY_USER_CONTEXT": "PRIVATE_PREVIEW" + } + }, + "iam.ResourceInfo": { + "fields": { + "id": { + "description": "Id of the current resource.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "legacy_acl_path": { + "description": "The legacy acl path of the current resource.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "parent_resource_info": { + "description": "Parent resource info for the current resource. The parent may have another parent.", + "ref": "iam.ResourceInfo", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.ResourceMeta": { + "fields": { + "resourceType": { + "description": "Identifier for group type. Can be local workspace group (`WorkspaceGroup`) or account group (`Group`).", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iam.Role": { + "fields": { + "name": { + "description": "Role to assign to a principal or a list of principals on a resource.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.RuleSetResponse": { + "fields": { + "etag": { + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "grant_rules": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the rule set.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.RuleSetUpdateRequest": { + "fields": { + "etag": { + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "grant_rules": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the rule set.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.ServicePrincipal": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks service principal ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the List response.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.ServicePrincipalSchema": { + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal" + ], + "enum_launch_stages": { + "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal": "PUBLIC_PREVIEW" + } + }, + "iam.SetObjectPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "iam.UpdateAccountGroupRequest": { + "fields": { + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "GA" + }, + "externalId": { + "launch_stage": "GA" + }, + "members": { + "launch_stage": "GA" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.UpdateAccountServicePrincipalRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "GA" + }, + "externalId": { + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + } + } + }, + "iam.UpdateAccountUserRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "GA" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`.", + "launch_stage": "GA" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "GA" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "GA" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "GA" + }, + "roles": { + "description": "Indicates if the group has the admin role.", + "launch_stage": "GA" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "GA" + } + } + }, + "iam.UpdateGroupRequest": { + "fields": { + "displayName": { + "description": "String that represents a human-readable group name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "members": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "meta": { + "description": "Container for the group identifier. Workspace local versus account.", + "ref": "iam.ResourceMeta", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the group.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.UpdateObjectPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "iam.UpdateRuleSetRequest": { + "fields": { + "name": { + "description": "Name of the rule set.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rule_set": { + "ref": "iam.RuleSetUpdateRequest", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.UpdateServicePrincipalRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "applicationId": { + "description": "UUID relating to the service principal", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the List response.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.UpdateUserRequest": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.UpdateWorkspaceAssignments": { + "fields": { + "permissions": { + "description": "Array of permissions assignments to update on the workspace.\nValid values are \"USER\" and \"ADMIN\" (case-sensitive).\nIf both \"USER\" and \"ADMIN\" are provided, \"ADMIN\" takes precedence.\nOther values will be ignored.\nNote that excluding this field, or providing unsupported values, will have the same effect as providing an empty list, which will result in the deletion of all permissions for the principal.", + "launch_stage": "GA" + } + } + }, + "iam.User": { + "fields": { + "active": { + "description": "If this user is active", + "launch_stage": "PUBLIC_PREVIEW" + }, + "displayName": { + "description": "String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "emails": { + "description": "All the emails associated with the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entitlements": { + "description": "Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "externalId": { + "description": "External ID is not currently supported. It is reserved for future use.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "groups": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Databricks user ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "ref": "iam.Name", + "launch_stage": "PUBLIC_PREVIEW" + }, + "roles": { + "description": "Corresponds to AWS instance profile/arn role.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schemas": { + "description": "The schema of the user.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "userName": { + "description": "Email address of the Databricks user.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.UserSchema": { + "enum": [ + "urn:ietf:params:scim:schemas:core:2.0:User", + "urn:ietf:params:scim:schemas:extension:workspace:2.0:User" + ], + "enum_launch_stages": { + "urn:ietf:params:scim:schemas:core:2.0:User": "PUBLIC_PREVIEW", + "urn:ietf:params:scim:schemas:extension:workspace:2.0:User": "PUBLIC_PREVIEW" + } + }, + "iam.WorkspacePermission": { + "enum": [ + "UNKNOWN", + "USER", + "ADMIN" + ], + "enum_launch_stages": { + "ADMIN": "GA", + "UNKNOWN": "GA", + "USER": "GA" + } + }, + "iam.WorkspacePermissions": { + "fields": { + "permissions": { + "description": "Array of permissions defined for a workspace.", + "launch_stage": "GA" + } + } + }, + "iam.getSortOrder": { + "enum": [ + "ascending", + "descending" + ], + "enum_launch_stages": { + "ascending": "GA", + "descending": "GA" + } + }, + "iam.listSortOrder": { + "enum": [ + "ascending", + "descending" + ], + "enum_launch_stages": { + "ascending": "GA", + "descending": "GA" + } + }, + "iamv2.Entitlement": { + "enum": [ + "WORKSPACE_ACCESS", + "WORKSPACE_CONSUME", + "DATABRICKS_SQL_ACCESS", + "WORKSPACE_ADMIN", + "ALLOW_CLUSTER_CREATE", + "ALLOW_INSTANCE_POOL_CREATE" + ], + "enum_launch_stages": { + "ALLOW_CLUSTER_CREATE": "PRIVATE_PREVIEW", + "ALLOW_INSTANCE_POOL_CREATE": "PRIVATE_PREVIEW", + "DATABRICKS_SQL_ACCESS": "PRIVATE_PREVIEW", + "WORKSPACE_ACCESS": "PRIVATE_PREVIEW", + "WORKSPACE_ADMIN": "PRIVATE_PREVIEW", + "WORKSPACE_CONSUME": "PRIVATE_PREVIEW" + } + }, + "iamv2.Group": { + "description": "The details of a Group resource.", + "fields": { + "account_id": { + "description": "The parent account ID for group in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "external_id": { + "description": "ExternalId of the group in the customer's IdP.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "group_name": { + "description": "Display name of the group.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "internal_id": { + "description": "Internal group ID of the group in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "iamv2.ListWorkspaceAssignmentDetailsResponse": { + "description": "Response message for listing workspace assignment details.", + "fields": { + "next_page_token": { + "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "workspace_assignment_details": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iamv2.PrincipalType": { + "description": "The type of the principal (user/sp/group).", + "enum": [ + "USER", + "SERVICE_PRINCIPAL", + "GROUP" + ], + "enum_launch_stages": { + "GROUP": "PUBLIC_BETA", + "SERVICE_PRINCIPAL": "PUBLIC_BETA", + "USER": "PUBLIC_BETA" + } + }, + "iamv2.ResolveGroupProxyRequest": { + "description": "Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's groupname, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the group in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveGroupRequest": { + "description": "Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's groupname, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the group in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveGroupResponse": { + "fields": { + "group": { + "description": "The group that was resolved.", + "ref": "iamv2.Group", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveServicePrincipalProxyRequest": { + "description": "Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's displayname, status, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the service principal in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveServicePrincipalRequest": { + "description": "Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's displayname, status, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the service principal in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveServicePrincipalResponse": { + "fields": { + "service_principal": { + "description": "The service principal that was resolved.", + "ref": "iamv2.ServicePrincipal", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveUserProxyRequest": { + "description": "Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's displayname, status, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the user in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveUserRequest": { + "description": "Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's displayname, status, and inherited parent groups.", + "fields": { + "external_id": { + "description": "Required. The external ID of the user in the customer's IdP.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ResolveUserResponse": { + "fields": { + "user": { + "description": "The user that was resolved.", + "ref": "iamv2.User", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "iamv2.ServicePrincipal": { + "description": "The details of a ServicePrincipal resource.", + "fields": { + "account_id": { + "description": "The parent account ID for the service principal in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "account_sp_status": { + "description": "The activity status of a service principal in a Databricks account.", + "ref": "iamv2.State", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "application_id": { + "description": "Application ID of the service principal.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "display_name": { + "description": "Display name of the service principal.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "external_id": { + "description": "ExternalId of the service principal in the customer's IdP.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "internal_id": { + "description": "Internal service principal ID of the service principal in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "iamv2.State": { + "description": "The activity status of a user or service principal in a Databricks account or workspace.", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_BETA", + "INACTIVE": "PUBLIC_BETA" + } + }, + "iamv2.User": { + "description": "The details of a User resource.", + "fields": { + "account_id": { + "description": "The accountId parent of the user in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "account_user_status": { + "description": "The activity status of a user in a Databricks account.", + "ref": "iamv2.State", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "external_id": { + "description": "ExternalId of the user in the customer's IdP.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "internal_id": { + "description": "Internal userId of the user in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "ref": "iamv2.UserName", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "username": { + "description": "Username/email of the user.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE", + "OPTIONAL" + ] + } + } + }, + "iamv2.UserName": { + "fields": { + "family_name": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "given_name": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "iamv2.WorkspaceAccessDetail": { + "description": "The details of a principal's access to a workspace.", + "fields": { + "access_type": { + "ref": "iamv2.WorkspaceAccessDetailAccessType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "account_id": { + "description": "The account ID parent of the workspace where the principal has access.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "permissions": { + "description": "The permissions granted to the principal in the workspace.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "principal_id": { + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "principal_type": { + "ref": "iamv2.PrincipalType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "status": { + "description": "The activity status of the principal in the workspace. Not applicable for groups at the moment.", + "ref": "iamv2.State", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "workspace_id": { + "description": "The workspace ID where the principal has access.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "iamv2.WorkspaceAccessDetailAccessType": { + "description": "The type of access the principal has to the workspace.", + "enum": [ + "DIRECT", + "INDIRECT" + ], + "enum_launch_stages": { + "DIRECT": "PUBLIC_BETA", + "INDIRECT": "PUBLIC_BETA" + } + }, + "iamv2.WorkspaceAccessDetailView": { + "description": "Controls what fields are returned in the GetWorkspaceAccessDetail response.", + "enum": [ + "BASIC", + "FULL" + ], + "enum_launch_stages": { + "BASIC": "PUBLIC_BETA", + "FULL": "PUBLIC_BETA" + } + }, + "iamv2.WorkspaceAssignmentDetail": { + "description": "The details of a principal's assignment to a workspace.", + "fields": { + "account_id": { + "description": "The account ID parent of the workspace where the principal is assigned", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "entitlements": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "principal_id": { + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "principal_type": { + "ref": "iamv2.PrincipalType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "workspace_id": { + "description": "The workspace ID where the principal is assigned", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "iamv2.WorkspacePermission": { + "description": "The type of permission a principal has to a workspace (admin/user).", + "enum": [ + "USER_PERMISSION", + "ADMIN_PERMISSION" + ], + "enum_launch_stages": { + "ADMIN_PERMISSION": "PUBLIC_BETA", + "USER_PERMISSION": "PUBLIC_BETA" + } + }, + "jobs.AlertEvaluationState": { + "description": "Same alert evaluation state as in redash-v2/api/proto/alertsv2/alerts.proto", + "enum": [ + "UNKNOWN", + "TRIGGERED", + "OK", + "ERROR" + ], + "enum_launch_stages": { + "ERROR": "PUBLIC_PREVIEW", + "OK": "PUBLIC_PREVIEW", + "TRIGGERED": "PUBLIC_PREVIEW", + "UNKNOWN": "PUBLIC_PREVIEW" + } + }, + "jobs.AlertTask": { + "fields": { + "alert_id": { + "description": "The alert_id is the canonical identifier of the alert.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "subscribers": { + "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "warehouse_id": { + "description": "The warehouse_id identifies the warehouse settings used by the alert task.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.AlertTaskOutput": { + "fields": { + "alert_state": { + "ref": "jobs.AlertEvaluationState", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.AlertTaskSubscriber": { + "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).", + "fields": { + "destination_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_name": { + "description": "A valid workspace email address.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.AuthenticationMethod": { + "enum": [ + "OAUTH", + "PAT" + ], + "enum_launch_stages": { + "OAUTH": "PUBLIC_PREVIEW", + "PAT": "PUBLIC_PREVIEW" + } + }, + "jobs.BaseJob": { + "fields": { + "created_time": { + "description": "The time at which this job was created in epoch milliseconds (milliseconds since 1/1/1970 UTC).", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The creator user name. This field won’t be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "effective_budget_policy_id": { + "description": "The id of the budget policy used by this job for cost attribution purposes.\nThis may be set through (in order of precedence):\n1. Budget admins through the account or workspace console\n2. Jobs UI in the job details page and Jobs API using `budget_policy_id`\n3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_usage_policy_id": { + "description": "The id of the usage policy used by this job for cost attribution purposes.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "has_more": { + "description": "Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/get endpoint.\nIt is only relevant for API 2.2 :method:jobs/list requests with `expand_tasks=true`.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier for this job.", + "launch_stage": "GA" + }, + "settings": { + "description": "Settings for this job and all of its runs. These settings can be updated using the `resetJob` method.", + "ref": "jobs.JobSettings", + "launch_stage": "GA" + }, + "trigger_state": { + "description": "State of the trigger associated with the job.", + "ref": "jobs.TriggerStateProto", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "jobs.BaseRun": { + "fields": { + "attempt_number": { + "description": "The sequence number of this run attempt for a triggered job run. The initial attempt of a run has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy (`max_retries` \u003e 0), subsequent runs are created with an `original_attempt_run_id` of the original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job.", + "launch_stage": "GA" + }, + "cleanup_duration": { + "description": "The time in milliseconds it took to terminate the cluster and clean up any associated artifacts. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `cleanup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "cluster_instance": { + "description": "The cluster used for this run. If the run is specified to use a new cluster, this field is set once the Jobs service has requested a cluster for the run.", + "ref": "jobs.ClusterInstance", + "launch_stage": "GA" + }, + "cluster_spec": { + "description": "A snapshot of the job’s cluster specification when this run was created.", + "ref": "jobs.ClusterSpec", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The creator user name. This field won’t be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the run", + "launch_stage": "GA" + }, + "effective_performance_target": { + "description": "The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported by the job type.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "effective_usage_policy_id": { + "description": "The id of the usage policy used by this run for cost attribution purposes.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "end_time": { + "description": "The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This field is set to 0 if the job is still running.", + "launch_stage": "GA" + }, + "execution_duration": { + "description": "The time in milliseconds it took to execute the commands in the JAR or notebook until they completed, failed, timed out, were cancelled, or encountered an unexpected error. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `execution_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "has_more": { + "description": "Indicates if the run has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/getrun endpoint.\nIt is only relevant for API 2.2 :method:jobs/listruns requests with `expand_tasks=true`.", + "launch_stage": "GA" + }, + "job_clusters": { + "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.\nIf more than 100 job clusters are available, you can paginate through them using :method:jobs/getrun.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier of the job that contains this run.", + "launch_stage": "GA" + }, + "job_parameters": { + "description": "Job-level parameters used in the run", + "launch_stage": "GA" + }, + "job_run_id": { + "description": "ID of the job run that this run belongs to.\nFor legacy and single-task job runs the field is populated with the job run ID.\nFor task runs, the field is populated with the ID of the job run that the task run belongs to.", + "launch_stage": "GA" + }, + "number_in_job": { + "description": "A unique identifier for this job run. This is set to the same value as `run_id`.", + "deprecated": true, + "launch_stage": "GA" + }, + "original_attempt_run_id": { + "description": "If this run is a retry of a prior run attempt, this field contains the run_id of the original attempt; otherwise, it is the same as the run_id.", + "launch_stage": "GA" + }, + "overriding_parameters": { + "description": "The parameters used for this run.", + "ref": "jobs.RunParameters", + "launch_stage": "GA" + }, + "queue_duration": { + "description": "The time in milliseconds that the run has spent in the queue.", + "launch_stage": "GA" + }, + "repair_history": { + "description": "The repair history of the run.", + "launch_stage": "GA" + }, + "run_duration": { + "description": "The time in milliseconds it took the job run and all of its repairs to finish.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The canonical identifier of the run. This ID is unique across all runs of all jobs.", + "launch_stage": "GA" + }, + "run_name": { + "description": "An optional name for the run. The maximum length is 4096 bytes in UTF-8 encoding.", + "launch_stage": "GA" + }, + "run_page_url": { + "description": "The URL to the detail page of the run.", + "launch_stage": "GA" + }, + "run_type": { + "ref": "jobs.RunType", + "launch_stage": "GA" + }, + "schedule": { + "description": "The cron schedule that triggered this run if it was triggered by the periodic scheduler.", + "ref": "jobs.CronSchedule", + "launch_stage": "GA" + }, + "setup_duration": { + "description": "The time in milliseconds it took to set up the cluster. For runs that run on new clusters this is the cluster creation time, for runs that run on existing clusters this time should be very short. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `setup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "start_time": { + "description": "The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued.", + "launch_stage": "GA" + }, + "state": { + "description": "Deprecated. Please use the `status` field instead.", + "ref": "jobs.RunState", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "ref": "jobs.RunStatus", + "launch_stage": "GA" + }, + "tasks": { + "description": "The list of tasks performed by the run. Each task has its own `run_id` which you can use to call `JobsGetOutput` to retrieve the run resutls.\nIf more than 100 tasks are available, you can paginate through them using :method:jobs/getrun. Use the `next_page_token` field at the object root to determine if more results are available.", + "launch_stage": "GA" + }, + "trigger": { + "ref": "jobs.TriggerType", + "launch_stage": "GA" + }, + "trigger_info": { + "ref": "jobs.TriggerInfo", + "launch_stage": "GA" + } + } + }, + "jobs.CancelAllRuns": { + "fields": { + "all_queued_runs": { + "description": "Optional boolean parameter to cancel all queued runs. If no job_id is provided, all queued runs in the workspace are canceled.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier of the job to cancel all runs of.", + "launch_stage": "GA" + } + } + }, + "jobs.CancelRun": { + "fields": { + "run_id": { + "description": "This field is required.", + "launch_stage": "GA" + } + } + }, + "jobs.CleanRoomTaskRunLifeCycleState": { + "description": "Copied from elastic-spark-common/api/messages/runs.proto.\nUsing the original definition to remove coupling with jobs API definition", + "enum": [ + "RUN_LIFE_CYCLE_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "TERMINATING", + "TERMINATED", + "SKIPPED", + "INTERNAL_ERROR", + "BLOCKED", + "WAITING_FOR_RETRY", + "QUEUED" + ], + "enum_launch_stages": { + "BLOCKED": "GA", + "INTERNAL_ERROR": "GA", + "PENDING": "GA", + "QUEUED": "GA", + "RUNNING": "GA", + "RUN_LIFE_CYCLE_STATE_UNSPECIFIED": "GA", + "SKIPPED": "GA", + "TERMINATED": "GA", + "TERMINATING": "GA", + "WAITING_FOR_RETRY": "GA" + } + }, + "jobs.CleanRoomTaskRunResultState": { + "description": "Copied from elastic-spark-common/api/messages/runs.proto.\nUsing the original definition to avoid cyclic dependency.", + "enum": [ + "RUN_RESULT_STATE_UNSPECIFIED", + "SUCCESS", + "FAILED", + "TIMEDOUT", + "CANCELED", + "MAXIMUM_CONCURRENT_RUNS_REACHED", + "UPSTREAM_CANCELED", + "UPSTREAM_FAILED", + "EXCLUDED", + "EVICTED", + "SUCCESS_WITH_FAILURES", + "UPSTREAM_EVICTED", + "DISABLED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "DISABLED": "GA", + "EVICTED": "GA", + "EXCLUDED": "GA", + "FAILED": "GA", + "MAXIMUM_CONCURRENT_RUNS_REACHED": "GA", + "RUN_RESULT_STATE_UNSPECIFIED": "GA", + "SUCCESS": "GA", + "SUCCESS_WITH_FAILURES": "GA", + "TIMEDOUT": "GA", + "UPSTREAM_CANCELED": "GA", + "UPSTREAM_EVICTED": "GA", + "UPSTREAM_FAILED": "GA" + } + }, + "jobs.CleanRoomTaskRunState": { + "description": "Stores the run state of the clean rooms notebook task.", + "fields": { + "life_cycle_state": { + "description": "A value indicating the run's current lifecycle state. This field is always available in the response. Note: Additional states might be introduced in future releases.", + "ref": "jobs.CleanRoomTaskRunLifeCycleState", + "launch_stage": "GA" + }, + "result_state": { + "description": "A value indicating the run's result. This field is only available for terminal lifecycle states. Note: Additional states might be introduced in future releases.", + "ref": "jobs.CleanRoomTaskRunResultState", + "launch_stage": "GA" + } + } + }, + "jobs.CleanRoomsNotebookTask": { + "description": "Clean Rooms notebook task for V1 Clean Room service (GA).\nReplaces the deprecated CleanRoomNotebookTask (defined above) which was for V0 service.", + "fields": { + "clean_room_name": { + "description": "The clean room that the notebook belongs to.", + "launch_stage": "GA" + }, + "etag": { + "description": "Checksum to validate the freshness of the notebook resource (i.e. the notebook being run is the latest version).\nIt can be fetched by calling the :method:cleanroomassets/get API.", + "launch_stage": "GA" + }, + "notebook_base_parameters": { + "description": "Base parameters to be used for the clean room notebook job.", + "launch_stage": "GA" + }, + "notebook_name": { + "description": "Name of the notebook being run.", + "launch_stage": "GA" + } + } + }, + "jobs.CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput": { + "fields": { + "clean_room_job_run_state": { + "description": "The run state of the clean rooms notebook task.", + "ref": "jobs.CleanRoomTaskRunState", + "launch_stage": "GA" + }, + "notebook_output": { + "description": "The notebook output for the clean room run", + "ref": "jobs.NotebookOutput", + "launch_stage": "GA" + }, + "output_schema_info": { + "description": "Information on how to access the output schema for the clean room run", + "ref": "jobs.OutputSchemaInfo", + "launch_stage": "GA" + } + } + }, + "jobs.ClusterInstance": { + "fields": { + "cluster_id": { + "description": "The canonical identifier for the cluster used by a run. This field is always available for runs on existing clusters. For runs on new clusters, it becomes available once the cluster is created. This value can be used to view logs by browsing to `/#setting/sparkui/$cluster_id/driver-logs`. The logs continue to be available after the run completes.\n\nThe response won’t include this field if the identifier is not available yet.", + "launch_stage": "GA" + }, + "spark_context_id": { + "description": "The canonical identifier for the Spark context used by a run. This field is filled in once the run begins execution. This value can be used to view the Spark UI by browsing to `/#setting/sparkui/$cluster_id/$spark_context_id`. The Spark UI continues to be available after the run has completed.\n\nThe response won’t include this field if the identifier is not available yet.", + "launch_stage": "GA" + } + } + }, + "jobs.ClusterSpec": { + "fields": { + "existing_cluster_id": { + "description": "If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability", + "launch_stage": "GA" + }, + "job_cluster_key": { + "description": "If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.", + "launch_stage": "GA" + }, + "libraries": { + "description": "An optional list of libraries to be installed on the cluster.\nThe default value is an empty list.", + "launch_stage": "GA" + }, + "new_cluster": { + "description": "If new_cluster, a description of a new cluster that is created for each run.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + } + } + }, + "jobs.Compute": { + "fields": { + "hardware_accelerator": { + "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "ref": "compute.HardwareAcceleratorType", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "jobs.ComputeConfig": { + "fields": { + "gpu_node_pool_id": { + "description": "IDof the GPU pool to use.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "gpu_type": { + "description": "GPU type.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "num_gpus": { + "description": "Number of GPUs.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.Condition": { + "enum": [ + "ANY_UPDATED", + "ALL_UPDATED" + ], + "enum_launch_stages": { + "ALL_UPDATED": "GA", + "ANY_UPDATED": "GA" + } + }, + "jobs.ConditionTask": { + "fields": { + "left": { + "description": "The left operand of the condition task. Can be either a string value or a job state or parameter reference.", + "launch_stage": "GA" + }, + "op": { + "description": "* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” \u003e= “12”` will evaluate to `true`, `“10.0” \u003e= “12”` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.", + "ref": "jobs.ConditionTaskOp", + "launch_stage": "GA" + }, + "right": { + "description": "The right operand of the condition task. Can be either a string value or a job state or parameter reference.", + "launch_stage": "GA" + } + } + }, + "jobs.ConditionTaskOp": { + "description": "* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” \u003e= “12”` will evaluate to `true`, `“10.0” \u003e= “12”` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.", + "enum": [ + "EQUAL_TO", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "NOT_EQUAL" + ], + "enum_launch_stages": { + "EQUAL_TO": "GA", + "GREATER_THAN": "GA", + "GREATER_THAN_OR_EQUAL": "GA", + "LESS_THAN": "GA", + "LESS_THAN_OR_EQUAL": "GA", + "NOT_EQUAL": "GA" + } + }, + "jobs.Continuous": { + "fields": { + "pause_status": { + "description": "Indicate whether the continuous execution of the job is paused or not. Defaults to UNPAUSED.", + "ref": "jobs.PauseStatus", + "launch_stage": "GA" + }, + "task_retry_mode": { + "description": "Indicate whether the continuous job is applying task level retries or not. Defaults to NEVER.", + "ref": "jobs.TaskRetryMode", + "launch_stage": "GA" + } + } + }, + "jobs.CreateJob": { + "fields": { + "access_control_list": { + "description": "List of permissions to set on the job.", + "launch_stage": "GA" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "continuous": { + "description": "An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used.", + "ref": "jobs.Continuous", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment information for jobs managed by external sources.", + "ref": "jobs.JobDeployment", + "launch_stage": "GA" + }, + "description": { + "description": "An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.", + "launch_stage": "GA" + }, + "edit_mode": { + "description": "Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.", + "ref": "jobs.JobEditMode", + "launch_stage": "GA" + }, + "email_notifications": { + "description": "An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.", + "ref": "jobs.JobEmailNotifications", + "launch_stage": "GA" + }, + "environments": { + "description": "A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nFor serverless notebook tasks, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the notebook environment.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.", + "launch_stage": "GA" + }, + "format": { + "description": "Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls. When using the Jobs API 2.1 this value is always set to `\"MULTI_TASK\"`.", + "ref": "jobs.Format", + "deprecated": true, + "launch_stage": "GA" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "health": { + "ref": "jobs.JobsHealthRules", + "launch_stage": "GA" + }, + "job_clusters": { + "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.", + "launch_stage": "GA" + }, + "max_concurrent_runs": { + "description": "An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job’s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.", + "launch_stage": "GA" + }, + "name": { + "description": "An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.", + "ref": "jobs.JobNotificationSettings", + "launch_stage": "GA" + }, + "parameters": { + "description": "Job-level parameter definitions", + "launch_stage": "GA" + }, + "performance_target": { + "description": "The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run.\nThe performance target does not apply to tasks that run on Serverless GPU compute.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "queue": { + "description": "The queue settings of the job.", + "ref": "jobs.QueueSettings", + "launch_stage": "GA" + }, + "run_as": { + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", + "ref": "jobs.JobRunAs", + "launch_stage": "GA" + }, + "schedule": { + "description": "An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "ref": "jobs.CronSchedule", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.", + "launch_stage": "GA" + }, + "tasks": { + "description": "A list of task specifications to be executed by this job.\nIt supports up to 1000 elements in write endpoints (:method:jobs/create, :method:jobs/reset, :method:jobs/update, :method:jobs/submit).\nRead endpoints return only 100 tasks. If more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.", + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "trigger": { + "description": "A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "ref": "jobs.TriggerSettings", + "launch_stage": "GA" + }, + "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.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when runs of this job begin or complete.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.CreateResponse": { + "description": "Job was created successfully", + "fields": { + "job_id": { + "description": "The canonical identifier for the newly created job.", + "launch_stage": "GA" + } + } + }, + "jobs.CronSchedule": { + "fields": { + "pause_status": { + "description": "Indicate whether this schedule is paused or not.", + "ref": "jobs.PauseStatus", + "launch_stage": "GA" + }, + "quartz_cron_expression": { + "description": "A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required.", + "launch_stage": "GA" + }, + "timezone_id": { + "description": "A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required.", + "launch_stage": "GA" + } + } + }, + "jobs.DashboardPageSnapshot": { + "fields": { + "page_display_name": { + "launch_stage": "GA" + }, + "widget_error_details": { + "launch_stage": "GA" + } + } + }, + "jobs.DashboardTask": { + "description": "Configures the Lakeview Dashboard job task type.", + "fields": { + "dashboard_id": { + "description": "The identifier of the dashboard to refresh.", + "launch_stage": "GA" + }, + "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\\\"}\"`)", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "subscription": { + "description": "Optional: subscription configuration for sending the dashboard snapshot.", + "ref": "jobs.Subscription", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "Optional: The warehouse id to execute the dashboard with for the schedule.\nIf not specified, the default warehouse of the dashboard will be used.", + "launch_stage": "GA" + } + } + }, + "jobs.DashboardTaskOutput": { + "fields": { + "page_snapshots": { + "description": "Should only be populated for manual PDF download jobs.", + "launch_stage": "GA" + } + } + }, + "jobs.DbtCloudJobRunStep": { + "description": "Format of response retrieved from dbt Cloud, for inclusion in output\nDeprecated in favor of DbtPlatformJobRunStep", + "fields": { + "index": { + "description": "Orders the steps in the job", + "launch_stage": "PRIVATE_PREVIEW" + }, + "logs": { + "description": "Output of the step", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "Name of the step in the job", + "launch_stage": "PRIVATE_PREVIEW" + }, + "status": { + "description": "State of the step", + "ref": "jobs.DbtPlatformRunStatus", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtCloudTask": { + "description": "Deprecated in favor of DbtPlatformTask", + "fields": { + "connection_resource_name": { + "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_cloud_job_id": { + "description": "Id of the dbt Cloud job to be triggered", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtCloudTaskOutput": { + "description": "Deprecated in favor of DbtPlatformTaskOutput", + "fields": { + "dbt_cloud_job_run_id": { + "description": "Id of the job run in dbt Cloud", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_cloud_job_run_output": { + "description": "Steps of the job run as received from dbt Cloud", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_cloud_job_run_url": { + "description": "Url where full run details can be viewed", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtOutput": { + "fields": { + "artifacts_headers": { + "description": "An optional map of headers to send when retrieving the artifact from the `artifacts_link`.", + "launch_stage": "GA" + }, + "artifacts_link": { + "description": "A pre-signed URL to download the (compressed) dbt artifacts. This link is valid for a limited time (30 minutes). This information is only available after the run has finished.", + "launch_stage": "GA" + } + } + }, + "jobs.DbtPlatformJobRunStep": { + "description": "Format of response retrieved from dbt platform, for inclusion in output", + "fields": { + "index": { + "description": "Orders the steps in the job", + "launch_stage": "PRIVATE_PREVIEW" + }, + "logs": { + "description": "Output of the step", + "launch_stage": "PRIVATE_PREVIEW" + }, + "logs_truncated": { + "description": "Whether the logs of this step have been truncated. If true, the logs has been truncated to 10000 characters.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "Name of the step in the job", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name_truncated": { + "description": "Whether the name of the job has been truncated. If true, the name has been truncated to 100 characters.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "status": { + "description": "State of the step", + "ref": "jobs.DbtPlatformRunStatus", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtPlatformRunStatus": { + "description": "Response enumeration from calling the dbt platform API, for inclusion in output", + "enum": [ + "QUEUED", + "STARTING", + "RUNNING", + "SUCCESS", + "ERROR", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "PRIVATE_PREVIEW", + "ERROR": "PRIVATE_PREVIEW", + "QUEUED": "PRIVATE_PREVIEW", + "RUNNING": "PRIVATE_PREVIEW", + "STARTING": "PRIVATE_PREVIEW", + "SUCCESS": "PRIVATE_PREVIEW" + } + }, + "jobs.DbtPlatformTask": { + "fields": { + "connection_resource_name": { + "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtPlatformTaskOutput": { + "fields": { + "dbt_platform_job_run_id": { + "description": "Id of the job run in dbt platform. Specified as a string for maximum compatibility with clients.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_platform_job_run_output": { + "description": "Steps of the job run as received from dbt platform", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_platform_job_run_url": { + "description": "Url where full run details can be viewed", + "launch_stage": "PRIVATE_PREVIEW" + }, + "steps_truncated": { + "description": "Whether the number of steps in the output has been truncated. If true, the output will contain the first 20 steps of the output.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.DbtTask": { + "fields": { + "catalog": { + "description": "Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks \u003e= 1.1.1.", + "launch_stage": "GA" + }, + "commands": { + "description": "A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided.", + "launch_stage": "GA" + }, + "profiles_directory": { + "description": "Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used.", + "launch_stage": "GA" + }, + "project_directory": { + "description": "Path to the project directory. Optional for Git sourced tasks, in which\ncase if no value is provided, the root of the Git repository is used.", + "launch_stage": "GA" + }, + "schema": { + "description": "Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used.", + "launch_stage": "GA" + }, + "source": { + "description": "Optional location type of the project directory. When set to `WORKSPACE`, the project will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the project will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: Project is located in Databricks workspace.\n* `GIT`: Project is located in cloud Git provider.", + "ref": "jobs.Source", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument.", + "launch_stage": "GA" + } + } + }, + "jobs.DeleteJob": { + "fields": { + "job_id": { + "description": "The canonical identifier of the job to delete. This field is required.", + "launch_stage": "GA" + } + } + }, + "jobs.DeleteRun": { + "fields": { + "run_id": { + "description": "ID of the run to delete.", + "launch_stage": "GA" + } + } + }, + "jobs.EnforcePolicyComplianceForJobResponseJobClusterSettingsChange": { + "description": "Represents a change to the job cluster's settings that would be required for the\njob clusters to become compliant with their policies.", + "fields": { + "field": { + "description": "The field where this change would be made, prepended with the job cluster key.", + "launch_stage": "GA" + }, + "new_value": { + "description": "The new value of this field after enforcing policy compliance\n(either a number, a boolean, or a string) converted to a string.\nThis is intended to be read by a human. The typed new value of this field\ncan be retrieved by reading the settings field in the API response.", + "launch_stage": "GA" + }, + "previous_value": { + "description": "The previous value of this field before enforcing policy compliance\n(either a number, a boolean, or a string) converted to a string.\nThis is intended to be read by a human. The type of the field\ncan be retrieved by reading the settings field in the API response.", + "launch_stage": "GA" + } + } + }, + "jobs.EnforcePolicyComplianceRequest": { + "fields": { + "job_id": { + "description": "The ID of the job you want to enforce policy compliance on.", + "launch_stage": "GA" + }, + "validate_only": { + "description": "If set, previews changes made to the job to comply with its policy, but\ndoes not update the job.", + "launch_stage": "GA" + } + } + }, + "jobs.EnforcePolicyComplianceResponse": { + "fields": { + "has_changes": { + "description": "Whether any changes have been made to the job cluster settings for the job to\nbecome compliant with its policies.", + "launch_stage": "GA" + }, + "job_cluster_changes": { + "description": "A list of job cluster changes that have been made to the job’s cluster\nsettings in order for all job clusters to become compliant with their\npolicies.", + "launch_stage": "GA" + }, + "settings": { + "description": "Updated job settings after policy enforcement. Policy enforcement only\napplies to job clusters that are created when running the job (which are\nspecified in new_cluster) and does not apply to existing all-purpose clusters.\nUpdated job settings are derived by applying policy default values to the\nexisting job clusters in order to satisfy policy requirements.", + "ref": "jobs.JobSettings", + "launch_stage": "GA" + } + } + }, + "jobs.ExportRunOutput": { + "description": "Run was exported successfully.", + "fields": { + "views": { + "description": "The exported content in HTML format (one for every view item). To extract the HTML notebook from the JSON response, download and run this [Python script](/_static/examples/extract.py).", + "launch_stage": "GA" + } + } + }, + "jobs.FileArrivalTriggerConfiguration": { + "fields": { + "min_time_between_triggers_seconds": { + "description": "If set, the trigger starts a run only after the specified amount of time passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds", + "launch_stage": "GA" + }, + "url": { + "description": "URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location.", + "launch_stage": "GA" + }, + "wait_after_last_change_seconds": { + "description": "If set, the trigger starts a run only after no file activity has occurred for the specified amount of time.\nThis makes it possible to wait for a batch of incoming files to arrive before triggering a run. The\nminimum allowed value is 60 seconds.", + "launch_stage": "GA" + } + } + }, + "jobs.FileArrivalTriggerState": { + "fields": { + "using_file_events": { + "description": "Indicates whether the trigger leverages file events to detect file arrivals.", + "launch_stage": "GA" + } + } + }, + "jobs.ForEachStats": { + "fields": { + "error_message_stats": { + "description": "Sample of 3 most common error messages occurred during the iteration.", + "launch_stage": "GA" + }, + "task_run_stats": { + "description": "Describes stats of the iteration. Only latest retries are considered.", + "ref": "jobs.ForEachTaskTaskRunStats", + "launch_stage": "GA" + } + } + }, + "jobs.ForEachTask": { + "fields": { + "concurrency": { + "description": "An optional maximum allowed number of concurrent runs of the task.\nSet this value if you want to be able to execute multiple runs of the task concurrently.", + "launch_stage": "GA" + }, + "inputs": { + "description": "Array for task to iterate on. This can be a JSON string or a reference to\nan array parameter.", + "launch_stage": "GA" + }, + "task": { + "description": "Configuration for the task that will be run for each element in the array", + "ref": "jobs.Task", + "launch_stage": "GA" + } + } + }, + "jobs.ForEachTaskErrorMessageStats": { + "fields": { + "count": { + "description": "Describes the count of such error message encountered during the\niterations.", + "launch_stage": "GA" + }, + "error_message": { + "description": "Describes the error message occured during the iterations.", + "launch_stage": "GA" + }, + "termination_category": { + "description": "Describes the termination reason for the error message.", + "launch_stage": "GA" + } + } + }, + "jobs.ForEachTaskTaskRunStats": { + "fields": { + "active_iterations": { + "description": "Describes the iteration runs having an active lifecycle state or an active run sub state.", + "launch_stage": "GA" + }, + "completed_iterations": { + "description": "Describes the number of failed and succeeded iteration runs.", + "launch_stage": "GA" + }, + "failed_iterations": { + "description": "Describes the number of failed iteration runs.", + "launch_stage": "GA" + }, + "scheduled_iterations": { + "description": "Describes the number of iteration runs that have been scheduled.", + "launch_stage": "GA" + }, + "succeeded_iterations": { + "description": "Describes the number of succeeded iteration runs.", + "launch_stage": "GA" + }, + "total_iterations": { + "description": "Describes the length of the list of items to iterate over.", + "launch_stage": "GA" + } + } + }, + "jobs.Format": { + "enum": [ + "SINGLE_TASK", + "MULTI_TASK" + ], + "enum_launch_stages": { + "MULTI_TASK": "GA", + "SINGLE_TASK": "GA" + } + }, + "jobs.GenAiComputeTask": { + "fields": { + "command": { + "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "compute": { + "ref": "jobs.ComputeConfig", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dl_runtime_image": { + "description": "Runtime image", + "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\nfound, backend will create the mlflow experiment using the name.", + "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\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": "jobs.Source", + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "yaml_parameters_file_path": { + "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.GetJobPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "jobs.GetPolicyComplianceResponse": { + "fields": { + "is_compliant": { + "description": "Whether the job is compliant with its policies or not. Jobs could be out of\ncompliance if a policy they are using was updated after the job was\nlast edited and some of its job clusters no longer comply with\ntheir updated policies.", + "launch_stage": "GA" + }, + "violations": { + "description": "An object containing key-value mappings representing the first 200 policy\nvalidation errors.\nThe keys indicate the path where the policy validation error is occurring.\nAn identifier for the job cluster is prepended to the path.\nThe values indicate an error message describing the policy validation error.", + "launch_stage": "GA" + } + } + }, + "jobs.GitProvider": { + "enum": [ + "gitHub", + "bitbucketCloud", + "azureDevOpsServices", + "gitHubEnterprise", + "bitbucketServer", + "gitLab", + "gitLabEnterpriseEdition", + "awsCodeCommit" + ], + "enum_launch_stages": { + "awsCodeCommit": "GA", + "azureDevOpsServices": "GA", + "bitbucketCloud": "GA", + "bitbucketServer": "GA", + "gitHub": "GA", + "gitHubEnterprise": "GA", + "gitLab": "GA", + "gitLabEnterpriseEdition": "GA" + } + }, + "jobs.GitSnapshot": { + "description": "Read-only state of the remote repository at the time the job was run. This field is only included on job runs.", + "fields": { + "used_commit": { + "description": "Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to.", + "launch_stage": "GA" + } + } + }, + "jobs.GitSource": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "fields": { + "git_branch": { + "description": "Name of the branch to be checked out and used by this job. This field cannot be specified in conjunction with git_tag or git_commit.", + "launch_stage": "GA" + }, + "git_commit": { + "description": "Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.", + "launch_stage": "GA" + }, + "git_provider": { + "description": "Unique identifier of the service used to host the Git repository. The value is case insensitive.", + "ref": "jobs.GitProvider", + "launch_stage": "GA" + }, + "git_snapshot": { + "ref": "jobs.GitSnapshot", + "launch_stage": "GA" + }, + "git_tag": { + "description": "Name of the tag to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_commit.", + "launch_stage": "GA" + }, + "git_url": { + "description": "URL of the repository to be cloned by this job.", + "launch_stage": "GA" + }, + "job_source": { + "description": "The source of the job specification in the remote repository when the job is source controlled.", + "ref": "jobs.JobSource", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "sparse_checkout": { + "ref": "jobs.SparseCheckout", + "launch_stage": "GA" + } + } + }, + "jobs.Job": { + "description": "Job was retrieved successfully.", + "fields": { + "created_time": { + "description": "The time at which this job was created in epoch milliseconds (milliseconds since 1/1/1970 UTC).", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The creator user name. This field won’t be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "effective_budget_policy_id": { + "description": "The id of the budget policy used by this job for cost attribution purposes.\nThis may be set through (in order of precedence):\n1. Budget admins through the account or workspace console\n2. Jobs UI in the job details page and Jobs API using `budget_policy_id`\n3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_usage_policy_id": { + "description": "The id of the usage policy used by this job for cost attribution purposes.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "has_more": { + "description": "Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/get endpoint.\nIt is only relevant for API 2.2 :method:jobs/list requests with `expand_tasks=true`.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier for this job.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to list the next page of array properties.", + "launch_stage": "GA" + }, + "run_as_user_name": { + "description": "The email of an active workspace user or the application ID of a service principal that the job runs as. This value can be changed by setting the `run_as` field when creating or updating a job.\n\nBy default, `run_as_user_name` is based on the current job settings and is set to the creator of the job if job access control is disabled or to the user with the `is_owner` permission if job access control is enabled.", + "launch_stage": "GA" + }, + "settings": { + "description": "Settings for this job and all of its runs. These settings can be updated using the `resetJob` method.", + "ref": "jobs.JobSettings", + "launch_stage": "GA" + }, + "trigger_state": { + "description": "State of the trigger associated with the job.", + "ref": "jobs.TriggerStateProto", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "jobs.JobAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "jobs.JobPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "jobs.JobAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "jobs.JobCluster": { + "fields": { + "job_cluster_key": { + "description": "A unique name for the job cluster. This field is required and must be unique within the job.\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution.", + "launch_stage": "GA" + }, + "new_cluster": { + "description": "If new_cluster, a description of a cluster that is created for each task.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + } + } + }, + "jobs.JobCompliance": { + "fields": { + "is_compliant": { + "description": "Whether this job is in compliance with the latest version of its policy.", + "launch_stage": "GA" + }, + "job_id": { + "description": "Canonical unique identifier for a job.", + "launch_stage": "GA" + }, + "violations": { + "description": "An object containing key-value mappings representing the first 200 policy\nvalidation errors.\nThe keys indicate the path where the policy validation error is occurring.\nAn identifier for the job cluster is prepended to the path.\nThe values indicate an error message describing the policy validation error.", + "launch_stage": "GA" + } + } + }, + "jobs.JobDeployment": { + "fields": { + "deployment_id": { + "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "kind": { + "description": "The kind of deployment that manages the job.\n\n* `BUNDLE`: The job is managed by Databricks Asset Bundle.\n* `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only.", + "ref": "jobs.JobDeploymentKind", + "launch_stage": "GA" + }, + "metadata_file_path": { + "description": "Path of the file that contains deployment metadata.", + "launch_stage": "GA" + }, + "version_id": { + "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.JobDeploymentKind": { + "description": "* `BUNDLE`: The job is managed by Databricks Asset Bundle.\n* `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only.", + "enum": [ + "BUNDLE", + "SYSTEM_MANAGED" + ], + "enum_launch_stages": { + "BUNDLE": "GA", + "SYSTEM_MANAGED": "PUBLIC_BETA" + }, + "enum_descriptions": { + "BUNDLE": "The job is managed by Databricks Asset Bundle.", + "SYSTEM_MANAGED": "The job is managed by \u003cDatabricks\u003e and is read-only." + } + }, + "jobs.JobEditMode": { + "description": "Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.", + "enum": [ + "UI_LOCKED", + "EDITABLE" + ], + "enum_launch_stages": { + "EDITABLE": "GA", + "UI_LOCKED": "GA" + }, + "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." + } + }, + "jobs.JobEmailNotifications": { + "fields": { + "no_alert_for_skipped_runs": { + "description": "If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "on_duration_warning_threshold_exceeded": { + "description": "A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.", + "launch_stage": "GA" + }, + "on_failure": { + "description": "A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.", + "launch_stage": "GA" + }, + "on_start": { + "description": "A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", + "launch_stage": "GA" + }, + "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.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + } + } + }, + "jobs.JobEnvironment": { + "fields": { + "environment_key": { + "description": "The key of an environment. It has to be unique within a job.", + "launch_stage": "GA" + }, + "spec": { + "ref": "compute.Environment", + "launch_stage": "GA" + } + } + }, + "jobs.JobNotificationSettings": { + "fields": { + "no_alert_for_canceled_runs": { + "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.", + "launch_stage": "GA" + }, + "no_alert_for_skipped_runs": { + "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.", + "launch_stage": "GA" + } + } + }, + "jobs.JobParameter": { + "fields": { + "default": { + "description": "The optional default value of the parameter", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the parameter", + "launch_stage": "GA" + }, + "value": { + "description": "The value used in the run", + "launch_stage": "GA" + } + } + }, + "jobs.JobParameterDefinition": { + "fields": { + "default": { + "description": "Default value of the parameter.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`", + "launch_stage": "GA" + } + } + }, + "jobs.JobPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "jobs.JobPermissionLevel", + "launch_stage": "GA" + } + } + }, + "jobs.JobPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "IS_OWNER", + "CAN_MANAGE_RUN", + "CAN_VIEW" + ] + }, + "jobs.JobPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "jobs.JobPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "jobs.JobPermissionLevel", + "launch_stage": "GA" + } + } + }, + "jobs.JobPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "jobs.JobRunAs": { + "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.", + "fields": { + "group_name": { + "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "service_principal_name": { + "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "launch_stage": "GA" + }, + "user_name": { + "description": "The email of an active workspace user. Non-admin users can only set this field to their own email.", + "launch_stage": "GA" + } + } + }, + "jobs.JobSettings": { + "fields": { + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "continuous": { + "description": "An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used.", + "ref": "jobs.Continuous", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment information for jobs managed by external sources.", + "ref": "jobs.JobDeployment", + "launch_stage": "GA" + }, + "description": { + "description": "An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.", + "launch_stage": "GA" + }, + "edit_mode": { + "description": "Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.", + "ref": "jobs.JobEditMode", + "launch_stage": "GA" + }, + "email_notifications": { + "description": "An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.", + "ref": "jobs.JobEmailNotifications", + "launch_stage": "GA" + }, + "environments": { + "description": "A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nFor serverless notebook tasks, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the notebook environment.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.", + "launch_stage": "GA" + }, + "format": { + "description": "Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls. When using the Jobs API 2.1 this value is always set to `\"MULTI_TASK\"`.", + "ref": "jobs.Format", + "deprecated": true, + "launch_stage": "GA" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "health": { + "ref": "jobs.JobsHealthRules", + "launch_stage": "GA" + }, + "job_clusters": { + "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.", + "launch_stage": "GA" + }, + "max_concurrent_runs": { + "description": "An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job’s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.", + "launch_stage": "GA" + }, + "name": { + "description": "An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.", + "ref": "jobs.JobNotificationSettings", + "launch_stage": "GA" + }, + "parameters": { + "description": "Job-level parameter definitions", + "launch_stage": "GA" + }, + "performance_target": { + "description": "The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run.\nThe performance target does not apply to tasks that run on Serverless GPU compute.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "queue": { + "description": "The queue settings of the job.", + "ref": "jobs.QueueSettings", + "launch_stage": "GA" + }, + "run_as": { + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", + "ref": "jobs.JobRunAs", + "launch_stage": "GA" + }, + "schedule": { + "description": "An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "ref": "jobs.CronSchedule", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.", + "launch_stage": "GA" + }, + "tasks": { + "description": "A list of task specifications to be executed by this job.\nIt supports up to 1000 elements in write endpoints (:method:jobs/create, :method:jobs/reset, :method:jobs/update, :method:jobs/submit).\nRead endpoints return only 100 tasks. If more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.", + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "trigger": { + "description": "A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "ref": "jobs.TriggerSettings", + "launch_stage": "GA" + }, + "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.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when runs of this job begin or complete.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.JobSource": { + "description": "The source of the job specification in the remote repository when the job is source controlled.", + "fields": { + "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": "jobs.JobSourceDirtyState", + "launch_stage": "PRIVATE_PREVIEW" + }, + "import_from_git_branch": { + "description": "Name of the branch which the job is imported from.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "job_config_path": { + "description": "Path of the job YAML file that contains the job specification.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.JobSourceDirtyState": { + "description": "Dirty state indicates the job is not fully synced with the job specification\nin the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "enum": [ + "NOT_SYNCED", + "DISCONNECTED" + ], + "enum_launch_stages": { + "DISCONNECTED": "PRIVATE_PREVIEW", + "NOT_SYNCED": "PRIVATE_PREVIEW" + }, + "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." + } + }, + "jobs.JobsHealthMetric": { + "description": "Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.", + "enum": [ + "RUN_DURATION_SECONDS", + "STREAMING_BACKLOG_BYTES", + "STREAMING_BACKLOG_RECORDS", + "STREAMING_BACKLOG_SECONDS", + "STREAMING_BACKLOG_FILES" + ], + "enum_launch_stages": { + "RUN_DURATION_SECONDS": "GA", + "STREAMING_BACKLOG_BYTES": "GA", + "STREAMING_BACKLOG_FILES": "GA", + "STREAMING_BACKLOG_RECORDS": "GA", + "STREAMING_BACKLOG_SECONDS": "GA" + }, + "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." + } + }, + "jobs.JobsHealthOperator": { + "description": "Specifies the operator used to compare the health metric value with the specified threshold.", + "enum": [ + "GREATER_THAN" + ], + "enum_launch_stages": { + "GREATER_THAN": "GA" + } + }, + "jobs.JobsHealthRule": { + "fields": { + "metric": { + "ref": "jobs.JobsHealthMetric", + "launch_stage": "GA" + }, + "op": { + "ref": "jobs.JobsHealthOperator", + "launch_stage": "GA" + }, + "value": { + "description": "Specifies the threshold value that the health metric should obey to satisfy the health rule.", + "launch_stage": "GA" + } + } + }, + "jobs.JobsHealthRules": { + "description": "An optional set of health rules that can be defined for this job.", + "fields": { + "rules": { + "launch_stage": "GA" + } + } + }, + "jobs.ListJobComplianceForPolicyResponse": { + "fields": { + "jobs": { + "description": "A list of jobs and their policy compliance statuses.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "This field represents the pagination token to retrieve the next page of results.\nIf this field is not in the response, it means no further results for the request.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "This field represents the pagination token to retrieve the previous page of results.\nIf this field is not in the response, it means no further results for the request.", + "launch_stage": "GA" + } + } + }, + "jobs.ListJobsResponse": { + "description": "List of jobs was retrieved successfully.", + "fields": { + "has_more": { + "description": "If true, additional jobs matching the provided filter are available for listing.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "jobs": { + "description": "The list of jobs. Only included in the response if there are jobs to list.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to list the next page of jobs (if applicable).", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "A token that can be used to list the previous page of jobs (if applicable).", + "launch_stage": "GA" + } + } + }, + "jobs.ListRunsResponse": { + "description": "List of runs was retrieved successfully.", + "fields": { + "has_more": { + "description": "If true, additional runs matching the provided filter are available for listing.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "A token that can be used to list the next page of runs (if applicable).", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "A token that can be used to list the previous page of runs (if applicable).", + "launch_stage": "GA" + }, + "runs": { + "description": "A list of runs, from most recently started to least. Only included in the response if there are runs to list.", + "launch_stage": "GA" + } + } + }, + "jobs.ModelTriggerConfiguration": { + "fields": { + "aliases": { + "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "condition": { + "description": "The condition based on which to trigger a job run.", + "ref": "jobs.ModelTriggerConfigurationCondition", + "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\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "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\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.ModelTriggerConfigurationCondition": { + "enum": [ + "MODEL_CREATED", + "MODEL_VERSION_READY", + "MODEL_ALIAS_SET" + ], + "enum_launch_stages": { + "MODEL_ALIAS_SET": "PRIVATE_PREVIEW", + "MODEL_CREATED": "PRIVATE_PREVIEW", + "MODEL_VERSION_READY": "PRIVATE_PREVIEW" + } + }, + "jobs.NotebookOutput": { + "fields": { + "result": { + "description": "The value passed to [dbutils.notebook.exit()](/notebooks/notebook-workflows.html#notebook-workflows-exit).\nDatabricks restricts this API to return the first 5 MB of the value. For a larger result, your job can store the results in a cloud storage service.\nThis field is absent if `dbutils.notebook.exit()` was never called.", + "launch_stage": "GA" + }, + "truncated": { + "description": "Whether or not the result was truncated.", + "launch_stage": "GA" + } + } + }, + "jobs.NotebookTask": { + "fields": { + "base_parameters": { + "description": "Base parameters to be used for each run of this job. If the run is initiated by a call to :method:jobs/run\nNow with parameters specified, the two parameters maps are merged. If the same key is specified in\n`base_parameters` and in `run-now`, the value from `run-now` is used.\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nIf the notebook takes a parameter that is not specified in the job’s `base_parameters` or the `run-now` override parameters,\nthe default value from the notebook is used.\n\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\n\nThe JSON representation of this field cannot exceed 1MB.", + "launch_stage": "GA" + }, + "notebook_path": { + "description": "The path of the notebook to be run in the Databricks workspace or remote repository.\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\nFor notebooks stored in a remote repository, the path must be relative. This field is required.", + "launch_stage": "GA" + }, + "source": { + "description": "Optional location type of the notebook. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Notebook is located in Databricks workspace.\n* `GIT`: Notebook is located in cloud Git provider.", + "ref": "jobs.Source", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "Optional `warehouse_id` to run the notebook on a SQL warehouse. Classic SQL warehouses are NOT supported, please use serverless or pro SQL warehouses.\n\nNote that SQL warehouses only support SQL cells; if the notebook contains non-SQL cells, the run will fail.", + "launch_stage": "GA" + } + } + }, + "jobs.OutputSchemaInfo": { + "description": "Stores the catalog name, schema name, and the output schema expiration time for the clean room run.", + "fields": { + "catalog_name": { + "launch_stage": "GA" + }, + "expiration_time": { + "description": "The expiration time for the output schema as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "schema_name": { + "launch_stage": "GA" + } + } + }, + "jobs.PauseStatus": { + "enum": [ + "UNPAUSED", + "PAUSED" + ], + "enum_launch_stages": { + "PAUSED": "GA", + "UNPAUSED": "GA" + } + }, + "jobs.PerformanceTarget": { + "description": "PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run on serverless compute should be.\nThe performance mode on the job or pipeline should map to a performance setting that is passed to Cluster Manager\n(see cluster-common PerformanceTarget).", + "enum": [ + "PERFORMANCE_OPTIMIZED", + "STANDARD" + ], + "enum_launch_stages": { + "PERFORMANCE_OPTIMIZED": "GA", + "STANDARD": "GA" + } + }, + "jobs.PeriodicTriggerConfiguration": { + "fields": { + "interval": { + "description": "The interval at which the trigger should run.", + "launch_stage": "GA" + }, + "unit": { + "description": "The unit of time for the interval.", + "ref": "jobs.PeriodicTriggerConfigurationTimeUnit", + "launch_stage": "GA" + } + } + }, + "jobs.PeriodicTriggerConfigurationTimeUnit": { + "enum": [ + "HOURS", + "DAYS", + "WEEKS" + ], + "enum_launch_stages": { + "DAYS": "GA", + "HOURS": "GA", + "WEEKS": "GA" + } + }, + "jobs.PipelineParams": { + "fields": { + "full_refresh": { + "description": "If true, triggers a full refresh on the spark declarative pipeline.", + "launch_stage": "GA" + }, + "full_refresh_selection": { + "description": "A list of tables to update with fullRefresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "refresh_flow_selection": { + "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "refresh_selection": { + "description": "A list of tables to update without fullRefresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "reset_checkpoint_selection": { + "description": "A list of streaming flows to reset checkpoints without clearing data.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "jobs.PipelineTask": { + "fields": { + "full_refresh": { + "description": "If true, triggers a full refresh on the spark declarative pipeline.", + "launch_stage": "GA" + }, + "full_refresh_selection": { + "description": "A list of tables to update with fullRefresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "parameters": { + "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "pipeline_id": { + "description": "The full name of the pipeline task to execute.", + "launch_stage": "GA" + }, + "refresh_flow_selection": { + "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "refresh_selection": { + "description": "A list of tables to update without fullRefresh.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "reset_checkpoint_selection": { + "description": "A list of streaming flows to reset checkpoints without clearing data.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "jobs.PowerBiModel": { + "fields": { + "authentication_method": { + "description": "How the published Power BI model authenticates to Databricks", + "ref": "jobs.AuthenticationMethod", + "launch_stage": "PUBLIC_PREVIEW" + }, + "model_name": { + "description": "The name of the Power BI model", + "launch_stage": "PUBLIC_PREVIEW" + }, + "overwrite_existing": { + "description": "Whether to overwrite existing Power BI models", + "launch_stage": "PUBLIC_PREVIEW" + }, + "storage_mode": { + "description": "The default storage mode of the Power BI model", + "ref": "jobs.StorageMode", + "launch_stage": "PUBLIC_PREVIEW" + }, + "workspace_name": { + "description": "The name of the Power BI workspace of the model", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.PowerBiTable": { + "fields": { + "catalog": { + "description": "The catalog name in Databricks", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The table name in Databricks", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema": { + "description": "The schema name in Databricks", + "launch_stage": "PUBLIC_PREVIEW" + }, + "storage_mode": { + "description": "The Power BI storage mode of the table", + "ref": "jobs.StorageMode", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.PowerBiTask": { + "fields": { + "connection_resource_name": { + "description": "The resource name of the UC connection to authenticate from Databricks to Power BI", + "launch_stage": "PUBLIC_PREVIEW" + }, + "power_bi_model": { + "description": "The semantic model to update", + "ref": "jobs.PowerBiModel", + "launch_stage": "PUBLIC_PREVIEW" + }, + "refresh_after_update": { + "description": "Whether the model should be refreshed after the update", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tables": { + "description": "The tables to be exported to Power BI", + "launch_stage": "PUBLIC_PREVIEW" + }, + "warehouse_id": { + "description": "The SQL warehouse ID to use as the Power BI data source", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "jobs.PythonOperatorTask": { + "fields": { + "main": { + "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "parameters": { + "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.PythonOperatorTaskParameter": { + "fields": { + "name": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "value": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.PythonWheelTask": { + "fields": { + "entry_point": { + "description": "Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`", + "launch_stage": "GA" + }, + "named_parameters": { + "description": "Command-line parameters passed to Python wheel task in the form of `[\"--name=task\", \"--data=dbfs:/path/to/data.json\"]`. Leave it empty if `parameters` is not null.", + "launch_stage": "GA" + }, + "package_name": { + "description": "Name of the package to execute", + "launch_stage": "GA" + }, + "parameters": { + "description": "Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.", + "launch_stage": "GA" + } + } + }, + "jobs.QueueDetails": { + "fields": { + "code": { + "ref": "jobs.QueueDetailsCodeCode", + "launch_stage": "GA" + }, + "message": { + "description": "A descriptive message with the queuing details. This field is unstructured, and its exact format is subject\nto change.", + "launch_stage": "GA" + } + } + }, + "jobs.QueueDetailsCodeCode": { + "description": "The reason for queuing the run.\n* `ACTIVE_RUNS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active task runs.\n* `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due to reaching the per-job limit of concurrent job runs.\n* `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active run job tasks.", + "enum": [ + "ACTIVE_RUNS_LIMIT_REACHED", + "MAX_CONCURRENT_RUNS_REACHED", + "ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED" + ], + "enum_launch_stages": { + "ACTIVE_RUNS_LIMIT_REACHED": "GA", + "ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED": "GA", + "MAX_CONCURRENT_RUNS_REACHED": "GA" + }, + "enum_descriptions": { + "ACTIVE_RUNS_LIMIT_REACHED": "The run was queued due to reaching the workspace limit of active task runs.", + "ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED": "The run was queued due to reaching the workspace limit of active run job tasks.", + "MAX_CONCURRENT_RUNS_REACHED": "The run was queued due to reaching the per-job limit of concurrent job runs." + } + }, + "jobs.QueueSettings": { + "fields": { + "enabled": { + "description": "If true, enable queueing for the job. This is a required field.", + "launch_stage": "GA" + } + } + }, + "jobs.RepairHistoryItem": { + "fields": { + "effective_performance_target": { + "description": "The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported by the job type.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "end_time": { + "description": "The end time of the (repaired) run.", + "launch_stage": "GA" + }, + "id": { + "description": "The ID of the repair. Only returned for the items that represent a repair in `repair_history`.", + "launch_stage": "GA" + }, + "start_time": { + "description": "The start time of the (repaired) run.", + "launch_stage": "GA" + }, + "state": { + "description": "Deprecated. Please use the `status` field instead.", + "ref": "jobs.RunState", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "ref": "jobs.RunStatus", + "launch_stage": "GA" + }, + "task_run_ids": { + "description": "The run IDs of the task runs that ran as part of this repair history item.", + "launch_stage": "GA" + }, + "type": { + "description": "The repair history item type. Indicates whether a run is the original run or a repair run.", + "ref": "jobs.RepairHistoryItemType", + "launch_stage": "GA" + } + } + }, + "jobs.RepairHistoryItemType": { + "description": "The repair history item type. Indicates whether a run is the original run or\na repair run.", + "enum": [ + "ORIGINAL", + "REPAIR" + ], + "enum_launch_stages": { + "ORIGINAL": "GA", + "REPAIR": "GA" + } + }, + "jobs.RepairRun": { + "fields": { + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "job_parameters": { + "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "launch_stage": "GA" + }, + "latest_repair_id": { + "description": "The ID of the latest repair. This parameter is not required when repairing a run for the first time, but must be provided on subsequent requests to repair the same run.", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "performance_target": { + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "pipeline_params": { + "description": "Controls whether the pipeline should perform a full refresh", + "ref": "jobs.PipelineParams", + "launch_stage": "GA" + }, + "python_named_params": { + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "rerun_all_failed_tasks": { + "description": "If true, repair all failed tasks. Only one of `rerun_tasks` or `rerun_all_failed_tasks` can be used.", + "launch_stage": "GA" + }, + "rerun_dependent_tasks": { + "description": "If true, repair all tasks that depend on the tasks in `rerun_tasks`, even if they were previously successful. Can be also used in combination with `rerun_all_failed_tasks`.", + "launch_stage": "GA" + }, + "rerun_tasks": { + "description": "The task keys of the task runs to repair.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The job run ID of the run to repair. The run must not be in progress.", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.RepairRunResponse": { + "description": "Run repair was initiated.", + "fields": { + "repair_id": { + "description": "The ID of the repair. Must be provided in subsequent repairs using the `latest_repair_id` field to ensure sequential repairs.", + "launch_stage": "GA" + } + } + }, + "jobs.ResetJob": { + "fields": { + "job_id": { + "description": "The canonical identifier of the job to reset. This field is required.", + "launch_stage": "GA" + }, + "new_settings": { + "description": "The new settings of the job. These settings completely replace the old settings.\n\nChanges to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "ref": "jobs.JobSettings", + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedConditionTaskValues": { + "fields": { + "left": { + "launch_stage": "GA" + }, + "right": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedDbtTaskValues": { + "fields": { + "commands": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedNotebookTaskValues": { + "fields": { + "base_parameters": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedParamPairValues": { + "fields": { + "parameters": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedPipelineTaskValues": { + "fields": { + "parameters": { + "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "jobs.ResolvedPythonWheelTaskValues": { + "fields": { + "named_parameters": { + "launch_stage": "GA" + }, + "parameters": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedRunJobTaskValues": { + "fields": { + "job_parameters": { + "launch_stage": "GA" + }, + "parameters": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedStringParamsValues": { + "fields": { + "parameters": { + "launch_stage": "GA" + } + } + }, + "jobs.ResolvedValues": { + "fields": { + "condition_task": { + "ref": "jobs.ResolvedConditionTaskValues", + "launch_stage": "GA" + }, + "dbt_task": { + "ref": "jobs.ResolvedDbtTaskValues", + "launch_stage": "GA" + }, + "notebook_task": { + "ref": "jobs.ResolvedNotebookTaskValues", + "launch_stage": "GA" + }, + "pipeline_task": { + "ref": "jobs.ResolvedPipelineTaskValues", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "python_wheel_task": { + "ref": "jobs.ResolvedPythonWheelTaskValues", + "launch_stage": "GA" + }, + "run_job_task": { + "ref": "jobs.ResolvedRunJobTaskValues", + "launch_stage": "GA" + }, + "simulation_task": { + "ref": "jobs.ResolvedParamPairValues", + "launch_stage": "GA" + }, + "spark_jar_task": { + "ref": "jobs.ResolvedStringParamsValues", + "launch_stage": "GA" + }, + "spark_python_task": { + "ref": "jobs.ResolvedStringParamsValues", + "launch_stage": "GA" + }, + "spark_submit_task": { + "ref": "jobs.ResolvedStringParamsValues", + "launch_stage": "GA" + }, + "sql_task": { + "ref": "jobs.ResolvedParamPairValues", + "launch_stage": "GA" + } + } + }, + "jobs.Run": { + "description": "Run was retrieved successfully", + "fields": { + "attempt_number": { + "description": "The sequence number of this run attempt for a triggered job run. The initial attempt of a run has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy (`max_retries` \u003e 0), subsequent runs are created with an `original_attempt_run_id` of the original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job.", + "launch_stage": "GA" + }, + "cleanup_duration": { + "description": "The time in milliseconds it took to terminate the cluster and clean up any associated artifacts. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `cleanup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "cluster_instance": { + "description": "The cluster used for this run. If the run is specified to use a new cluster, this field is set once the Jobs service has requested a cluster for the run.", + "ref": "jobs.ClusterInstance", + "launch_stage": "GA" + }, + "cluster_spec": { + "description": "A snapshot of the job’s cluster specification when this run was created.", + "ref": "jobs.ClusterSpec", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The creator user name. This field won’t be included in the response if the user has already been deleted.", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the run", + "launch_stage": "GA" + }, + "effective_performance_target": { + "description": "The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported by the job type.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "effective_usage_policy_id": { + "description": "The id of the usage policy used by this run for cost attribution purposes.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "end_time": { + "description": "The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This field is set to 0 if the job is still running.", + "launch_stage": "GA" + }, + "execution_duration": { + "description": "The time in milliseconds it took to execute the commands in the JAR or notebook until they completed, failed, timed out, were cancelled, or encountered an unexpected error. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `execution_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "has_more": { + "description": "Indicates if the run has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/getrun endpoint.\nIt is only relevant for API 2.2 :method:jobs/listruns requests with `expand_tasks=true`.", + "launch_stage": "GA" + }, + "iterations": { + "description": "Only populated by for-each iterations. The parent for-each task is located in tasks array.", + "launch_stage": "GA" + }, + "job_clusters": { + "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.\nIf more than 100 job clusters are available, you can paginate through them using :method:jobs/getrun.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier of the job that contains this run.", + "launch_stage": "GA" + }, + "job_parameters": { + "description": "Job-level parameters used in the run", + "launch_stage": "GA" + }, + "job_run_id": { + "description": "ID of the job run that this run belongs to.\nFor legacy and single-task job runs the field is populated with the job run ID.\nFor task runs, the field is populated with the ID of the job run that the task run belongs to.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to list the next page of array properties.", + "launch_stage": "GA" + }, + "number_in_job": { + "description": "A unique identifier for this job run. This is set to the same value as `run_id`.", + "deprecated": true, + "launch_stage": "GA" + }, + "original_attempt_run_id": { + "description": "If this run is a retry of a prior run attempt, this field contains the run_id of the original attempt; otherwise, it is the same as the run_id.", + "launch_stage": "GA" + }, + "overriding_parameters": { + "description": "The parameters used for this run.", + "ref": "jobs.RunParameters", + "launch_stage": "GA" + }, + "queue_duration": { + "description": "The time in milliseconds that the run has spent in the queue.", + "launch_stage": "GA" + }, + "repair_history": { + "description": "The repair history of the run.", + "launch_stage": "GA" + }, + "run_duration": { + "description": "The time in milliseconds it took the job run and all of its repairs to finish.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The canonical identifier of the run. This ID is unique across all runs of all jobs.", + "launch_stage": "GA" + }, + "run_name": { + "description": "An optional name for the run. The maximum length is 4096 bytes in UTF-8 encoding.", + "launch_stage": "GA" + }, + "run_page_url": { + "description": "The URL to the detail page of the run.", + "launch_stage": "GA" + }, + "run_type": { + "ref": "jobs.RunType", + "launch_stage": "GA" + }, + "schedule": { + "description": "The cron schedule that triggered this run if it was triggered by the periodic scheduler.", + "ref": "jobs.CronSchedule", + "launch_stage": "GA" + }, + "setup_duration": { + "description": "The time in milliseconds it took to set up the cluster. For runs that run on new clusters this is the cluster creation time, for runs that run on existing clusters this time should be very short. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `setup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "start_time": { + "description": "The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued.", + "launch_stage": "GA" + }, + "state": { + "description": "Deprecated. Please use the `status` field instead.", + "ref": "jobs.RunState", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "ref": "jobs.RunStatus", + "launch_stage": "GA" + }, + "tasks": { + "description": "The list of tasks performed by the run. Each task has its own `run_id` which you can use to call `JobsGetOutput` to retrieve the run resutls.\nIf more than 100 tasks are available, you can paginate through them using :method:jobs/getrun. Use the `next_page_token` field at the object root to determine if more results are available.", + "launch_stage": "GA" + }, + "trigger": { + "ref": "jobs.TriggerType", + "launch_stage": "GA" + }, + "trigger_info": { + "ref": "jobs.TriggerInfo", + "launch_stage": "GA" + } + } + }, + "jobs.RunConditionTask": { + "fields": { + "left": { + "description": "The left operand of the condition task. Can be either a string value or a job state or parameter reference.", + "launch_stage": "GA" + }, + "op": { + "description": "* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” \u003e= “12”` will evaluate to `true`, `“10.0” \u003e= “12”` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.", + "ref": "jobs.ConditionTaskOp", + "launch_stage": "GA" + }, + "outcome": { + "description": "The condition expression evaluation result. Filled in if the task was successfully completed. Can be `\"true\"` or `\"false\"`", + "launch_stage": "GA" + }, + "right": { + "description": "The right operand of the condition task. Can be either a string value or a job state or parameter reference.", + "launch_stage": "GA" + } + } + }, + "jobs.RunForEachTask": { + "fields": { + "concurrency": { + "description": "An optional maximum allowed number of concurrent runs of the task.\nSet this value if you want to be able to execute multiple runs of the task concurrently.", + "launch_stage": "GA" + }, + "inputs": { + "description": "Array for task to iterate on. This can be a JSON string or a reference to\nan array parameter.", + "launch_stage": "GA" + }, + "stats": { + "description": "Read only field. Populated for GetRun and ListRuns RPC calls and stores the execution stats of an For each task", + "ref": "jobs.ForEachStats", + "launch_stage": "GA" + }, + "task": { + "description": "Configuration for the task that will be run for each element in the array", + "ref": "jobs.Task", + "launch_stage": "GA" + } + } + }, + "jobs.RunIf": { + "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`.\n\nPossible values are:\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed", + "enum": [ + "ALL_SUCCESS", + "ALL_DONE", + "NONE_FAILED", + "AT_LEAST_ONE_SUCCESS", + "ALL_FAILED", + "AT_LEAST_ONE_FAILED" + ], + "enum_launch_stages": { + "ALL_DONE": "GA", + "ALL_FAILED": "GA", + "ALL_SUCCESS": "GA", + "AT_LEAST_ONE_FAILED": "GA", + "AT_LEAST_ONE_SUCCESS": "GA", + "NONE_FAILED": "GA" + }, + "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" + } + }, + "jobs.RunJobOutput": { + "fields": { + "run_id": { + "description": "The run id of the triggered job run", + "launch_stage": "GA" + } + } + }, + "jobs.RunJobTask": { + "fields": { + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "job_id": { + "description": "ID of the job to trigger.", + "launch_stage": "GA" + }, + "job_parameters": { + "description": "Job-level parameters used to trigger the job.", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "pipeline_params": { + "description": "Controls whether the pipeline should perform a full refresh", + "ref": "jobs.PipelineParams", + "launch_stage": "GA" + }, + "python_named_params": { + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.RunLifeCycleState": { + "description": "A value indicating the run's lifecycle state. The possible values are:\n* `QUEUED`: The run is queued.\n* `PENDING`: The run is waiting to be executed while the cluster and execution context are being prepared.\n* `RUNNING`: The task of this run is being executed.\n* `TERMINATING`: The task of this run has completed, and the cluster and execution context are being cleaned up.\n* `TERMINATED`: The task of this run has completed, and the cluster and execution context have been cleaned up. This state is terminal.\n* `SKIPPED`: This run was aborted because a previous run of the same job was already active. This state is terminal.\n* `INTERNAL_ERROR`: An exceptional state that indicates a failure in the Jobs service, such as network failure over a long period. If a run on a new cluster ends in the `INTERNAL_ERROR` state, the Jobs service terminates the cluster as soon as possible. This state is terminal.\n* `BLOCKED`: The run is blocked on an upstream dependency.\n* `WAITING_FOR_RETRY`: The run is waiting for a retry.", + "enum": [ + "PENDING", + "RUNNING", + "TERMINATING", + "TERMINATED", + "SKIPPED", + "INTERNAL_ERROR", + "BLOCKED", + "WAITING_FOR_RETRY", + "QUEUED" + ], + "enum_launch_stages": { + "BLOCKED": "GA", + "INTERNAL_ERROR": "GA", + "PENDING": "GA", + "QUEUED": "GA", + "RUNNING": "GA", + "SKIPPED": "GA", + "TERMINATED": "GA", + "TERMINATING": "GA", + "WAITING_FOR_RETRY": "GA" + }, + "enum_descriptions": { + "BLOCKED": "The run is blocked on an upstream dependency.", + "INTERNAL_ERROR": "An exceptional state that indicates a failure in the Jobs service, such as network failure over a long period. If a run on a new cluster ends in the `INTERNAL_ERROR` state, the Jobs service terminates the cluster as soon as possible. This state is terminal.", + "PENDING": "The run is waiting to be executed while the cluster and execution context are being prepared.", + "QUEUED": "The run is queued.", + "RUNNING": "The task of this run is being executed.", + "SKIPPED": "This run was aborted because a previous run of the same job was already active. This state is terminal.", + "TERMINATED": "The task of this run has completed, and the cluster and execution context have been cleaned up. This state is terminal.", + "TERMINATING": "The task of this run has completed, and the cluster and execution context are being cleaned up.", + "WAITING_FOR_RETRY": "The run is waiting for a retry." + } + }, + "jobs.RunLifecycleStateV2State": { + "description": "The current state of the run.", + "enum": [ + "BLOCKED", + "PENDING", + "QUEUED", + "RUNNING", + "TERMINATING", + "TERMINATED", + "WAITING" + ], + "enum_launch_stages": { + "BLOCKED": "GA", + "PENDING": "GA", + "QUEUED": "GA", + "RUNNING": "GA", + "TERMINATED": "GA", + "TERMINATING": "GA", + "WAITING": "GA" + } + }, + "jobs.RunNow": { + "fields": { + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "idempotency_token": { + "description": "An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run\nis launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "job_id": { + "description": "The ID of the job to be executed", + "launch_stage": "GA" + }, + "job_parameters": { + "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "only": { + "description": "A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.", + "launch_stage": "GA" + }, + "performance_target": { + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA" + }, + "pipeline_params": { + "description": "Controls whether the pipeline should perform a full refresh", + "ref": "jobs.PipelineParams", + "launch_stage": "GA" + }, + "python_named_params": { + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "queue": { + "description": "The queue settings of the run.", + "ref": "jobs.QueueSettings", + "launch_stage": "GA" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.RunNowResponse": { + "description": "Run was started successfully.", + "fields": { + "number_in_job": { + "description": "A unique identifier for this job run. This is set to the same value as `run_id`.", + "deprecated": true, + "launch_stage": "GA" + }, + "run_id": { + "description": "The globally unique ID of the newly triggered run.", + "launch_stage": "GA" + } + } + }, + "jobs.RunOutput": { + "description": "Run output was retrieved successfully.", + "fields": { + "alert_output": { + "description": "The output of an alert task, if available", + "ref": "jobs.AlertTaskOutput", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "clean_rooms_notebook_output": { + "description": "The output of a clean rooms notebook task, if available", + "ref": "jobs.CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput", + "launch_stage": "GA" + }, + "dashboard_output": { + "description": "The output of a dashboard task, if available", + "ref": "jobs.DashboardTaskOutput", + "launch_stage": "GA" + }, + "dbt_cloud_output": { + "description": "Deprecated in favor of the new dbt_platform_output", + "ref": "jobs.DbtCloudTaskOutput", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_output": { + "description": "The output of a dbt task, if available.", + "ref": "jobs.DbtOutput", + "launch_stage": "GA" + }, + "dbt_platform_output": { + "ref": "jobs.DbtPlatformTaskOutput", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "error": { + "description": "An error message indicating why a task failed or why output is not available. The message is unstructured, and its exact format is subject to change.", + "launch_stage": "GA" + }, + "error_trace": { + "description": "If there was an error executing the run, this field contains any available stack traces.", + "launch_stage": "GA" + }, + "info": { + "launch_stage": "GA" + }, + "logs": { + "description": "The output from tasks that write to standard streams (stdout/stderr) such as\nspark_jar_task, spark_python_task, python_wheel_task.\n\nIt's not supported for the notebook_task, pipeline_task or spark_submit_task.\n\nDatabricks restricts this API to return the last 5 MB of these logs.", + "launch_stage": "GA" + }, + "logs_truncated": { + "description": "Whether the logs are truncated.", + "launch_stage": "GA" + }, + "metadata": { + "description": "All details of the run except for its output.", + "ref": "jobs.Run", + "launch_stage": "GA" + }, + "notebook_output": { + "description": "The output of a notebook task, if available. A notebook task that terminates (either successfully or with a failure)\nwithout calling `dbutils.notebook.exit()` is considered to have an empty output.\nThis field is set but its result value is empty. Databricks restricts this API to return the first 5 MB of the output.\nTo return a larger result, use the [ClusterLogConf](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterlogconf) field to configure log storage\nfor the job cluster.", + "ref": "jobs.NotebookOutput", + "launch_stage": "GA" + }, + "run_job_output": { + "description": "The output of a run job task, if available", + "ref": "jobs.RunJobOutput", + "launch_stage": "GA" + }, + "sql_output": { + "description": "The output of a SQL task, if available.", + "ref": "jobs.SqlOutput", + "launch_stage": "GA" + } + } + }, + "jobs.RunParameters": { + "fields": { + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "pipeline_params": { + "description": "Controls whether the pipeline should perform a full refresh", + "ref": "jobs.PipelineParams", + "launch_stage": "GA" + }, + "python_named_params": { + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "jobs.RunResultState": { + "description": "A value indicating the run's result. The possible values are:\n* `SUCCESS`: The task completed successfully.\n* `FAILED`: The task completed with an error.\n* `TIMEDOUT`: The run was stopped after reaching the timeout.\n* `CANCELED`: The run was canceled at user request.\n* `MAXIMUM_CONCURRENT_RUNS_REACHED`: The run was skipped because the maximum concurrent runs were reached.\n* `EXCLUDED`: The run was skipped because the necessary conditions were not met.\n* `SUCCESS_WITH_FAILURES`: The job run completed successfully with some failures; leaf tasks were successful.\n* `UPSTREAM_FAILED`: The run was skipped because of an upstream failure.\n* `UPSTREAM_CANCELED`: The run was skipped because an upstream task was canceled.\n* `DISABLED`: The run was skipped because it was disabled explicitly by the user.", + "enum": [ + "SUCCESS", + "FAILED", + "TIMEDOUT", + "CANCELED", + "MAXIMUM_CONCURRENT_RUNS_REACHED", + "UPSTREAM_CANCELED", + "UPSTREAM_FAILED", + "EXCLUDED", + "SUCCESS_WITH_FAILURES", + "DISABLED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "DISABLED": "GA", + "EXCLUDED": "GA", + "FAILED": "GA", + "MAXIMUM_CONCURRENT_RUNS_REACHED": "GA", + "SUCCESS": "GA", + "SUCCESS_WITH_FAILURES": "GA", + "TIMEDOUT": "GA", + "UPSTREAM_CANCELED": "GA", + "UPSTREAM_FAILED": "GA" + }, + "enum_descriptions": { + "CANCELED": "The run was canceled at user request.", + "DISABLED": "The run was skipped because it was disabled explicitly by the user.", + "EXCLUDED": "The run was skipped because the necessary conditions were not met.", + "FAILED": "The task completed with an error.", + "MAXIMUM_CONCURRENT_RUNS_REACHED": "The run was skipped because the maximum concurrent runs were reached.", + "SUCCESS": "The task completed successfully.", + "SUCCESS_WITH_FAILURES": "The job run completed successfully with some failures; leaf tasks were successful.", + "TIMEDOUT": "The run was stopped after reaching the timeout.", + "UPSTREAM_CANCELED": "The run was skipped because an upstream task was canceled.", + "UPSTREAM_FAILED": "The run was skipped because of an upstream failure." + } + }, + "jobs.RunState": { + "description": "The current state of the run.", + "fields": { + "life_cycle_state": { + "description": "A value indicating the run's current lifecycle state. This field is always available in the response. Note: Additional states might be introduced in future releases.", + "ref": "jobs.RunLifeCycleState", + "launch_stage": "GA" + }, + "queue_reason": { + "description": "The reason indicating why the run was queued.", + "launch_stage": "GA" + }, + "result_state": { + "description": "A value indicating the run's result. This field is only available for terminal lifecycle states. Note: Additional states might be introduced in future releases.", + "ref": "jobs.RunResultState", + "launch_stage": "GA" + }, + "state_message": { + "description": "A descriptive message for the current state. This field is unstructured, and its exact format is subject to change.", + "launch_stage": "GA" + }, + "user_cancelled_or_timedout": { + "description": "A value indicating whether a run was canceled manually by a user or by the scheduler because the run timed out.", + "launch_stage": "GA" + } + } + }, + "jobs.RunStatus": { + "description": "The current status of the run", + "fields": { + "queue_details": { + "description": "If the run was queued, details about the reason for queuing the run.", + "ref": "jobs.QueueDetails", + "launch_stage": "GA" + }, + "state": { + "ref": "jobs.RunLifecycleStateV2State", + "launch_stage": "GA" + }, + "termination_details": { + "description": "If the run is in a TERMINATING or TERMINATED state, details about the reason for terminating the run.", + "ref": "jobs.TerminationDetails", + "launch_stage": "GA" + } + } + }, + "jobs.RunTask": { + "description": "Used when outputting a child run, in GetRun or ListRuns.", + "fields": { + "alert_task": { + "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "ref": "jobs.AlertTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "attempt_number": { + "description": "The sequence number of this run attempt for a triggered job run. The initial attempt of a run has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy (`max_retries` \u003e 0), subsequent runs are created with an `original_attempt_run_id` of the original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job.", + "launch_stage": "GA" + }, + "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": "jobs.CleanRoomsNotebookTask", + "launch_stage": "GA" + }, + "cleanup_duration": { + "description": "The time in milliseconds it took to terminate the cluster and clean up any associated artifacts. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `cleanup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "cluster_instance": { + "description": "The cluster used for this run. If the run is specified to use a new cluster, this field is set once the Jobs service has requested a cluster for the run.", + "ref": "jobs.ClusterInstance", + "launch_stage": "GA" + }, + "compute": { + "description": "Task level compute configuration.", + "ref": "jobs.Compute", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY" + ] + }, + "condition_task": { + "description": "The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications.", + "ref": "jobs.RunConditionTask", + "launch_stage": "GA" + }, + "dashboard_task": { + "description": "The task refreshes a dashboard and sends a snapshot to subscribers.", + "ref": "jobs.DashboardTask", + "launch_stage": "GA" + }, + "dbt_cloud_task": { + "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "ref": "jobs.DbtCloudTask", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_platform_task": { + "ref": "jobs.DbtPlatformTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_task": { + "description": "The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.", + "ref": "jobs.DbtTask", + "launch_stage": "GA" + }, + "depends_on": { + "description": "An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete successfully before executing this task.\nThe key is `task_key`, and the value is the name assigned to the dependent task.", + "launch_stage": "GA" + }, + "description": { + "description": "An optional description for this task.", + "launch_stage": "GA" + }, + "disable_auto_optimization": { + "description": "An option to disable auto optimization in serverless", + "launch_stage": "GA" + }, + "disabled": { + "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_performance_target": { + "description": "The actual performance target used by the serverless run during execution. This can differ from the client-set performance target on the request depending on whether the performance mode is supported by the job type.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "ref": "jobs.PerformanceTarget", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "email_notifications": { + "description": "An optional set of email addresses notified when the task run begins or completes. The default behavior is to not send any emails.", + "ref": "jobs.JobEmailNotifications", + "launch_stage": "GA" + }, + "end_time": { + "description": "The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This field is set to 0 if the job is still running.", + "launch_stage": "GA" + }, + "environment_key": { + "description": "The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute.", + "launch_stage": "GA" + }, + "execution_duration": { + "description": "The time in milliseconds it took to execute the commands in the JAR or notebook until they completed, failed, timed out, were cancelled, or encountered an unexpected error. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `execution_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "existing_cluster_id": { + "description": "If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability", + "launch_stage": "GA" + }, + "for_each_task": { + "description": "The task executes a nested task for every input provided when the `for_each_task` field is present.", + "ref": "jobs.RunForEachTask", + "launch_stage": "GA" + }, + "gen_ai_compute_task": { + "ref": "jobs.GenAiComputeTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks. If `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task. Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "job_cluster_key": { + "description": "If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.", + "launch_stage": "GA" + }, + "libraries": { + "description": "An optional list of libraries to be installed on the cluster.\nThe default value is an empty list.", + "launch_stage": "GA" + }, + "max_retries": { + "description": "An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.", + "launch_stage": "GA" + }, + "min_retry_interval_millis": { + "description": "An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.", + "launch_stage": "GA" + }, + "new_cluster": { + "description": "If new_cluster, a description of a new cluster that is created for each run.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + }, + "notebook_task": { + "description": "The task runs a notebook when the `notebook_task` field is present.", + "ref": "jobs.NotebookTask", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task run.", + "ref": "jobs.TaskNotificationSettings", + "launch_stage": "GA" + }, + "pipeline_task": { + "description": "The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported.", + "ref": "jobs.PipelineTask", + "launch_stage": "GA" + }, + "power_bi_task": { + "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "ref": "jobs.PowerBiTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "python_operator_task": { + "description": "The task runs a Python operator task.", + "ref": "jobs.PythonOperatorTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "python_wheel_task": { + "description": "The task runs a Python wheel when the `python_wheel_task` field is present.", + "ref": "jobs.PythonWheelTask", + "launch_stage": "GA" + }, + "queue_duration": { + "description": "The time in milliseconds that the run has spent in the queue.", + "launch_stage": "GA" + }, + "resolved_values": { + "description": "Parameter values including resolved references", + "ref": "jobs.ResolvedValues", + "launch_stage": "GA" + }, + "retry_on_timeout": { + "description": "An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout.", + "launch_stage": "GA" + }, + "run_duration": { + "description": "The time in milliseconds it took the job run and all of its repairs to finish.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The ID of the task run.", + "launch_stage": "GA" + }, + "run_if": { + "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`. See :method:jobs/create for a list of possible values.", + "ref": "jobs.RunIf", + "launch_stage": "GA" + }, + "run_job_task": { + "description": "The task triggers another job when the `run_job_task` field is present.", + "ref": "jobs.RunJobTask", + "launch_stage": "GA" + }, + "run_page_url": { + "launch_stage": "GA" + }, + "setup_duration": { + "description": "The time in milliseconds it took to set up the cluster. For runs that run on new clusters this is the cluster creation time, for runs that run on existing clusters this time should be very short. The duration of a task run is the sum of the `setup_duration`, `execution_duration`, and the `cleanup_duration`. The `setup_duration` field is set to 0 for multitask job runs. The total duration of a multitask job run is the value of the `run_duration` field.", + "launch_stage": "GA" + }, + "spark_jar_task": { + "description": "The task runs a JAR when the `spark_jar_task` field is present.", + "ref": "jobs.SparkJarTask", + "launch_stage": "GA" + }, + "spark_python_task": { + "description": "The task runs a Python file when the `spark_python_task` field is present.", + "ref": "jobs.SparkPythonTask", + "launch_stage": "GA" + }, + "spark_submit_task": { + "description": "(Legacy) The task runs the spark-submit script when the spark_submit_task field is present. Databricks recommends using the spark_jar_task instead; see [Spark Submit task for jobs](/jobs/spark-submit).", + "ref": "jobs.SparkSubmitTask", + "deprecated": true, + "launch_stage": "GA" + }, + "sql_task": { + "description": "The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present.", + "ref": "jobs.SqlTask", + "launch_stage": "GA" + }, + "start_time": { + "description": "The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued.", + "launch_stage": "GA" + }, + "state": { + "description": "Deprecated. Please use the `status` field instead.", + "ref": "jobs.RunState", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "ref": "jobs.RunStatus", + "launch_stage": "GA" + }, + "task_key": { + "description": "A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.", + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job task. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when the run begins or completes. The default behavior is to not send any system notifications. Task webhooks respect the task notification settings.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.RunType": { + "description": "The type of a run.\n* `JOB_RUN`: Normal job run. A run created with :method:jobs/runNow.\n* `WORKFLOW_RUN`: Workflow run. A run created with [dbutils.notebook.run](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-workflow).\n* `SUBMIT_RUN`: Submit run. A run created with :method:jobs/submit.", + "enum": [ + "JOB_RUN", + "WORKFLOW_RUN", + "SUBMIT_RUN" + ], + "enum_launch_stages": { + "JOB_RUN": "GA", + "SUBMIT_RUN": "GA", + "WORKFLOW_RUN": "GA" + }, + "enum_descriptions": { + "JOB_RUN": "Normal job run. A run created with :method:jobs/runNow.", + "SUBMIT_RUN": "Submit run. A run created with :method:jobs/submit.", + "WORKFLOW_RUN": "Workflow run. A run created with [dbutils.notebook.run](/dev-tools/databricks-utils.html#dbutils-workflow)." + } + }, + "jobs.Source": { + "description": "Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\\\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider.", + "enum": [ + "WORKSPACE", + "GIT" + ], + "enum_launch_stages": { + "GIT": "GA", + "WORKSPACE": "GA" + }, + "enum_descriptions": { + "GIT": "SQL file is located in cloud Git provider.", + "WORKSPACE": "SQL file is located in \u003cDatabricks\u003e workspace." + } + }, + "jobs.SparkJarTask": { + "fields": { + "jar_uri": { + "description": "Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list.\n\nSee the examples of classic and serverless compute usage at the top of the page.", + "deprecated": true, + "launch_stage": "GA" + }, + "main_class_name": { + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\n\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Parameters passed to the main method.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", + "launch_stage": "GA" + }, + "run_as_repl": { + "description": "Deprecated. A value of `false` is no longer supported.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "jobs.SparkPythonTask": { + "fields": { + "parameters": { + "description": "Command line parameters passed to the Python file.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", + "launch_stage": "GA" + }, + "python_file": { + "description": "The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "launch_stage": "GA" + }, + "source": { + "description": "Optional location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local\nDatabricks workspace or cloud location (if the `python_file` has a URI format). When set to `GIT`,\nthe Python file will be retrieved from a Git repository defined in `git_source`.\n\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository.", + "ref": "jobs.Source", + "launch_stage": "GA" + } + } + }, + "jobs.SparkSubmitTask": { + "fields": { + "parameters": { + "description": "Command-line parameters passed to spark submit.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", + "launch_stage": "GA" + } + } + }, + "jobs.SparseCheckout": { + "fields": { + "patterns": { + "description": "List of patterns to include for sparse checkout.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlAlertOutput": { + "fields": { + "alert_state": { + "ref": "jobs.SqlAlertState", + "launch_stage": "GA" + }, + "output_link": { + "description": "The link to find the output results.", + "launch_stage": "GA" + }, + "query_text": { + "description": "The text of the SQL query. Can Run permission of the SQL query associated with the SQL alert is required to view this field.", + "launch_stage": "GA" + }, + "sql_statements": { + "description": "Information about SQL statements executed in the run.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "The canonical identifier of the SQL warehouse.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlAlertState": { + "description": "The state of the SQL alert.\n\n* UNKNOWN: alert yet to be evaluated\n* OK: alert evaluated and did not fulfill trigger conditions\n* TRIGGERED: alert evaluated and fulfilled trigger conditions", + "enum": [ + "UNKNOWN", + "OK", + "TRIGGERED" + ], + "enum_launch_stages": { + "OK": "GA", + "TRIGGERED": "GA", + "UNKNOWN": "GA" + } + }, + "jobs.SqlDashboardOutput": { + "fields": { + "warehouse_id": { + "description": "The canonical identifier of the SQL warehouse.", + "launch_stage": "GA" + }, + "widgets": { + "description": "Widgets executed in the run. Only SQL query based widgets are listed.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlDashboardWidgetOutput": { + "fields": { + "end_time": { + "description": "Time (in epoch milliseconds) when execution of the SQL widget ends.", + "launch_stage": "GA" + }, + "error": { + "description": "The information about the error when execution fails.", + "ref": "jobs.SqlOutputError", + "launch_stage": "GA" + }, + "output_link": { + "description": "The link to find the output results.", + "launch_stage": "GA" + }, + "start_time": { + "description": "Time (in epoch milliseconds) when execution of the SQL widget starts.", + "launch_stage": "GA" + }, + "status": { + "description": "The execution status of the SQL widget.", + "ref": "jobs.SqlDashboardWidgetOutputStatus", + "launch_stage": "GA" + }, + "widget_id": { + "description": "The canonical identifier of the SQL widget.", + "launch_stage": "GA" + }, + "widget_title": { + "description": "The title of the SQL widget.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlDashboardWidgetOutputStatus": { + "enum": [ + "PENDING", + "RUNNING", + "SUCCESS", + "FAILED", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "GA", + "FAILED": "GA", + "PENDING": "GA", + "RUNNING": "GA", + "SUCCESS": "GA" + } + }, + "jobs.SqlOutput": { + "fields": { + "alert_output": { + "description": "The output of a SQL alert task, if available.", + "ref": "jobs.SqlAlertOutput", + "launch_stage": "GA" + }, + "dashboard_output": { + "description": "The output of a SQL dashboard task, if available.", + "ref": "jobs.SqlDashboardOutput", + "launch_stage": "GA" + }, + "query_output": { + "description": "The output of a SQL query task, if available.", + "ref": "jobs.SqlQueryOutput", + "launch_stage": "GA" + } + } + }, + "jobs.SqlOutputError": { + "fields": { + "message": { + "description": "The error message when execution fails.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlQueryOutput": { + "fields": { + "endpoint_id": { + "launch_stage": "GA" + }, + "output_link": { + "description": "The link to find the output results.", + "launch_stage": "GA" + }, + "query_text": { + "description": "The text of the SQL query. Can Run permission of the SQL query is required to view this field.", + "launch_stage": "GA" + }, + "sql_statements": { + "description": "Information about SQL statements executed in the run.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "The canonical identifier of the SQL warehouse.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlStatementOutput": { + "fields": { + "lookup_key": { + "description": "A key that can be used to look up query details.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTask": { + "fields": { + "alert": { + "description": "If alert, indicates that this job must refresh a SQL alert.", + "ref": "jobs.SqlTaskAlert", + "launch_stage": "GA" + }, + "dashboard": { + "description": "If dashboard, indicates that this job must refresh a SQL dashboard.", + "ref": "jobs.SqlTaskDashboard", + "launch_stage": "GA" + }, + "file": { + "description": "If file, indicates that this job runs a SQL file in a remote Git repository.", + "ref": "jobs.SqlTaskFile", + "launch_stage": "GA" + }, + "parameters": { + "description": "Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.", + "launch_stage": "GA" + }, + "query": { + "description": "If query, indicates that this job must execute a SQL query.", + "ref": "jobs.SqlTaskQuery", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTaskAlert": { + "fields": { + "alert_id": { + "description": "The canonical identifier of the SQL alert.", + "launch_stage": "GA" + }, + "pause_subscriptions": { + "description": "If true, the alert notifications are not sent to subscribers.", + "launch_stage": "GA" + }, + "subscriptions": { + "description": "If specified, alert notifications are sent to subscribers.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTaskDashboard": { + "fields": { + "custom_subject": { + "description": "Subject of the email sent to subscribers of this task.", + "launch_stage": "GA" + }, + "dashboard_id": { + "description": "The canonical identifier of the SQL dashboard.", + "launch_stage": "GA" + }, + "pause_subscriptions": { + "description": "If true, the dashboard snapshot is not taken, and emails are not sent to subscribers.", + "launch_stage": "GA" + }, + "subscriptions": { + "description": "If specified, dashboard snapshots are sent to subscriptions.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTaskFile": { + "fields": { + "path": { + "description": "Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths.", + "launch_stage": "GA" + }, + "source": { + "description": "Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider.", + "ref": "jobs.Source", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTaskQuery": { + "fields": { + "query_id": { + "description": "The canonical identifier of the SQL query.", + "launch_stage": "GA" + } + } + }, + "jobs.SqlTaskSubscription": { + "fields": { + "destination_id": { + "description": "The canonical identifier of the destination to receive email notification. This parameter is mutually exclusive with user_name. You cannot set both destination_id and user_name for subscription notifications.", + "launch_stage": "GA" + }, + "user_name": { + "description": "The user name to receive the subscription email. This parameter is mutually exclusive with destination_id. You cannot set both destination_id and user_name for subscription notifications.", + "launch_stage": "GA" + } + } + }, + "jobs.StorageMode": { + "enum": [ + "DIRECT_QUERY", + "IMPORT", + "DUAL" + ], + "enum_launch_stages": { + "DIRECT_QUERY": "PUBLIC_PREVIEW", + "DUAL": "PUBLIC_PREVIEW", + "IMPORT": "PUBLIC_PREVIEW" + } + }, + "jobs.SubmitRun": { + "fields": { + "access_control_list": { + "description": "List of permissions to set on the job.", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "The user specified id of the budget policy to use for this one-time run.\nIf not specified, the run will be not be attributed to any budget policy.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "INPUT_ONLY" + ] + }, + "email_notifications": { + "description": "An optional set of email addresses notified when the run begins or completes.", + "ref": "jobs.JobEmailNotifications", + "launch_stage": "GA" + }, + "environments": { + "description": "A list of task execution environment specifications that can be referenced by tasks of this run.", + "launch_stage": "GA" + }, + "git_source": { + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "ref": "jobs.GitSource", + "launch_stage": "GA" + }, + "health": { + "ref": "jobs.JobsHealthRules", + "launch_stage": "GA" + }, + "idempotency_token": { + "description": "An optional token that can be used to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly\none run is launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this run.", + "ref": "jobs.JobNotificationSettings", + "launch_stage": "GA" + }, + "queue": { + "description": "The queue settings of the one-time run.", + "ref": "jobs.QueueSettings", + "launch_stage": "GA" + }, + "run_as": { + "description": "Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who submits the request.", + "ref": "jobs.JobRunAs", + "launch_stage": "GA" + }, + "run_name": { + "description": "An optional name for the run. The default value is `Untitled`.", + "launch_stage": "GA" + }, + "tasks": { + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "The user specified id of the usage policy to use for this one-time run.\nIf not specified, a default usage policy may be applied when creating or modifying the job.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "INPUT_ONLY" + ] + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when the run begins or completes.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.SubmitRunResponse": { + "description": "Run was created and started successfully.", + "fields": { + "run_id": { + "description": "The canonical identifier for the newly submitted run.", + "launch_stage": "GA" + } + } + }, + "jobs.SubmitTask": { + "fields": { + "alert_task": { + "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "ref": "jobs.AlertTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "clean_rooms_notebook_task": { + "description": "The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook\nwhen the `clean_rooms_notebook_task` field is present.", + "ref": "jobs.CleanRoomsNotebookTask", + "launch_stage": "GA" + }, + "compute": { + "description": "Task level compute configuration.", + "ref": "jobs.Compute", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY" + ] + }, + "condition_task": { + "description": "The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications.", + "ref": "jobs.ConditionTask", + "launch_stage": "GA" + }, + "dashboard_task": { + "description": "The task refreshes a dashboard and sends a snapshot to subscribers.", + "ref": "jobs.DashboardTask", + "launch_stage": "GA" + }, + "dbt_cloud_task": { + "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "ref": "jobs.DbtCloudTask", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_platform_task": { + "ref": "jobs.DbtPlatformTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_task": { + "description": "The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.", + "ref": "jobs.DbtTask", + "launch_stage": "GA" + }, + "depends_on": { + "description": "An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete successfully before executing this task.\nThe key is `task_key`, and the value is the name assigned to the dependent task.", + "launch_stage": "GA" + }, + "description": { + "description": "An optional description for this task.", + "launch_stage": "GA" + }, + "disable_auto_optimization": { + "description": "An option to disable auto optimization in serverless", + "launch_stage": "GA" + }, + "disabled": { + "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "email_notifications": { + "description": "An optional set of email addresses notified when the task run begins or completes. The default behavior is to not send any emails.", + "ref": "jobs.JobEmailNotifications", + "launch_stage": "GA" + }, + "environment_key": { + "description": "The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute.", + "launch_stage": "GA" + }, + "existing_cluster_id": { + "description": "If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability", + "launch_stage": "GA" + }, + "for_each_task": { + "description": "The task executes a nested task for every input provided when the `for_each_task` field is present.", + "ref": "jobs.ForEachTask", + "launch_stage": "GA" + }, + "gen_ai_compute_task": { + "ref": "jobs.GenAiComputeTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "health": { + "ref": "jobs.JobsHealthRules", + "launch_stage": "GA" + }, + "libraries": { + "description": "An optional list of libraries to be installed on the cluster.\nThe default value is an empty list.", + "launch_stage": "GA" + }, + "max_retries": { + "description": "An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.", + "launch_stage": "GA" + }, + "min_retry_interval_millis": { + "description": "An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.", + "launch_stage": "GA" + }, + "new_cluster": { + "description": "If new_cluster, a description of a new cluster that is created for each run.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + }, + "notebook_task": { + "description": "The task runs a notebook when the `notebook_task` field is present.", + "ref": "jobs.NotebookTask", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task run.", + "ref": "jobs.TaskNotificationSettings", + "launch_stage": "GA" + }, + "pipeline_task": { + "description": "The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported.", + "ref": "jobs.PipelineTask", + "launch_stage": "GA" + }, + "power_bi_task": { + "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "ref": "jobs.PowerBiTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "python_operator_task": { + "description": "The task runs a Python operator task.", + "ref": "jobs.PythonOperatorTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "python_wheel_task": { + "description": "The task runs a Python wheel when the `python_wheel_task` field is present.", + "ref": "jobs.PythonWheelTask", + "launch_stage": "GA" + }, + "retry_on_timeout": { + "description": "An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout.", + "launch_stage": "GA" + }, + "run_if": { + "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`. See :method:jobs/create for a list of possible values.", + "ref": "jobs.RunIf", + "launch_stage": "GA" + }, + "run_job_task": { + "description": "The task triggers another job when the `run_job_task` field is present.", + "ref": "jobs.RunJobTask", + "launch_stage": "GA" + }, + "spark_jar_task": { + "description": "The task runs a JAR when the `spark_jar_task` field is present.", + "ref": "jobs.SparkJarTask", + "launch_stage": "GA" + }, + "spark_python_task": { + "description": "The task runs a Python file when the `spark_python_task` field is present.", + "ref": "jobs.SparkPythonTask", + "launch_stage": "GA" + }, + "spark_submit_task": { + "description": "(Legacy) The task runs the spark-submit script when the spark_submit_task field is present. Databricks recommends using the spark_jar_task instead; see [Spark Submit task for jobs](/jobs/spark-submit).", + "ref": "jobs.SparkSubmitTask", + "deprecated": true, + "launch_stage": "GA" + }, + "sql_task": { + "description": "The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present.", + "ref": "jobs.SqlTask", + "launch_stage": "GA" + }, + "task_key": { + "description": "A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.", + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job task. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when the run begins or completes. The default behavior is to not send any system notifications. Task webhooks respect the task notification settings.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.Subscription": { + "fields": { + "custom_subject": { + "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", + "launch_stage": "GA" + }, + "paused": { + "description": "When true, the subscription will not send emails.", + "launch_stage": "GA" + }, + "subscribers": { + "description": "The list of subscribers to send the snapshot of the dashboard to.", + "launch_stage": "GA" + } + } + }, + "jobs.SubscriptionSubscriber": { + "fields": { + "destination_id": { + "description": "A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present.", + "launch_stage": "GA" + }, + "user_name": { + "description": "A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present.", + "launch_stage": "GA" + } + } + }, + "jobs.TableState": { + "fields": { + "has_seen_updates": { + "description": "Whether or not the table has seen updates since either\nthe creation of the trigger or the last successful evaluation of the trigger", + "launch_stage": "GA" + }, + "table_name": { + "description": "Full table name of the table to monitor, e.g. `mycatalog.myschema.mytable`", + "launch_stage": "GA" + } + } + }, + "jobs.TableTriggerState": { + "fields": { + "last_seen_table_states": { + "launch_stage": "GA" + }, + "using_scalable_monitoring": { + "description": "Indicates whether the trigger is using scalable monitoring.", + "launch_stage": "GA" + } + } + }, + "jobs.TableUpdateTriggerConfiguration": { + "fields": { + "condition": { + "description": "The table(s) condition based on which to trigger a job run.", + "ref": "jobs.Condition", + "launch_stage": "GA" + }, + "min_time_between_triggers_seconds": { + "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "launch_stage": "GA" + }, + "table_names": { + "description": "A list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`.", + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + }, + "wait_after_last_change_seconds": { + "description": "If set, the trigger starts a run only after no table updates have occurred for the specified time\nand can be used to wait for a series of table updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "launch_stage": "GA" + } + } + }, + "jobs.Task": { + "fields": { + "alert_task": { + "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "ref": "jobs.AlertTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "clean_rooms_notebook_task": { + "description": "The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook\nwhen the `clean_rooms_notebook_task` field is present.", + "ref": "jobs.CleanRoomsNotebookTask", + "launch_stage": "GA" + }, + "compute": { + "description": "Task level compute configuration.", + "ref": "jobs.Compute", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "condition_task": { + "description": "The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications.", + "ref": "jobs.ConditionTask", + "launch_stage": "GA" + }, + "dashboard_task": { + "description": "The task refreshes a dashboard and sends a snapshot to subscribers.", + "ref": "jobs.DashboardTask", + "launch_stage": "GA" + }, + "dbt_cloud_task": { + "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "ref": "jobs.DbtCloudTask", + "deprecated": true, + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_platform_task": { + "ref": "jobs.DbtPlatformTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dbt_task": { + "description": "The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.", + "ref": "jobs.DbtTask", + "launch_stage": "GA" + }, + "depends_on": { + "description": "An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete before executing this task. The task will run only if the `run_if` condition is true.\nThe key is `task_key`, and the value is the name assigned to the dependent task.", + "launch_stage": "GA" + }, + "description": { + "description": "An optional description for this task.", + "launch_stage": "GA" + }, + "disable_auto_optimization": { + "description": "An option to disable auto optimization in serverless", + "launch_stage": "GA" + }, + "disabled": { + "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", + "launch_stage": "GA" + }, + "email_notifications": { + "description": "An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails.", + "ref": "jobs.TaskEmailNotifications", + "launch_stage": "GA" + }, + "environment_key": { + "description": "The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute.", + "launch_stage": "GA" + }, + "existing_cluster_id": { + "description": "If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability", + "launch_stage": "GA" + }, + "for_each_task": { + "description": "The task executes a nested task for every input provided when the `for_each_task` field is present.", + "ref": "jobs.ForEachTask", + "launch_stage": "GA" + }, + "gen_ai_compute_task": { + "ref": "jobs.GenAiComputeTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "health": { + "ref": "jobs.JobsHealthRules", + "launch_stage": "GA" + }, + "job_cluster_key": { + "description": "If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.", + "launch_stage": "GA" + }, + "libraries": { + "description": "An optional list of libraries to be installed on the cluster.\nThe default value is an empty list.", + "launch_stage": "GA" + }, + "max_retries": { + "description": "An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.", + "launch_stage": "GA" + }, + "min_retry_interval_millis": { + "description": "An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.", + "launch_stage": "GA" + }, + "new_cluster": { + "description": "If new_cluster, a description of a new cluster that is created for each run.", + "ref": "compute.ClusterSpec", + "launch_stage": "GA" + }, + "notebook_task": { + "description": "The task runs a notebook when the `notebook_task` field is present.", + "ref": "jobs.NotebookTask", + "launch_stage": "GA" + }, + "notification_settings": { + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task.", + "ref": "jobs.TaskNotificationSettings", + "launch_stage": "GA" + }, + "pipeline_task": { + "description": "The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported.", + "ref": "jobs.PipelineTask", + "launch_stage": "GA" + }, + "power_bi_task": { + "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "ref": "jobs.PowerBiTask", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "python_operator_task": { + "description": "The task runs a Python operator task.", + "ref": "jobs.PythonOperatorTask", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "python_wheel_task": { + "description": "The task runs a Python wheel when the `python_wheel_task` field is present.", + "ref": "jobs.PythonWheelTask", + "launch_stage": "GA" + }, + "retry_on_timeout": { + "description": "An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout.", + "launch_stage": "GA" + }, + "run_if": { + "description": "An optional value specifying the condition determining whether the task is run once its dependencies have been completed.\n\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed", + "ref": "jobs.RunIf", + "launch_stage": "GA" + }, + "run_job_task": { + "description": "The task triggers another job when the `run_job_task` field is present.", + "ref": "jobs.RunJobTask", + "launch_stage": "GA" + }, + "spark_jar_task": { + "description": "The task runs a JAR when the `spark_jar_task` field is present.", + "ref": "jobs.SparkJarTask", + "launch_stage": "GA" + }, + "spark_python_task": { + "description": "The task runs a Python file when the `spark_python_task` field is present.", + "ref": "jobs.SparkPythonTask", + "launch_stage": "GA" + }, + "spark_submit_task": { + "description": "(Legacy) The task runs the spark-submit script when the spark_submit_task field is present. Databricks recommends using the spark_jar_task instead; see [Spark Submit task for jobs](/jobs/spark-submit).", + "ref": "jobs.SparkSubmitTask", + "deprecated": true, + "launch_stage": "GA" + }, + "sql_task": { + "description": "The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present.", + "ref": "jobs.SqlTask", + "launch_stage": "GA" + }, + "task_key": { + "description": "A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.", + "launch_stage": "GA" + }, + "timeout_seconds": { + "description": "An optional timeout applied to each run of this job task. A value of `0` means no timeout.", + "launch_stage": "GA" + }, + "webhook_notifications": { + "description": "A collection of system notification IDs to notify when runs of this task begin or complete. The default behavior is to not send any system notifications.", + "ref": "jobs.WebhookNotifications", + "launch_stage": "GA" + } + } + }, + "jobs.TaskDependency": { + "fields": { + "outcome": { + "description": "Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run.", + "launch_stage": "GA" + }, + "task_key": { + "description": "The name of the task this task depends on.", + "launch_stage": "GA" + } + } + }, + "jobs.TaskEmailNotifications": { + "fields": { + "no_alert_for_skipped_runs": { + "description": "If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "on_duration_warning_threshold_exceeded": { + "description": "A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.", + "launch_stage": "GA" + }, + "on_failure": { + "description": "A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.", + "launch_stage": "GA" + }, + "on_start": { + "description": "A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", + "launch_stage": "GA" + }, + "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.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + } + } + }, + "jobs.TaskNotificationSettings": { + "fields": { + "alert_on_last_attempt": { + "description": "If true, do not send notifications to recipients specified in `on_start` for the retried runs and do not send notifications to recipients specified in `on_failure` until the last retry of the run.", + "launch_stage": "GA" + }, + "no_alert_for_canceled_runs": { + "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.", + "launch_stage": "GA" + }, + "no_alert_for_skipped_runs": { + "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.", + "launch_stage": "GA" + } + } + }, + "jobs.TaskRetryMode": { + "description": "task retry mode of the continuous job\n* NEVER: The failed task will not be retried.\n* ON_FAILURE: Retry a failed task if at least one other task in the job is still running its first attempt.\nWhen this condition is no longer met or the retry limit is reached, the job run is cancelled and a new run is started.", + "enum": [ + "NEVER", + "ON_FAILURE" + ], + "enum_launch_stages": { + "NEVER": "GA", + "ON_FAILURE": "GA" + } + }, + "jobs.TerminationCodeCode": { + "description": "The code indicates why the run was terminated. Additional codes might be introduced in future releases.\n* `SUCCESS`: The run was completed successfully.\n* `SUCCESS_WITH_FAILURES`: The run was completed successfully but some child runs failed.\n* `USER_CANCELED`: The run was successfully canceled during execution by a user.\n* `CANCELED`: The run was canceled during execution by the Databricks platform; for example, if the maximum run duration was exceeded.\n* `SKIPPED`: Run was never executed, for example, if the upstream task run failed, the dependency type condition was not met, or there were no material tasks to execute.\n* `INTERNAL_ERROR`: The run encountered an unexpected error. Refer to the state message for further details.\n* `DRIVER_ERROR`: The run encountered an error while communicating with the Spark Driver.\n* `CLUSTER_ERROR`: The run failed due to a cluster error. Refer to the state message for further details.\n* `REPOSITORY_CHECKOUT_FAILED`: Failed to complete the checkout due to an error when communicating with the third party service.\n* `INVALID_CLUSTER_REQUEST`: The run failed because it issued an invalid request to start the cluster.\n* `WORKSPACE_RUN_LIMIT_EXCEEDED`: The workspace has reached the quota for the maximum number of concurrent active runs. Consider scheduling the runs over a larger time frame.\n* `FEATURE_DISABLED`: The run failed because it tried to access a feature unavailable for the workspace.\n* `CLUSTER_REQUEST_LIMIT_EXCEEDED`: The number of cluster creation, start, and upsize requests have exceeded the allotted rate limit. Consider spreading the run execution over a larger time frame.\n* `STORAGE_ACCESS_ERROR`: The run failed due to an error when accessing the customer blob storage. Refer to the state message for further details.\n* `RUN_EXECUTION_ERROR`: The run was completed with task failures. For more details, refer to the state message or run output.\n* `UNAUTHORIZED_ERROR`: The run failed due to a permission issue while accessing a resource. Refer to the state message for further details.\n* `LIBRARY_INSTALLATION_ERROR`: The run failed while installing the user-requested library. Refer to the state message for further details. The causes might include, but are not limited to: The provided library is invalid, there are insufficient permissions to install the library, and so forth.\n* `MAX_CONCURRENT_RUNS_EXCEEDED`: The scheduled run exceeds the limit of maximum concurrent runs set for the job.\n* `MAX_SPARK_CONTEXTS_EXCEEDED`: The run is scheduled on a cluster that has already reached the maximum number of contexts it is configured to create. See: [Link](https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now).\n* `RESOURCE_NOT_FOUND`: A resource necessary for run execution does not exist. Refer to the state message for further details.\n* `INVALID_RUN_CONFIGURATION`: The run failed due to an invalid configuration. Refer to the state message for further details.\n* `CLOUD_FAILURE`: The run failed due to a cloud provider issue. Refer to the state message for further details.\n* `MAX_JOB_QUEUE_SIZE_EXCEEDED`: The run was skipped due to reaching the job level queue size limit.\n* `DISABLED`: The run was never executed because it was disabled explicitly by the user.\n* `BREAKING_CHANGE`: Run failed because of an intentional breaking change in Spark, but it will be retried with a mitigation config.\n* `CLUSTER_TERMINATED_BY_USER`: The run failed because the externally managed cluster entered an unusable state, likely due to the user terminating or restarting it outside the jobs service.", + "enum": [ + "SUCCESS", + "CANCELED", + "DRIVER_ERROR", + "CLUSTER_ERROR", + "REPOSITORY_CHECKOUT_FAILED", + "INVALID_CLUSTER_REQUEST", + "WORKSPACE_RUN_LIMIT_EXCEEDED", + "FEATURE_DISABLED", + "CLUSTER_REQUEST_LIMIT_EXCEEDED", + "STORAGE_ACCESS_ERROR", + "RUN_EXECUTION_ERROR", + "UNAUTHORIZED_ERROR", + "LIBRARY_INSTALLATION_ERROR", + "MAX_CONCURRENT_RUNS_EXCEEDED", + "MAX_SPARK_CONTEXTS_EXCEEDED", + "RESOURCE_NOT_FOUND", + "INVALID_RUN_CONFIGURATION", + "INTERNAL_ERROR", + "CLOUD_FAILURE", + "MAX_JOB_QUEUE_SIZE_EXCEEDED", + "SKIPPED", + "USER_CANCELED", + "BUDGET_POLICY_LIMIT_EXCEEDED", + "DISABLED", + "SUCCESS_WITH_FAILURES", + "BREAKING_CHANGE" + ], + "enum_launch_stages": { + "BREAKING_CHANGE": "GA", + "BUDGET_POLICY_LIMIT_EXCEEDED": "GA", + "CANCELED": "GA", + "CLOUD_FAILURE": "GA", + "CLUSTER_ERROR": "GA", + "CLUSTER_REQUEST_LIMIT_EXCEEDED": "GA", + "DISABLED": "GA", + "DRIVER_ERROR": "GA", + "FEATURE_DISABLED": "GA", + "INTERNAL_ERROR": "GA", + "INVALID_CLUSTER_REQUEST": "GA", + "INVALID_RUN_CONFIGURATION": "GA", + "LIBRARY_INSTALLATION_ERROR": "GA", + "MAX_CONCURRENT_RUNS_EXCEEDED": "GA", + "MAX_JOB_QUEUE_SIZE_EXCEEDED": "GA", + "MAX_SPARK_CONTEXTS_EXCEEDED": "GA", + "REPOSITORY_CHECKOUT_FAILED": "GA", + "RESOURCE_NOT_FOUND": "GA", + "RUN_EXECUTION_ERROR": "GA", + "SKIPPED": "GA", + "STORAGE_ACCESS_ERROR": "GA", + "SUCCESS": "GA", + "SUCCESS_WITH_FAILURES": "GA", + "UNAUTHORIZED_ERROR": "GA", + "USER_CANCELED": "GA", + "WORKSPACE_RUN_LIMIT_EXCEEDED": "GA" + }, + "enum_descriptions": { + "BREAKING_CHANGE": "Run failed because of an intentional breaking change in Spark, but it will be retried with a mitigation config.", + "CANCELED": "The run was canceled during execution by the \u003cDatabricks\u003e platform; for example, if the maximum run duration was exceeded.", + "CLOUD_FAILURE": "The run failed due to a cloud provider issue. Refer to the state message for further details.", + "CLUSTER_ERROR": "The run failed due to a cluster error. Refer to the state message for further details.", + "CLUSTER_REQUEST_LIMIT_EXCEEDED": "The number of cluster creation, start, and upsize requests have exceeded the allotted rate limit. Consider spreading the run execution over a larger time frame.", + "CLUSTER_TERMINATED_BY_USER": "The run failed because the externally managed cluster entered an unusable state, likely due to the user terminating or restarting it outside the jobs service.", + "DISABLED": "The run was never executed because it was disabled explicitly by the user.", + "DRIVER_ERROR": "The run encountered an error while communicating with the Spark Driver.", + "FEATURE_DISABLED": "The run failed because it tried to access a feature unavailable for the workspace.", + "INTERNAL_ERROR": "The run encountered an unexpected error. Refer to the state message for further details.", + "INVALID_CLUSTER_REQUEST": "The run failed because it issued an invalid request to start the cluster.", + "INVALID_RUN_CONFIGURATION": "The run failed due to an invalid configuration. Refer to the state message for further details.", + "LIBRARY_INSTALLATION_ERROR": "The run failed while installing the user-requested library. Refer to the state message for further details. The causes might include, but are not limited to: The provided library is invalid, there are insufficient permissions to install the library, and so forth.", + "MAX_CONCURRENT_RUNS_EXCEEDED": "The scheduled run exceeds the limit of maximum concurrent runs set for the job.", + "MAX_JOB_QUEUE_SIZE_EXCEEDED": "The run was skipped due to reaching the job level queue size limit.", + "MAX_SPARK_CONTEXTS_EXCEEDED": "The run is scheduled on a cluster that has already reached the maximum number of contexts it is configured to create. See: [Link](https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now).", + "REPOSITORY_CHECKOUT_FAILED": "Failed to complete the checkout due to an error when communicating with the third party service.", + "RESOURCE_NOT_FOUND": "A resource necessary for run execution does not exist. Refer to the state message for further details.", + "RUN_EXECUTION_ERROR": "The run was completed with task failures. For more details, refer to the state message or run output.", + "SKIPPED": "Run was never executed, for example, if the upstream task run failed, the dependency type condition was not met, or there were no material tasks to execute.", + "STORAGE_ACCESS_ERROR": "The run failed due to an error when accessing the customer blob storage. Refer to the state message for further details.", + "SUCCESS": "The run was completed successfully.", + "SUCCESS_WITH_FAILURES": "The run was completed successfully but some child runs failed.", + "UNAUTHORIZED_ERROR": "The run failed due to a permission issue while accessing a resource. Refer to the state message for further details.", + "USER_CANCELED": "The run was successfully canceled during execution by a user.", + "WORKSPACE_RUN_LIMIT_EXCEEDED": "The workspace has reached the quota for the maximum number of concurrent active runs. Consider scheduling the runs over a larger time frame." + } + }, + "jobs.TerminationDetails": { + "fields": { + "code": { + "ref": "jobs.TerminationCodeCode", + "launch_stage": "GA" + }, + "message": { + "description": "A descriptive message with the termination details. This field is unstructured and the format might change.", + "launch_stage": "GA" + }, + "type": { + "ref": "jobs.TerminationTypeType", + "launch_stage": "GA" + } + } + }, + "jobs.TerminationTypeType": { + "description": "* `SUCCESS`: The run terminated without any issues\n* `INTERNAL_ERROR`: An error occurred in the Databricks platform. Please look at the [status page](https://status.databricks.com/) or contact support if the issue persists.\n* `CLIENT_ERROR`: The run was terminated because of an error caused by user input or the job configuration.\n* `CLOUD_FAILURE`: The run was terminated because of an issue with your cloud provider.", + "enum": [ + "SUCCESS", + "INTERNAL_ERROR", + "CLIENT_ERROR", + "CLOUD_FAILURE" + ], + "enum_launch_stages": { + "CLIENT_ERROR": "GA", + "CLOUD_FAILURE": "GA", + "INTERNAL_ERROR": "GA", + "SUCCESS": "GA" + }, + "enum_descriptions": { + "CLIENT_ERROR": "The run was terminated because of an error caused by user input or the job configuration.", + "CLOUD_FAILURE": "The run was terminated because of an issue with your cloud provider.", + "INTERNAL_ERROR": "An error occurred in the \u003cDatabricks\u003e platform. Please look at the [status page](https://status.databricks.com/) or contact support if the issue persists.", + "SUCCESS": "The run terminated without any issues" + } + }, + "jobs.TriggerInfo": { + "description": "Additional details about what triggered the run", + "fields": { + "run_id": { + "description": "The run id of the Run Job task run", + "launch_stage": "GA" + } + } + }, + "jobs.TriggerSettings": { + "fields": { + "file_arrival": { + "description": "File arrival trigger settings.", + "ref": "jobs.FileArrivalTriggerConfiguration", + "launch_stage": "GA" + }, + "model": { + "ref": "jobs.ModelTriggerConfiguration", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "pause_status": { + "description": "Whether this trigger is paused or not.", + "ref": "jobs.PauseStatus", + "launch_stage": "GA" + }, + "periodic": { + "description": "Periodic trigger settings.", + "ref": "jobs.PeriodicTriggerConfiguration", + "launch_stage": "GA" + }, + "table_update": { + "ref": "jobs.TableUpdateTriggerConfiguration", + "launch_stage": "GA" + } + } + }, + "jobs.TriggerStateProto": { + "fields": { + "file_arrival": { + "ref": "jobs.FileArrivalTriggerState", + "launch_stage": "GA" + }, + "table": { + "ref": "jobs.TableTriggerState", + "launch_stage": "GA" + } + } + }, + "jobs.TriggerType": { + "description": "The type of trigger that fired this run.\n\n* `PERIODIC`: Schedules that periodically trigger runs, such as a cron scheduler.\n* `ONE_TIME`: One time triggers that fire a single run. This occurs you triggered a single run on demand through the UI or the API.\n* `RETRY`: Indicates a run that is triggered as a retry of a previously failed run. This occurs when you request to re-run the job in case of failures.\n* `RUN_JOB_TASK`: Indicates a run that is triggered using a Run Job task.\n* `FILE_ARRIVAL`: Indicates a run that is triggered by a file arrival.\n* `CONTINUOUS`: Indicates a run that is triggered by a continuous job.\n* `TABLE`: Indicates a run that is triggered by a table update.\n* `CONTINUOUS_RESTART`: Indicates a run created by user to manually restart a continuous job run.\n* `MODEL`: Indicates a run that is triggered by a model update.", + "enum": [ + "PERIODIC", + "ONE_TIME", + "RETRY", + "RUN_JOB_TASK", + "FILE_ARRIVAL", + "CONTINUOUS", + "TABLE", + "CONTINUOUS_RESTART" + ], + "enum_launch_stages": { + "CONTINUOUS": "GA", + "CONTINUOUS_RESTART": "GA", + "FILE_ARRIVAL": "GA", + "ONE_TIME": "GA", + "PERIODIC": "GA", + "RETRY": "GA", + "RUN_JOB_TASK": "GA", + "TABLE": "GA" + }, + "enum_descriptions": { + "CONTINUOUS": "Indicates a run that is triggered by a continuous job.", + "CONTINUOUS_RESTART": "Indicates a run created by user to manually restart a continuous job run.", + "FILE_ARRIVAL": "Indicates a run that is triggered by a file arrival.", + "ONE_TIME": "One time triggers that fire a single run. This occurs you triggered a single run on demand through the UI or the API.", + "PERIODIC": "Schedules that periodically trigger runs, such as a cron scheduler.", + "RETRY": "Indicates a run that is triggered as a retry of a previously failed run. This occurs when you request to re-run the job in case of failures.", + "RUN_JOB_TASK": "Indicates a run that is triggered using a Run Job task.", + "TABLE": "Indicates a run that is triggered by a table update." + } + }, + "jobs.UpdateJob": { + "fields": { + "fields_to_remove": { + "description": "Remove top-level fields in the job settings. Removing nested fields is not supported, except for tasks and job clusters (`tasks/task_1`). This field is optional.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier of the job to update. This field is required.", + "launch_stage": "GA" + }, + "new_settings": { + "description": "The new settings for the job.\n\nTop-level fields specified in `new_settings` are completely replaced, except for arrays which are merged. That is, new and existing entries are completely replaced based on the respective key fields, i.e. `task_key` or `job_cluster_key`, while previous entries are kept.\n\nPartially updating nested fields is not supported.\n\nChanges to the field `JobSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "ref": "jobs.JobSettings", + "launch_stage": "GA" + } + } + }, + "jobs.ViewItem": { + "fields": { + "content": { + "description": "Content of the view.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the view item. In the case of code view, it would be the notebook’s name. In the case of dashboard view, it would be the dashboard’s name.", + "launch_stage": "GA" + }, + "type": { + "description": "Type of the view item.", + "ref": "jobs.ViewType", + "launch_stage": "GA" + } + } + }, + "jobs.ViewType": { + "description": "* `NOTEBOOK`: Notebook view item.\n* `DASHBOARD`: Dashboard view item.", + "enum": [ + "NOTEBOOK", + "DASHBOARD" + ], + "enum_launch_stages": { + "DASHBOARD": "GA", + "NOTEBOOK": "GA" + }, + "enum_descriptions": { + "DASHBOARD": "Dashboard view item.", + "NOTEBOOK": "Notebook view item." + } + }, + "jobs.ViewsToExport": { + "description": "* `CODE`: Code view of the notebook.\n* `DASHBOARDS`: All dashboard views of the notebook.\n* `ALL`: All views of the notebook.", + "enum": [ + "CODE", + "DASHBOARDS", + "ALL" + ], + "enum_launch_stages": { + "ALL": "GA", + "CODE": "GA", + "DASHBOARDS": "GA" + }, + "enum_descriptions": { + "ALL": "All views of the notebook.", + "CODE": "Code view of the notebook.", + "DASHBOARDS": "All dashboard views of the notebook." + } + }, + "jobs.Webhook": { + "fields": { + "id": { + "launch_stage": "GA" + } + } + }, + "jobs.WebhookNotifications": { + "fields": { + "on_duration_warning_threshold_exceeded": { + "description": "An optional list of system notification IDs to call when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. A maximum of 3 destinations can be specified for the `on_duration_warning_threshold_exceeded` property.", + "launch_stage": "GA" + }, + "on_failure": { + "description": "An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property.", + "launch_stage": "GA" + }, + "on_start": { + "description": "An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property.", + "launch_stage": "GA" + }, + "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.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + } + } + }, + "jobs.WidgetErrorDetail": { + "fields": { + "message": { + "launch_stage": "GA" + } + } + }, + "knowledgeassistants.Example": { + "description": "An example associated with a Knowledge Assistant.\nContains a question and guidelines for how the assistant should respond.", + "fields": { + "create_time": { + "description": "Timestamp when this example was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "example_id": { + "description": "The universally unique identifier (UUID) of the example.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "guidelines": { + "description": "Guidelines for answering the question. Optional — examples may be created\nwith just a question; the front-end form does not require guidelines.", + "launch_stage": "PUBLIC_BETA" + }, + "name": { + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "launch_stage": "PUBLIC_BETA" + }, + "question": { + "description": "The example question.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "update_time": { + "description": "Timestamp when this example was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "knowledgeassistants.FileTableSpec": { + "description": "FileTableSpec specifies a file table source configuration.", + "fields": { + "file_col": { + "description": "The name of the column containing BINARY file content to be indexed.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "table_name": { + "description": "Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "knowledgeassistants.FilesSpec": { + "description": "FilesSpec specifies a files source configuration.", + "fields": { + "path": { + "description": "A UC volume path that includes a list of files.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "knowledgeassistants.GetKnowledgeAssistantPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.IndexSpec": { + "description": "IndexSpec specifies a vector search index source configuration.", + "fields": { + "doc_uri_col": { + "description": "The column that specifies a link or reference to where the information came from.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "index_name": { + "description": "Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "text_col": { + "description": "The column that includes the document text for retrieval.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "knowledgeassistants.KnowledgeAssistant": { + "description": "Entity message that represents a knowledge assistant.\nNote: REQUIRED annotations below represent create-time requirements.\nFor updates, required fields are determined by the update mask.", + "fields": { + "create_time": { + "description": "Creation timestamp.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The creator of the Knowledge Assistant.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "display_name": { + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "endpoint_name": { + "description": "The name of the knowledge assistant agent endpoint.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "error_info": { + "description": "Error details when the Knowledge Assistant is in FAILED state.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "experiment_id": { + "description": "The MLflow experiment ID.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "Deprecated: use knowledge_assistant_id instead.", + "deprecated": true, + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "instructions": { + "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in update_mask to\nmodify it.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "launch_stage": "PUBLIC_BETA" + }, + "state": { + "description": "State of the Knowledge Assistant. Not returned in List responses.", + "ref": "knowledgeassistants.KnowledgeAssistantState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "knowledgeassistants.KnowledgeAssistantAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "knowledgeassistants.KnowledgeAssistantPermissionLevel", + "launch_stage": "PUBLIC_BETA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "PUBLIC_BETA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "PUBLIC_BETA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "PUBLIC_BETA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_BETA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "PUBLIC_BETA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantPermission": { + "fields": { + "inherited": { + "launch_stage": "PUBLIC_BETA" + }, + "inherited_from_object": { + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "knowledgeassistants.KnowledgeAssistantPermissionLevel", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_QUERY" + ] + }, + "knowledgeassistants.KnowledgeAssistantPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_BETA" + }, + "object_id": { + "launch_stage": "PUBLIC_BETA" + }, + "object_type": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "knowledgeassistants.KnowledgeAssistantPermissionLevel", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.KnowledgeAssistantState": { + "enum": [ + "CREATING", + "ACTIVE", + "FAILED" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_BETA", + "CREATING": "PUBLIC_BETA", + "FAILED": "PUBLIC_BETA" + } + }, + "knowledgeassistants.KnowledgeSource": { + "description": "KnowledgeSource represents a source of knowledge for the KnowledgeAssistant.\nUsed in create/update requests and returned in Get/List responses.\nNote: REQUIRED annotations below represent create-time requirements.\nFor updates, required fields are determined by the update mask.", + "fields": { + "create_time": { + "description": "Timestamp when this knowledge source was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "display_name": { + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "file_table": { + "ref": "knowledgeassistants.FileTableSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "files": { + "ref": "knowledgeassistants.FilesSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "index": { + "ref": "knowledgeassistants.IndexSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "knowledge_cutoff_time": { + "description": "Timestamp representing the cutoff before which content in this knowledge source is being ingested.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "launch_stage": "PUBLIC_BETA" + }, + "source_type": { + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "state": { + "ref": "knowledgeassistants.KnowledgeSourceState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "knowledgeassistants.KnowledgeSourceState": { + "enum": [ + "UPDATING", + "UPDATED", + "FAILED_UPDATE" + ], + "enum_launch_stages": { + "FAILED_UPDATE": "PUBLIC_BETA", + "UPDATED": "PUBLIC_BETA", + "UPDATING": "PUBLIC_BETA" + } + }, + "knowledgeassistants.ListExamplesResponse": { + "description": "A list of Knowledge Assistant examples.", + "fields": { + "examples": { + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.ListKnowledgeAssistantsResponse": { + "description": "A list of Knowledge Assistants.", + "fields": { + "knowledge_assistants": { + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.ListKnowledgeSourcesResponse": { + "fields": { + "knowledge_sources": { + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.SyncKnowledgeSourcesRequest": {}, + "marketplace.AddExchangeForListingRequest": { + "fields": { + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.AddExchangeForListingResponse": { + "fields": { + "exchange_for_listing": { + "ref": "marketplace.ExchangeListing", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.AssetType": { + "enum": [ + "ASSET_TYPE_GIT_REPO", + "ASSET_TYPE_DATA_TABLE", + "ASSET_TYPE_MODEL", + "ASSET_TYPE_NOTEBOOK", + "ASSET_TYPE_MEDIA", + "ASSET_TYPE_PARTNER_INTEGRATION", + "ASSET_TYPE_APP", + "ASSET_TYPE_MCP" + ], + "enum_launch_stages": { + "ASSET_TYPE_APP": "PUBLIC_PREVIEW", + "ASSET_TYPE_DATA_TABLE": "PUBLIC_PREVIEW", + "ASSET_TYPE_GIT_REPO": "PUBLIC_PREVIEW", + "ASSET_TYPE_MCP": "PUBLIC_PREVIEW", + "ASSET_TYPE_MEDIA": "PUBLIC_PREVIEW", + "ASSET_TYPE_MODEL": "PUBLIC_PREVIEW", + "ASSET_TYPE_NOTEBOOK": "PUBLIC_PREVIEW", + "ASSET_TYPE_PARTNER_INTEGRATION": "PUBLIC_PREVIEW" + } + }, + "marketplace.BatchGetListingsResponse": { + "fields": { + "listings": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.BatchGetProvidersResponse": { + "fields": { + "providers": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.Category": { + "enum": [ + "ADVERTISING_AND_MARKETING", + "CLIMATE_AND_ENVIRONMENT", + "COMMERCE", + "DEMOGRAPHICS", + "ECONOMICS", + "EDUCATION", + "ENERGY", + "FINANCIAL", + "GAMING", + "GEOSPATIAL", + "HEALTH", + "LOOKUP_TABLES", + "MANUFACTURING", + "MEDIA", + "OTHER", + "PUBLIC_SECTOR", + "RETAIL", + "SECURITY", + "SCIENCE_AND_RESEARCH", + "SPORTS", + "TRANSPORTATION_AND_LOGISTICS", + "TRAVEL_AND_TOURISM" + ], + "enum_launch_stages": { + "ADVERTISING_AND_MARKETING": "PUBLIC_PREVIEW", + "CLIMATE_AND_ENVIRONMENT": "PUBLIC_PREVIEW", + "COMMERCE": "PUBLIC_PREVIEW", + "DEMOGRAPHICS": "PUBLIC_PREVIEW", + "ECONOMICS": "PUBLIC_PREVIEW", + "EDUCATION": "PUBLIC_PREVIEW", + "ENERGY": "PUBLIC_PREVIEW", + "FINANCIAL": "PUBLIC_PREVIEW", + "GAMING": "PUBLIC_PREVIEW", + "GEOSPATIAL": "PUBLIC_PREVIEW", + "HEALTH": "PUBLIC_PREVIEW", + "LOOKUP_TABLES": "PUBLIC_PREVIEW", + "MANUFACTURING": "PUBLIC_PREVIEW", + "MEDIA": "PUBLIC_PREVIEW", + "OTHER": "PUBLIC_PREVIEW", + "PUBLIC_SECTOR": "PUBLIC_PREVIEW", + "RETAIL": "PUBLIC_PREVIEW", + "SCIENCE_AND_RESEARCH": "PUBLIC_PREVIEW", + "SECURITY": "PUBLIC_PREVIEW", + "SPORTS": "PUBLIC_PREVIEW", + "TRANSPORTATION_AND_LOGISTICS": "PUBLIC_PREVIEW", + "TRAVEL_AND_TOURISM": "PUBLIC_PREVIEW" + } + }, + "marketplace.ConsumerTerms": { + "fields": { + "version": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ContactInfo": { + "description": "contact info for the consumer requesting data or performing a listing installation", + "fields": { + "company": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "email": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "first_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "last_name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.Cost": { + "enum": [ + "FREE", + "PAID" + ], + "enum_launch_stages": { + "FREE": "PUBLIC_PREVIEW", + "PAID": "PUBLIC_PREVIEW" + } + }, + "marketplace.CreateExchangeFilterRequest": { + "fields": { + "filter": { + "ref": "marketplace.ExchangeFilter", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateExchangeFilterResponse": { + "fields": { + "filter_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateExchangeRequest": { + "fields": { + "exchange": { + "ref": "marketplace.Exchange", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateExchangeResponse": { + "fields": { + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateFileRequest": { + "fields": { + "display_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "file_parent": { + "ref": "marketplace.FileParent", + "launch_stage": "PUBLIC_PREVIEW" + }, + "marketplace_file_type": { + "ref": "marketplace.MarketplaceFileType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "mime_type": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateFileResponse": { + "fields": { + "file_info": { + "ref": "marketplace.FileInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "upload_url": { + "description": "Pre-signed POST URL to blob storage", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateInstallationRequest": { + "fields": { + "accepted_consumer_terms": { + "ref": "marketplace.ConsumerTerms", + "launch_stage": "PUBLIC_PREVIEW" + }, + "catalog_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "recipient_type": { + "ref": "marketplace.DeltaSharingRecipientType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "repo_detail": { + "description": "for git repo installations", + "ref": "marketplace.RepoInstallation", + "launch_stage": "PUBLIC_PREVIEW" + }, + "share_name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateListingRequest": { + "fields": { + "listing": { + "ref": "marketplace.Listing", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateListingResponse": { + "fields": { + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreatePersonalizationRequest": { + "description": "Data request messages\nalso creates a lead (maybe)", + "fields": { + "accepted_consumer_terms": { + "ref": "marketplace.ConsumerTerms", + "launch_stage": "PUBLIC_PREVIEW" + }, + "comment": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "company": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "first_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "intended_use": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_from_lighthouse": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "last_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "recipient_type": { + "ref": "marketplace.DeltaSharingRecipientType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreatePersonalizationRequestResponse": { + "fields": { + "id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateProviderAnalyticsDashboardRequest": {}, + "marketplace.CreateProviderRequest": { + "fields": { + "provider": { + "ref": "marketplace.ProviderInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.CreateProviderResponse": { + "fields": { + "id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.DataRefresh": { + "enum": [ + "NONE", + "SECOND", + "MINUTE", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "QUARTERLY", + "YEARLY" + ], + "enum_launch_stages": { + "DAILY": "PUBLIC_PREVIEW", + "HOURLY": "PUBLIC_PREVIEW", + "MINUTE": "PUBLIC_PREVIEW", + "MONTHLY": "PUBLIC_PREVIEW", + "NONE": "PUBLIC_PREVIEW", + "QUARTERLY": "PUBLIC_PREVIEW", + "SECOND": "PUBLIC_PREVIEW", + "WEEKLY": "PUBLIC_PREVIEW", + "YEARLY": "PUBLIC_PREVIEW" + } + }, + "marketplace.DataRefreshInfo": { + "fields": { + "interval": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "unit": { + "ref": "marketplace.DataRefresh", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.DeleteExchangeFilterResponse": {}, + "marketplace.DeleteExchangeResponse": {}, + "marketplace.DeleteFileResponse": {}, + "marketplace.DeleteInstallationResponse": {}, + "marketplace.DeleteListingResponse": {}, + "marketplace.DeleteProviderResponse": {}, + "marketplace.DeltaSharingRecipientType": { + "enum": [ + "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS", + "DELTA_SHARING_RECIPIENT_TYPE_OPEN" + ], + "enum_launch_stages": { + "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS": "PUBLIC_PREVIEW", + "DELTA_SHARING_RECIPIENT_TYPE_OPEN": "PUBLIC_PREVIEW" + } + }, + "marketplace.Exchange": { + "fields": { + "comment": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "filters": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "linked_listings": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_by": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ExchangeFilter": { + "fields": { + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter_type": { + "ref": "marketplace.ExchangeFilterType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter_value": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_by": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ExchangeFilterType": { + "enum": [ + "GLOBAL_METASTORE_ID" + ], + "enum_launch_stages": { + "GLOBAL_METASTORE_ID": "PUBLIC_PREVIEW" + } + }, + "marketplace.ExchangeListing": { + "fields": { + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "exchange_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.FileInfo": { + "fields": { + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Name displayed to users for applicable files, e.g. embedded notebooks", + "launch_stage": "PUBLIC_PREVIEW" + }, + "download_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "file_parent": { + "ref": "marketplace.FileParent", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "marketplace_file_type": { + "ref": "marketplace.MarketplaceFileType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "mime_type": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "ref": "marketplace.FileStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status_message": { + "description": "Populated if status is in a failed state with more information on reason for the failure.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.FileParent": { + "fields": { + "file_parent_type": { + "ref": "marketplace.FileParentType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "parent_id": { + "description": "TODO make the following fields required", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.FileParentType": { + "enum": [ + "PROVIDER", + "LISTING", + "LISTING_RESOURCE" + ], + "enum_launch_stages": { + "LISTING": "PUBLIC_PREVIEW", + "LISTING_RESOURCE": "PUBLIC_PREVIEW", + "PROVIDER": "PUBLIC_PREVIEW" + } + }, + "marketplace.FileStatus": { + "enum": [ + "FILE_STATUS_PUBLISHED", + "FILE_STATUS_STAGING", + "FILE_STATUS_SANITIZING", + "FILE_STATUS_SANITIZATION_FAILED" + ], + "enum_launch_stages": { + "FILE_STATUS_PUBLISHED": "PUBLIC_PREVIEW", + "FILE_STATUS_SANITIZATION_FAILED": "PUBLIC_PREVIEW", + "FILE_STATUS_SANITIZING": "PUBLIC_PREVIEW", + "FILE_STATUS_STAGING": "PUBLIC_PREVIEW" + } + }, + "marketplace.FulfillmentType": { + "enum": [ + "REQUEST_ACCESS", + "INSTALL" + ], + "enum_launch_stages": { + "INSTALL": "PUBLIC_PREVIEW", + "REQUEST_ACCESS": "PUBLIC_PREVIEW" + } + }, + "marketplace.GetExchangeResponse": { + "fields": { + "exchange": { + "ref": "marketplace.Exchange", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetFileResponse": { + "fields": { + "file_info": { + "ref": "marketplace.FileInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetLatestVersionProviderAnalyticsDashboardResponse": { + "fields": { + "version": { + "description": "version here is latest logical version of the dashboard template", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetListingContentMetadataResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "shared_data_objects": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetListingResponse": { + "fields": { + "listing": { + "ref": "marketplace.Listing", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetListingsResponse": { + "fields": { + "listings": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetPersonalizationRequestResponse": { + "fields": { + "personalization_requests": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.GetProviderResponse": { + "fields": { + "provider": { + "ref": "marketplace.ProviderInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.Installation": { + "fields": { + "installation": { + "ref": "marketplace.InstallationDetail", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.InstallationDetail": { + "fields": { + "catalog_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "error_message": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "installed_on": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "recipient_type": { + "ref": "marketplace.DeltaSharingRecipientType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "repo_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "repo_path": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "share_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "ref": "marketplace.InstallationStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "token_detail": { + "ref": "marketplace.TokenDetail", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tokens": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.InstallationStatus": { + "enum": [ + "INSTALLED", + "FAILED" + ], + "enum_launch_stages": { + "FAILED": "PUBLIC_PREVIEW", + "INSTALLED": "PUBLIC_PREVIEW" + } + }, + "marketplace.ListAllInstallationsResponse": { + "fields": { + "installations": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListAllPersonalizationRequestsResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "personalization_requests": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListExchangeFiltersResponse": { + "fields": { + "filters": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListExchangesForListingResponse": { + "fields": { + "exchange_listing": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListExchangesResponse": { + "fields": { + "exchanges": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListFilesResponse": { + "fields": { + "file_infos": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListFulfillmentsResponse": { + "fields": { + "fulfillments": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListInstallationsResponse": { + "fields": { + "installations": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListListingsForExchangeResponse": { + "fields": { + "exchange_listings": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListListingsResponse": { + "fields": { + "listings": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListProviderAnalyticsDashboardResponse": { + "fields": { + "dashboard_id": { + "description": "dashboard_id will be used to open Lakeview dashboard.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "version": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListProvidersResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "providers": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.Listing": { + "fields": { + "detail": { + "ref": "marketplace.ListingDetail", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "summary": { + "ref": "marketplace.ListingSummary", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingDetail": { + "fields": { + "assets": { + "description": "Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK", + "launch_stage": "PUBLIC_PREVIEW" + }, + "collection_date_end": { + "description": "The ending date timestamp for when the data spans", + "launch_stage": "PUBLIC_PREVIEW" + }, + "collection_date_start": { + "description": "The starting date timestamp for when the data spans", + "launch_stage": "PUBLIC_PREVIEW" + }, + "collection_granularity": { + "description": "Smallest unit of time in the dataset", + "ref": "marketplace.DataRefreshInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "cost": { + "description": "Whether the dataset is free or paid", + "ref": "marketplace.Cost", + "launch_stage": "PUBLIC_PREVIEW" + }, + "data_source": { + "description": "Where/how the data is sourced", + "launch_stage": "PUBLIC_PREVIEW" + }, + "description": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "documentation_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "embedded_notebook_file_infos": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "file_ids": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "geographical_coverage": { + "description": "Which geo region the listing data is collected from", + "launch_stage": "PUBLIC_PREVIEW" + }, + "license": { + "description": "ID 20, 21 removed don't use\nLicense of the data asset - Required for listings with model based assets", + "launch_stage": "PUBLIC_PREVIEW" + }, + "pricing_model": { + "description": "What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid\nTODO: Not used yet, should deprecate if we will never use it", + "launch_stage": "PUBLIC_PREVIEW" + }, + "privacy_policy_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "size": { + "description": "size of the dataset in GB", + "launch_stage": "PUBLIC_PREVIEW" + }, + "support_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "tags": { + "description": "Listing tags - Simple key value pair to annotate listings.\nWhen should I use tags vs dedicated fields?\nUsing tags avoids the need to add new columns in the database for new annotations.\nHowever, this should be used sparingly since tags are stored as key value pair.\nUse tags only:\n1. If the field is optional and won't need to have NOT NULL integrity check\n2. The value is fairly fixed, static and low cardinality (eg. enums).\n3. The value won't be used in filters or joins with other tables.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "terms_of_service": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_frequency": { + "description": "How often data is updated", + "ref": "marketplace.DataRefreshInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingFulfillment": { + "fields": { + "fulfillment_type": { + "ref": "marketplace.FulfillmentType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "recipient_type": { + "ref": "marketplace.DeltaSharingRecipientType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "repo_info": { + "ref": "marketplace.RepoInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "share_info": { + "ref": "marketplace.ShareInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingSetting": { + "fields": { + "visibility": { + "ref": "marketplace.Visibility", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingShareType": { + "enum": [ + "SAMPLE", + "FULL" + ], + "enum_launch_stages": { + "FULL": "PUBLIC_PREVIEW", + "SAMPLE": "PUBLIC_PREVIEW" + } + }, + "marketplace.ListingStatus": { + "description": "Enums", + "enum": [ + "DRAFT", + "PENDING", + "PUBLISHED", + "SUSPENDED" + ], + "enum_launch_stages": { + "DRAFT": "PUBLIC_PREVIEW", + "PENDING": "PUBLIC_PREVIEW", + "PUBLISHED": "PUBLIC_PREVIEW", + "SUSPENDED": "PUBLIC_PREVIEW" + } + }, + "marketplace.ListingSummary": { + "fields": { + "categories": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "exchange_ids": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "git_repo": { + "description": "if a git repo is being created, a listing will be initialized with this field as opposed to a share", + "ref": "marketplace.RepoInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "listingType": { + "ref": "marketplace.ListingType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "provider_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "provider_region": { + "ref": "marketplace.RegionInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "published_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "published_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "marketplace.ListingSetting", + "launch_stage": "PUBLIC_PREVIEW" + }, + "share": { + "ref": "marketplace.ShareInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "ref": "marketplace.ListingStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "subtitle": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_by": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_by_id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingTag": { + "fields": { + "tag_name": { + "description": "Tag name (enum)", + "ref": "marketplace.ListingTagType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tag_values": { + "description": "String representation of the tag value. Values should be string literals (no complex types)", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListingTagType": { + "enum": [ + "LISTING_TAG_TYPE_LANGUAGE", + "LISTING_TAG_TYPE_TASK" + ], + "enum_launch_stages": { + "LISTING_TAG_TYPE_LANGUAGE": "PUBLIC_PREVIEW", + "LISTING_TAG_TYPE_TASK": "PUBLIC_PREVIEW" + } + }, + "marketplace.ListingType": { + "enum": [ + "STANDARD", + "PERSONALIZED" + ], + "enum_launch_stages": { + "PERSONALIZED": "PUBLIC_PREVIEW", + "STANDARD": "PUBLIC_PREVIEW" + } + }, + "marketplace.MarketplaceFileType": { + "enum": [ + "PROVIDER_ICON", + "EMBEDDED_NOTEBOOK", + "APP" + ], + "enum_launch_stages": { + "APP": "PUBLIC_PREVIEW", + "EMBEDDED_NOTEBOOK": "PUBLIC_PREVIEW", + "PROVIDER_ICON": "PUBLIC_PREVIEW" + } + }, + "marketplace.PersonalizationRequest": { + "fields": { + "comment": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "consumer_region": { + "ref": "marketplace.RegionInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "contact_info": { + "ref": "marketplace.ContactInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_at": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "intended_use": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_from_lighthouse": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "listing_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "metastore_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "provider_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "recipient_type": { + "ref": "marketplace.DeltaSharingRecipientType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "share": { + "description": "Share information is required for data listings\nbut should be empty/ignored for non-data listings (MCP and App).", + "ref": "marketplace.ShareInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "ref": "marketplace.PersonalizationRequestStatus", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status_message": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.PersonalizationRequestStatus": { + "enum": [ + "NEW", + "REQUEST_PENDING", + "FULFILLED", + "DENIED" + ], + "enum_launch_stages": { + "DENIED": "PUBLIC_PREVIEW", + "FULFILLED": "PUBLIC_PREVIEW", + "NEW": "PUBLIC_PREVIEW", + "REQUEST_PENDING": "PUBLIC_PREVIEW" + } + }, + "marketplace.ProviderAnalyticsDashboard": { + "fields": { + "id": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ProviderInfo": { + "fields": { + "business_contact_email": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "company_website_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "dark_mode_icon_file_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "dark_mode_icon_file_path": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "description": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "icon_file_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "icon_file_path": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_featured": { + "description": "is_featured is accessible by consumers only", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "privacy_policy_link": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "published_by": { + "description": "published_by is only applicable to data aggregators (e.g. Crux)", + "launch_stage": "PUBLIC_PREVIEW" + }, + "support_contact_email": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "term_of_service_link": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.RegionInfo": { + "fields": { + "cloud": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "region": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.RemoveExchangeForListingResponse": {}, + "marketplace.RepoInfo": { + "fields": { + "git_repo_url": { + "description": "the git repo url e.g. https://github.com/databrickslabs/dolly.git", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.RepoInstallation": { + "fields": { + "repo_name": { + "description": "the user-specified repo name for their installed git repo listing", + "launch_stage": "PUBLIC_PREVIEW" + }, + "repo_path": { + "description": "refers to the full url file path that navigates the user to the repo's entrypoint (e.g. a README.md file, or the repo file view in the unified UI)\nshould just be a relative path", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.SearchListingsResponse": { + "fields": { + "listings": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ShareInfo": { + "fields": { + "name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "type": { + "ref": "marketplace.ListingShareType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.SharedDataObject": { + "fields": { + "data_object_type": { + "description": "The type of the data object. Could be one of: TABLE, SCHEMA, NOTEBOOK_FILE, MODEL, VOLUME", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the shared object", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.TokenDetail": { + "fields": { + "bearerToken": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "endpoint": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "expirationTime": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "shareCredentialsVersion": { + "description": "These field names must follow the delta sharing protocol.\nOriginal message: RetrieveToken.Response in managed-catalog/api/messages/recipient.proto", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.TokenInfo": { + "fields": { + "activation_url": { + "description": "Full activation url to retrieve the access token.\nIt will be empty if the token is already retrieved.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_at": { + "description": "Time at which this Recipient Token was created, in epoch milliseconds.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "created_by": { + "description": "Username of Recipient Token creator.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "expiration_time": { + "description": "Expiration timestamp of the token in epoch milliseconds.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Unique id of the Recipient Token.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "description": "Time at which this Recipient Token was updated, in epoch milliseconds.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_by": { + "description": "Username of Recipient Token updater.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateExchangeFilterRequest": { + "fields": { + "filter": { + "ref": "marketplace.ExchangeFilter", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateExchangeFilterResponse": { + "fields": { + "filter": { + "ref": "marketplace.ExchangeFilter", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateExchangeRequest": { + "fields": { + "exchange": { + "ref": "marketplace.Exchange", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateExchangeResponse": { + "fields": { + "exchange": { + "ref": "marketplace.Exchange", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateInstallationRequest": { + "fields": { + "installation": { + "ref": "marketplace.InstallationDetail", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rotate_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateInstallationResponse": { + "fields": { + "installation": { + "ref": "marketplace.InstallationDetail", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateListingRequest": { + "fields": { + "listing": { + "ref": "marketplace.Listing", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateListingResponse": { + "fields": { + "listing": { + "ref": "marketplace.Listing", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdatePersonalizationRequestRequest": { + "fields": { + "reason": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "share": { + "ref": "marketplace.ShareInfo", + "launch_stage": "PUBLIC_PREVIEW" + }, + "status": { + "ref": "marketplace.PersonalizationRequestStatus", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdatePersonalizationRequestResponse": { + "fields": { + "request": { + "ref": "marketplace.PersonalizationRequest", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateProviderAnalyticsDashboardRequest": { + "fields": { + "version": { + "description": "this is the version of the dashboard template we want to update our user to\ncurrent expectation is that it should be equal to latest version of the dashboard template", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateProviderAnalyticsDashboardResponse": { + "fields": { + "dashboard_id": { + "description": "this is newly created Lakeview dashboard for the user", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "id \u0026 version should be the same as the request", + "launch_stage": "PUBLIC_PREVIEW" + }, + "version": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateProviderRequest": { + "fields": { + "provider": { + "ref": "marketplace.ProviderInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.UpdateProviderResponse": { + "fields": { + "provider": { + "ref": "marketplace.ProviderInfo", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.Visibility": { + "enum": [ + "PUBLIC", + "PRIVATE" + ], + "enum_launch_stages": { + "PRIVATE": "PUBLIC_PREVIEW", + "PUBLIC": "PUBLIC_PREVIEW" + } + }, + "ml.Activity": { + "description": "For activities, this contains the activity recorded for the action.\nFor comments, this contains the comment details.\nFor transition requests, this contains the transition request details.", + "fields": { + "activity_type": { + "ref": "ml.ActivityType", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided comment associated with the activity, comment, or transition request.", + "launch_stage": "GA" + }, + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "from_stage": { + "description": "Source stage of the transition (if the activity is stage transition related). Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "id": { + "description": "Unique identifier for the object.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Time of the object at last update, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "system_comment": { + "description": "Comment made by system, for example explaining an activity of type `SYSTEM_TRANSITION`. It usually describes a side effect, such as a version being archived as part of another version's stage transition, and may not be returned for some activity types.", + "launch_stage": "GA" + }, + "to_stage": { + "description": "Target stage of the transition (if the activity is stage transition related). Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "user_id": { + "description": "The username of the user that created the object.", + "launch_stage": "GA" + } + } + }, + "ml.ActivityAction": { + "description": "An action that a user (with sufficient permissions) could take on an activity or comment.\n\nFor activities, valid values are:\n* `APPROVE_TRANSITION_REQUEST`: Approve a transition request\n\n* `REJECT_TRANSITION_REQUEST`: Reject a transition request\n\n* `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request\n\nFor comments, valid values are:\n* `EDIT_COMMENT`: Edit the comment\n\n* `DELETE_COMMENT`: Delete the comment", + "enum": [ + "APPROVE_TRANSITION_REQUEST", + "REJECT_TRANSITION_REQUEST", + "CANCEL_TRANSITION_REQUEST", + "EDIT_COMMENT", + "DELETE_COMMENT" + ], + "enum_launch_stages": { + "APPROVE_TRANSITION_REQUEST": "GA", + "CANCEL_TRANSITION_REQUEST": "GA", + "DELETE_COMMENT": "GA", + "EDIT_COMMENT": "GA", + "REJECT_TRANSITION_REQUEST": "GA" + }, + "enum_descriptions": { + "APPROVE_TRANSITION_REQUEST": "Approve a transition request", + "CANCEL_TRANSITION_REQUEST": "Cancel (delete) a transition request", + "DELETE_COMMENT": "Delete the comment", + "EDIT_COMMENT": "Edit the comment", + "REJECT_TRANSITION_REQUEST": "Reject a transition request" + } + }, + "ml.ActivityType": { + "description": "Type of activity. Valid values are:\n* `APPLIED_TRANSITION`: User applied the corresponding stage transition.\n\n* `REQUESTED_TRANSITION`: User requested the corresponding stage transition.\n\n* `CANCELLED_REQUEST`: User cancelled an existing transition request.\n\n* `APPROVED_REQUEST`: User approved the corresponding stage transition.\n\n* `REJECTED_REQUEST`: User rejected the coressponding stage transition.\n\n* `SYSTEM_TRANSITION`: For events performed as a side effect, such as archiving existing model versions in a stage.", + "enum": [ + "APPLIED_TRANSITION", + "REQUESTED_TRANSITION", + "CANCELLED_REQUEST", + "APPROVED_REQUEST", + "REJECTED_REQUEST", + "NEW_COMMENT", + "SYSTEM_TRANSITION" + ], + "enum_launch_stages": { + "APPLIED_TRANSITION": "GA", + "APPROVED_REQUEST": "GA", + "CANCELLED_REQUEST": "GA", + "NEW_COMMENT": "GA", + "REJECTED_REQUEST": "GA", + "REQUESTED_TRANSITION": "GA", + "SYSTEM_TRANSITION": "GA" + }, + "enum_descriptions": { + "APPLIED_TRANSITION": "User applied the corresponding stage transition.", + "APPROVED_REQUEST": "User approved the corresponding stage transition.", + "CANCELLED_REQUEST": "User cancelled an existing transition request.", + "REJECTED_REQUEST": "User rejected the coressponding stage transition.", + "REQUESTED_TRANSITION": "User requested the corresponding stage transition.", + "SYSTEM_TRANSITION": "For events performed as a side effect, such as archiving existing model versions in a stage." + } + }, + "ml.AggregationFunction": { + "description": "An aggregation function applied over a time window.", + "fields": { + "approx_count_distinct": { + "ref": "ml.ApproxCountDistinctFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "approx_percentile": { + "ref": "ml.ApproxPercentileFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "avg": { + "ref": "ml.AvgFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "count_function": { + "ref": "ml.CountFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "first": { + "ref": "ml.FirstFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "last": { + "ref": "ml.LastFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "max": { + "ref": "ml.MaxFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "min": { + "ref": "ml.MinFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "stddev_pop": { + "ref": "ml.StddevPopFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "stddev_samp": { + "ref": "ml.StddevSampFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "sum": { + "ref": "ml.SumFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "time_window": { + "description": "The time window over which the aggregation is computed.", + "ref": "ml.TimeWindow", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "var_pop": { + "ref": "ml.VarPopFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "var_samp": { + "ref": "ml.VarSampFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.ApproveTransitionRequest": { + "description": "Details required to identify and approve a model version stage transition request.", + "fields": { + "archive_existing_versions": { + "description": "Specifies whether to archive all current model versions in the target stage.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "stage": { + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.ApproveTransitionRequestResponse": { + "fields": { + "activity": { + "description": "New activity generated as a result of this operation.", + "ref": "ml.Activity", + "launch_stage": "GA" + } + } + }, + "ml.ApproxCountDistinctFunction": { + "description": "Computes the approximate count of distinct values.", + "fields": { + "input": { + "description": "The input column from which the approximate count of distinct values is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "relative_sd": { + "description": "The maximum relative standard deviation allowed (default defined by Spark).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.ApproxPercentileFunction": { + "description": "Computes the approximate percentile of values.", + "fields": { + "accuracy": { + "description": "The accuracy parameter (higher is more accurate but slower).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "input": { + "description": "The input column from which the approximate percentile is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "percentile": { + "description": "The percentile value to compute (between 0 and 1).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.AuthConfig": { + "fields": { + "mtls_config": { + "description": "Mutual-TLS authentication. See MtlsConfig.", + "ref": "ml.MtlsConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "uc_service_credential_name": { + "description": "Name of the Unity Catalog service credential. This value will be set under the option databricks.serviceCredential", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.AvgFunction": { + "description": "Computes the average of values.", + "fields": { + "input": { + "description": "The input column from which the average is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.BackfillSource": { + "fields": { + "delta_table_name": { + "description": "The full three-part name (catalog, schema, name) of the Delta table containing the historical data to backfill.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "delta_table_source": { + "description": "Deprecated: Use delta_table_name instead. Kept for backwards compatibility.\nThe Delta table source containing the historical data to backfill.\nOnly the delta table name is used for backfill, other fields are ignored.", + "ref": "ml.DeltaTableSource", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.BatchCreateMaterializedFeaturesRequest": { + "fields": { + "requests": { + "description": "The requests to create materialized features.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.BatchCreateMaterializedFeaturesResponse": { + "fields": { + "materialized_features": { + "description": "The created materialized features with assigned IDs.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ColumnIdentifier": { + "fields": { + "variant_expr_path": { + "description": "String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.ColumnSelection": { + "description": "A ColumnSelection function, equivalent to the LAST() record of an entity over a lifetime ContinuousWindow", + "fields": { + "column": { + "description": "Column name from source to select as the feature value.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.CommentActivityAction": { + "description": "An action that a user (with sufficient permissions) could take on an activity or comment.\n\nFor activities, valid values are:\n* `APPROVE_TRANSITION_REQUEST`: Approve a transition request\n\n* `REJECT_TRANSITION_REQUEST`: Reject a transition request\n\n* `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request\n\nFor comments, valid values are:\n* `EDIT_COMMENT`: Edit the comment\n\n* `DELETE_COMMENT`: Delete the comment", + "enum": [ + "APPROVE_TRANSITION_REQUEST", + "REJECT_TRANSITION_REQUEST", + "CANCEL_TRANSITION_REQUEST", + "EDIT_COMMENT", + "DELETE_COMMENT" + ], + "enum_launch_stages": { + "APPROVE_TRANSITION_REQUEST": "GA", + "CANCEL_TRANSITION_REQUEST": "GA", + "DELETE_COMMENT": "GA", + "EDIT_COMMENT": "GA", + "REJECT_TRANSITION_REQUEST": "GA" + }, + "enum_descriptions": { + "APPROVE_TRANSITION_REQUEST": "Approve a transition request", + "CANCEL_TRANSITION_REQUEST": "Cancel (delete) a transition request", + "DELETE_COMMENT": "Delete the comment", + "EDIT_COMMENT": "Edit the comment", + "REJECT_TRANSITION_REQUEST": "Reject a transition request" + } + }, + "ml.CommentObject": { + "description": "For activities, this contains the activity recorded for the action.\nFor comments, this contains the comment details.\nFor transition requests, this contains the transition request details.", + "fields": { + "available_actions": { + "description": "Array of actions on the activity allowed for the current viewer.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided comment associated with the activity, comment, or transition request.", + "launch_stage": "GA" + }, + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "id": { + "description": "Unique identifier for the object.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Time of the object at last update, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "user_id": { + "description": "The username of the user that created the object.", + "launch_stage": "GA" + } + } + }, + "ml.ContinuousWindow": { + "description": "Deprecated: use RollingWindow with `delay` instead.", + "fields": { + "offset": { + "description": "The offset of the continuous window (must be non-positive).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "window_duration": { + "description": "The duration of the continuous window (must be positive).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.CountFunction": { + "description": "Computes the count of values.", + "fields": { + "input": { + "description": "The input column from which the count is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.CreateComment": { + "description": "Details required to create a comment on a model version.", + "fields": { + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.CreateCommentResponse": { + "fields": { + "comment": { + "description": "New comment object", + "ref": "ml.CommentObject", + "launch_stage": "GA" + } + } + }, + "ml.CreateExperiment": { + "fields": { + "artifact_location": { + "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", + "launch_stage": "GA" + }, + "name": { + "description": "Experiment name.", + "launch_stage": "GA" + }, + "tags": { + "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", + "launch_stage": "GA" + } + } + }, + "ml.CreateExperimentResponse": { + "fields": { + "experiment_id": { + "description": "Unique identifier for the experiment.", + "launch_stage": "GA" + } + } + }, + "ml.CreateForecastingExperimentRequest": { + "fields": { + "custom_weights_column": { + "description": "The column in the training table used to customize weights for each time series.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "experiment_path": { + "description": "The path in the workspace to store the created experiment.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "forecast_granularity": { + "description": "The time interval between consecutive rows in the time series data.\nPossible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "forecast_horizon": { + "description": "The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "future_feature_data_path": { + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store future feature data for predictions.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "holiday_regions": { + "description": "The region code(s) to automatically add holiday features. Currently supports only one region.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "include_features": { + "description": "Specifies the list of feature columns to include in model training. These columns must exist\nin the training data and be of type string, numerical, or boolean. If not specified, no additional\nfeatures will be included.\nNote: Certain columns are automatically handled:\n- Automatically excluded: split_column, target_column, custom_weights_column.\n- Automatically included: time_column.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "max_runtime": { + "description": "The maximum duration for the experiment in minutes. The experiment stops automatically if it exceeds this limit.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "prediction_data_path": { + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store predictions.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "primary_metric": { + "description": "The evaluation metric used to optimize the forecasting model.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "register_to": { + "description": "The fully qualified path of a Unity Catalog model, formatted as catalog_name.schema_name.model_name, used to store the best model.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "split_column": { + "description": "// The column in the training table used for custom data splits. Values must be 'train', 'validate', or 'test'.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "target_column": { + "description": "The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "time_column": { + "description": "The column in the input training table that represents each row's timestamp.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "timeseries_identifier_columns": { + "description": "The column in the training table used to group the dataset for predicting individual time series.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "train_data_path": { + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "training_frameworks": { + "description": "List of frameworks to include for model tuning. Possible values are 'Prophet', 'ARIMA', 'DeepAR'. An empty list includes all supported frameworks.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.CreateForecastingExperimentResponse": { + "fields": { + "experiment_id": { + "description": "The unique ID of the created forecasting experiment", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.CreateLoggedModelRequest": { + "fields": { + "experiment_id": { + "description": "The ID of the experiment that owns the model.", + "launch_stage": "GA" + }, + "model_type": { + "description": "The type of the model, such as ``\"Agent\"``, ``\"Classifier\"``, ``\"LLM\"``.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the model (optional). If not specified one will be generated.", + "launch_stage": "GA" + }, + "params": { + "description": "Parameters attached to the model.", + "launch_stage": "GA" + }, + "source_run_id": { + "description": "The ID of the run that created the model.", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags attached to the model.", + "launch_stage": "GA" + } + } + }, + "ml.CreateLoggedModelResponse": { + "fields": { + "model": { + "description": "The newly created logged model.", + "ref": "ml.LoggedModel", + "launch_stage": "GA" + } + } + }, + "ml.CreateMaterializedFeatureRequest": { + "fields": { + "materialized_feature": { + "description": "The materialized feature to create.", + "ref": "ml.MaterializedFeature", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.CreateModelRequest": { + "fields": { + "description": { + "description": "Optional description for registered model.", + "launch_stage": "GA" + }, + "name": { + "description": "Register models under this name", + "launch_stage": "GA" + }, + "tags": { + "description": "Additional metadata for registered model.", + "launch_stage": "GA" + } + } + }, + "ml.CreateModelResponse": { + "fields": { + "registered_model": { + "ref": "ml.Model", + "launch_stage": "GA" + } + } + }, + "ml.CreateModelVersionRequest": { + "fields": { + "description": { + "description": "Optional description for model version.", + "launch_stage": "GA" + }, + "name": { + "description": "Register model under this name", + "launch_stage": "GA" + }, + "run_id": { + "description": "MLflow run ID for correlation, if `source` was generated by an experiment run in\nMLflow tracking server", + "launch_stage": "GA" + }, + "run_link": { + "description": "MLflow run link - this is the exact link of the run that generated this model version,\npotentially hosted at another instance of MLflow.", + "launch_stage": "GA" + }, + "source": { + "description": "URI indicating the location of the model artifacts.", + "launch_stage": "GA" + }, + "tags": { + "description": "Additional metadata for model version.", + "launch_stage": "GA" + } + } + }, + "ml.CreateModelVersionResponse": { + "fields": { + "model_version": { + "description": "Return new version number generated for this model in registry.", + "ref": "ml.ModelVersion", + "launch_stage": "GA" + } + } + }, + "ml.CreateRegistryWebhook": { + "description": "Details required to create a registry webhook.", + "fields": { + "description": { + "description": "User-specified description for the webhook.", + "launch_stage": "GA" + }, + "events": { + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "launch_stage": "GA" + }, + "http_url_spec": { + "description": "External HTTPS URL called on event trigger (by using a POST request).", + "ref": "ml.HttpUrlSpec", + "launch_stage": "GA" + }, + "job_spec": { + "description": "ID of the job that the webhook runs.", + "ref": "ml.JobSpec", + "launch_stage": "GA" + }, + "model_name": { + "description": "If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.", + "launch_stage": "GA" + }, + "status": { + "description": "Enable or disable triggering the webhook, or put the webhook into test mode. The default is `ACTIVE`:\n* `ACTIVE`: Webhook is triggered when an associated event happens.\n\n* `DISABLED`: Webhook is not triggered.\n\n* `TEST_MODE`: Webhook can be triggered through the test endpoint, but is not triggered on a real event.", + "ref": "ml.RegistryWebhookStatus", + "launch_stage": "GA" + } + } + }, + "ml.CreateRun": { + "fields": { + "experiment_id": { + "description": "ID of the associated experiment.", + "launch_stage": "GA" + }, + "run_name": { + "description": "The name of the run.", + "launch_stage": "GA" + }, + "start_time": { + "description": "Unix timestamp in milliseconds of when the run started.", + "launch_stage": "GA" + }, + "tags": { + "description": "Additional metadata for run.", + "launch_stage": "GA" + }, + "user_id": { + "description": "ID of the user executing the run.\nThis field is deprecated as of MLflow 1.0, and will be removed in a future\nMLflow release. Use 'mlflow.user' tag instead.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "ml.CreateRunResponse": { + "fields": { + "run": { + "description": "The newly created run.", + "ref": "ml.Run", + "launch_stage": "GA" + } + } + }, + "ml.CreateTransitionRequest": { + "description": "Details required to create a model version stage transition request.", + "fields": { + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "stage": { + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.CreateTransitionRequestResponse": { + "fields": { + "request": { + "description": "New activity generated for stage transition request.", + "ref": "ml.TransitionRequest", + "launch_stage": "GA" + } + } + }, + "ml.CreateWebhookResponse": { + "fields": { + "webhook": { + "ref": "ml.RegistryWebhook", + "launch_stage": "GA" + } + } + }, + "ml.CronSchedule": { + "description": "A cron-based schedule trigger for the materialization pipeline.", + "fields": { + "cron_expression": { + "description": "The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.DataSource": { + "description": "Specifies the data source backing a feature. Exactly one source type must be set.", + "fields": { + "delta_table_source": { + "description": "A Delta table data source.", + "ref": "ml.DeltaTableSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "kafka_source": { + "description": "A Kafka stream data source.", + "ref": "ml.KafkaSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "request_source": { + "description": "A request-time data source.", + "ref": "ml.RequestSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.Dataset": { + "description": "Dataset. Represents a reference to data used for training, testing, or evaluation during\nthe model development process.", + "fields": { + "digest": { + "description": "Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it within datasets of the same name.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”", + "launch_stage": "GA" + }, + "profile": { + "description": "The profile of the dataset. Summary statistics for the dataset, such as the number of rows\nin a table, the mean / std / mode of each column in a table, or the number of elements\nin an array.", + "launch_stage": "GA" + }, + "schema": { + "description": "The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, MLflow TensorSpec JSON\nfor an ndarray, or another schema format.", + "launch_stage": "GA" + }, + "source": { + "description": "Source information for the dataset. Note that the source may not exactly reproduce the\ndataset if it was transformed / modified before use with MLflow.", + "launch_stage": "GA" + }, + "source_type": { + "description": "The type of the dataset source, e.g. ‘databricks-uc-table’, ‘DBFS’, ‘S3’, ...", + "launch_stage": "GA" + } + } + }, + "ml.DatasetInput": { + "description": "DatasetInput. Represents a dataset and input tags.", + "fields": { + "dataset": { + "description": "The dataset being used as a Run input.", + "ref": "ml.Dataset", + "launch_stage": "GA" + }, + "tags": { + "description": "A list of tags for the dataset input, e.g. a “context” tag with value “training”", + "launch_stage": "GA" + } + } + }, + "ml.DeleteCommentResponse": {}, + "ml.DeleteExperiment": { + "fields": { + "experiment_id": { + "description": "ID of the associated experiment.", + "launch_stage": "GA" + } + } + }, + "ml.DeleteExperimentResponse": {}, + "ml.DeleteLoggedModelResponse": {}, + "ml.DeleteLoggedModelTagResponse": {}, + "ml.DeleteModelResponse": {}, + "ml.DeleteModelTagResponse": {}, + "ml.DeleteModelVersionResponse": {}, + "ml.DeleteModelVersionTagResponse": {}, + "ml.DeleteRun": { + "fields": { + "run_id": { + "description": "ID of the run to delete.", + "launch_stage": "GA" + } + } + }, + "ml.DeleteRunResponse": {}, + "ml.DeleteRuns": { + "fields": { + "experiment_id": { + "description": "The ID of the experiment containing the runs to delete.", + "launch_stage": "GA" + }, + "max_runs": { + "description": "An optional positive integer indicating the maximum number of runs to delete. The maximum allowed value for\nmax_runs is 10000.", + "launch_stage": "GA" + }, + "max_timestamp_millis": { + "description": "The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.", + "launch_stage": "GA" + } + } + }, + "ml.DeleteRunsResponse": { + "fields": { + "runs_deleted": { + "description": "The number of runs deleted.", + "launch_stage": "GA" + } + } + }, + "ml.DeleteTag": { + "fields": { + "key": { + "description": "Name of the tag. Maximum size is 255 bytes. Must be provided.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run that the tag was logged under. Must be provided.", + "launch_stage": "GA" + } + } + }, + "ml.DeleteTagResponse": {}, + "ml.DeleteTransitionRequestResponse": { + "fields": { + "activity": { + "description": "New activity generated as a result of this operation.", + "ref": "ml.Activity", + "launch_stage": "GA" + } + } + }, + "ml.DeleteWebhookResponse": {}, + "ml.DeltaTableSource": { + "fields": { + "dataframe_schema": { + "description": "Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if transformation_sql is specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\"col_a\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"col_c\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "entity_columns": { + "description": "Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "filter_condition": { + "description": "Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "full_name": { + "description": "The full three-part (catalog, schema, table) name of the Delta table.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "timeseries_column": { + "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "transformation_sql": { + "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.DirectMtlsConfig": { + "description": "Direct connection configs for mTLS, as Kafka Connections do not support mTLS yet (XTA-18030).\nTemporarily used until UC Kafka Connections gain mTLS support.", + "fields": { + "bootstrap_servers": { + "description": "A comma-separated list of host:port pairs for the Kafka bootstrap servers.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "mtls_config": { + "description": "Mutual-TLS authentication configuration.", + "ref": "ml.MtlsConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.DirectSchemas": { + "description": "Schema definitions provided directly on the Stream, as opposed to referencing a schema registry.\nIn a future milestone, we will support schema registries through a UC Connection.", + "fields": { + "key_schema": { + "description": "Schema for the message key. This is only used for Kafka streams.\nFor Kafka, at least one of payload_schema or key_schema must be specified.", + "ref": "ml.SchemaConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "payload_schema": { + "description": "Schema for the message payload. For Kafka, this is the value schema.\nUnless the platform supports another schema (e.g. keys for Kafka), this must be specified.", + "ref": "ml.SchemaConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.EntityColumn": { + "fields": { + "name": { + "description": "The name of the entity column. For Kafka sources, use dot-prefixed path notation to reference\nfields within the key or value schema (e.g., \"value.user_id\", \"key.partition_key\"). For nested\nfields, the leaf node name (e.g., \"user_id\" from \"value.trip_details.user_id\") is what will\nbe present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:user_id\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.Experiment": { + "description": "An experiment and its metadata.", + "fields": { + "artifact_location": { + "description": "Location where artifacts for the experiment are stored.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Creation time", + "launch_stage": "GA" + }, + "experiment_id": { + "description": "Unique identifier for the experiment.", + "launch_stage": "GA" + }, + "last_update_time": { + "description": "Last update time", + "launch_stage": "GA" + }, + "lifecycle_stage": { + "description": "Current life cycle stage of the experiment: \"active\" or \"deleted\".\nDeleted experiments are not returned by APIs.", + "launch_stage": "GA" + }, + "name": { + "description": "Human readable name that identifies the experiment.", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags: Additional metadata key-value pairs.", + "launch_stage": "GA" + } + } + }, + "ml.ExperimentAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.ExperimentPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "ml.ExperimentAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "ml.ExperimentPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.ExperimentPermissionLevel", + "launch_stage": "GA" + } + } + }, + "ml.ExperimentPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_READ" + ] + }, + "ml.ExperimentPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "ml.ExperimentPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.ExperimentPermissionLevel", + "launch_stage": "GA" + } + } + }, + "ml.ExperimentPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "ml.ExperimentTag": { + "description": "A tag for an experiment.", + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.Feature": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_at": { + "description": "Time at which this feature was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of the feature creator.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "The description of the feature.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "entities": { + "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "filter_condition": { + "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "full_name": { + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE", + "REQUIRED" + ] + }, + "function": { + "description": "The function by which the feature is computed.", + "ref": "ml.Function", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE", + "REQUIRED" + ] + }, + "inputs": { + "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE", + "OPTIONAL" + ] + }, + "lineage_context": { + "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users.", + "ref": "ml.LineageContext", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name of the feature, extracted from the full three-part name (catalog.schema.name).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "schema_name": { + "description": "Name of parent schema relative to its parent catalog.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source": { + "description": "The data source of the feature.", + "ref": "ml.DataSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE", + "REQUIRED" + ] + }, + "time_window": { + "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed.", + "ref": "ml.TimeWindow", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE", + "OPTIONAL" + ] + }, + "timeseries_column": { + "description": "Column recording time, used for point-in-time joins, backfills, and aggregations.", + "ref": "ml.TimeseriesColumn", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.FeatureLineage": { + "fields": { + "feature_specs": { + "description": "List of feature specs that contain this feature.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "models": { + "description": "List of Unity Catalog models that were trained on this feature.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "online_features": { + "description": "List of online features that use this feature as source.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.FeatureLineageFeatureSpec": { + "fields": { + "name": { + "description": "The full name of the feature spec in Unity Catalog.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.FeatureLineageModel": { + "fields": { + "name": { + "description": "The full name of the model in Unity Catalog.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "version": { + "description": "The version of the model.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.FeatureLineageOnlineFeature": { + "fields": { + "feature_name": { + "description": "The name of the online feature (column name).", + "launch_stage": "PRIVATE_PREVIEW" + }, + "table_name": { + "description": "The full name of the online table in Unity Catalog.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.FeatureList": { + "description": "Feature list wrap all the features for a model version", + "fields": { + "features": { + "launch_stage": "GA" + } + } + }, + "ml.FeatureTag": { + "description": "Represents a tag on a feature in a feature table.", + "fields": { + "key": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "value": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.FieldDefinition": { + "description": "A single field definition within a FlatSchema, specifying the field name and its scalar data type.\nDoes not support nested or complex types (arrays, maps, structs).", + "fields": { + "data_type": { + "description": "The scalar data type of the field.", + "ref": "ml.ScalarDataType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "name": { + "description": "The name of the field.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.FileInfo": { + "description": "Metadata of a single artifact file or directory.", + "fields": { + "file_size": { + "description": "The size in bytes of the file. Unset for directories.", + "launch_stage": "GA" + }, + "is_dir": { + "description": "Whether the path is a directory.", + "launch_stage": "GA" + }, + "path": { + "description": "The path relative to the root artifact directory run.", + "launch_stage": "GA" + } + } + }, + "ml.FinalizeLoggedModelRequest": { + "fields": { + "status": { + "description": "Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.", + "ref": "ml.LoggedModelStatus", + "launch_stage": "GA" + } + } + }, + "ml.FinalizeLoggedModelResponse": { + "fields": { + "model": { + "description": "The updated logged model.", + "ref": "ml.LoggedModel", + "launch_stage": "GA" + } + } + }, + "ml.FirstFunction": { + "description": "Returns the first value.", + "fields": { + "input": { + "description": "The input column from which the first value is returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.FlatSchema": { + "description": "A flat (non-nested) schema for request-time fields, defined as an ordered list of field definitions.\nThis schema only supports scalar types.", + "fields": { + "fields": { + "description": "The list of fields in this schema.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.ForecastingExperiment": { + "description": "Represents a forecasting experiment with its unique identifier, URL, and state.", + "fields": { + "experiment_id": { + "description": "The unique ID for the forecasting experiment.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "experiment_page_url": { + "description": "The URL to the forecasting experiment page.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "state": { + "description": "The current state of the forecasting experiment.", + "ref": "ml.ForecastingExperimentState", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ForecastingExperimentState": { + "enum": [ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "PRIVATE_PREVIEW", + "FAILED": "PRIVATE_PREVIEW", + "PENDING": "PRIVATE_PREVIEW", + "RUNNING": "PRIVATE_PREVIEW", + "SUCCEEDED": "PRIVATE_PREVIEW" + } + }, + "ml.Function": { + "fields": { + "aggregation_function": { + "description": "An aggregation function applied over a time window.", + "ref": "ml.AggregationFunction", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "column_selection": { + "description": "Selects the latest value of a single column in a data source", + "ref": "ml.ColumnSelection", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "extra_parameters": { + "description": "Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nExtra parameters for parameterized functions.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "function_type": { + "description": "Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nThe type of the function.", + "ref": "ml.FunctionFunctionType", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.FunctionExtraParameter": { + "description": "Deprecated: Use typed fields on function-specific messages (e.g. ApproxPercentileFunction.percentile)\nor AggregationFunction.ExtraParameter instead. Kept for backwards compatibility.", + "fields": { + "key": { + "description": "The name of the parameter.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "value": { + "description": "The value of the parameter.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.FunctionFunctionType": { + "description": "Deprecated: Use the function-specific messages in AggregationFunction.function_type oneof instead. Kept for backwards compatibility.", + "enum": [ + "AVG", + "COUNT", + "SUM", + "MIN", + "MAX", + "FIRST", + "LAST", + "APPROX_COUNT_DISTINCT", + "APPROX_PERCENTILE", + "STDDEV_POP", + "STDDEV_SAMP", + "VAR_POP", + "VAR_SAMP" + ], + "enum_launch_stages": { + "APPROX_COUNT_DISTINCT": "PRIVATE_PREVIEW", + "APPROX_PERCENTILE": "PRIVATE_PREVIEW", + "AVG": "PRIVATE_PREVIEW", + "COUNT": "PRIVATE_PREVIEW", + "FIRST": "PRIVATE_PREVIEW", + "LAST": "PRIVATE_PREVIEW", + "MAX": "PRIVATE_PREVIEW", + "MIN": "PRIVATE_PREVIEW", + "STDDEV_POP": "PRIVATE_PREVIEW", + "STDDEV_SAMP": "PRIVATE_PREVIEW", + "SUM": "PRIVATE_PREVIEW", + "VAR_POP": "PRIVATE_PREVIEW", + "VAR_SAMP": "PRIVATE_PREVIEW" + } + }, + "ml.GetExperimentByNameResponse": { + "fields": { + "experiment": { + "description": "Experiment details.", + "ref": "ml.Experiment", + "launch_stage": "GA" + } + } + }, + "ml.GetExperimentPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "ml.GetExperimentResponse": { + "fields": { + "experiment": { + "description": "Experiment details.", + "ref": "ml.Experiment", + "launch_stage": "GA" + } + } + }, + "ml.GetLatestVersionsRequest": { + "fields": { + "name": { + "description": "Registered model unique name identifier.", + "launch_stage": "GA" + }, + "stages": { + "description": "List of stages.", + "launch_stage": "GA" + } + } + }, + "ml.GetLatestVersionsResponse": { + "fields": { + "model_versions": { + "description": "Latest version models for each requests stage. Only return models with current `READY` status.\nIf no `stages` provided, returns the latest version for each stage, including `\"None\"`.", + "launch_stage": "GA" + } + } + }, + "ml.GetLoggedModelResponse": { + "fields": { + "model": { + "description": "The retrieved logged model.", + "ref": "ml.LoggedModel", + "launch_stage": "GA" + } + } + }, + "ml.GetMetricHistoryResponse": { + "fields": { + "metrics": { + "description": "All logged values for this metric if `max_results` is not specified in the request or if the total count of\nmetrics returned is less than the service level pagination threshold. Otherwise, this is one page of results.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to issue a query for the next page of metric history values. A missing token indicates\nthat no additional metrics are available to fetch.", + "launch_stage": "GA" + } + } + }, + "ml.GetModelResponse": { + "fields": { + "registered_model_databricks": { + "ref": "ml.ModelDatabricks", + "launch_stage": "GA" + } + } + }, + "ml.GetModelVersionDownloadUriResponse": { + "fields": { + "artifact_uri": { + "description": "URI corresponding to where artifacts for this model version are stored.", + "launch_stage": "GA" + } + } + }, + "ml.GetModelVersionResponse": { + "fields": { + "model_version": { + "ref": "ml.ModelVersion", + "launch_stage": "GA" + } + } + }, + "ml.GetRegisteredModelPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "ml.GetRunResponse": { + "fields": { + "run": { + "description": "Run metadata (name, start time, etc) and data (metrics, params, and tags).", + "ref": "ml.Run", + "launch_stage": "GA" + } + } + }, + "ml.HttpUrlSpec": { + "fields": { + "authorization": { + "description": "Value of the authorization header that should be sent in the request sent by the wehbook. It should be of the form `\"\u003cauth type\u003e \u003ccredentials\u003e\"`. If set to an empty string, no authorization header will be included in the request.", + "launch_stage": "GA" + }, + "enable_ssl_verification": { + "description": "Enable/disable SSL certificate validation. Default is true. For self-signed certificates, this field must be false AND the destination server must disable certificate validation as well. For security purposes, it is encouraged to perform secret validation with the HMAC-encoded portion of the payload and acknowledge the risk associated with disabling hostname validation whereby it becomes more likely that requests can be maliciously routed to an unintended host.", + "launch_stage": "GA" + }, + "secret": { + "description": "Shared secret required for HMAC encoding payload. The HMAC-encoded payload will be sent in the header as: { \"X-Databricks-Signature\": $encoded_payload }.", + "launch_stage": "GA" + }, + "url": { + "description": "External HTTPS URL called on event trigger (by using a POST request).", + "launch_stage": "GA" + } + } + }, + "ml.HttpUrlSpecWithoutSecret": { + "fields": { + "enable_ssl_verification": { + "description": "Enable/disable SSL certificate validation. Default is true. For self-signed certificates, this field must be false AND the destination server must disable certificate validation as well. For security purposes, it is encouraged to perform secret validation with the HMAC-encoded portion of the payload and acknowledge the risk associated with disabling hostname validation whereby it becomes more likely that requests can be maliciously routed to an unintended host.", + "launch_stage": "GA" + }, + "url": { + "description": "External HTTPS URL called on event trigger (by using a POST request).", + "launch_stage": "GA" + } + } + }, + "ml.IngestionConfig": { + "description": "Configuration for the Databricks-managed ingestion pipeline.\nGroups the ingestion destination (required) and optional backfill source.", + "fields": { + "backfill_job_id": { + "description": "The ID of the Databricks Job that performs the historical backfill of the ingestion Delta table.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "backfill_source": { + "description": "A user-provided source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Stream.\nThe backfill data stored in this location will be copied into the ingestion table for offline querying and training.\nThe schema for this source must match exactly that of the key and payload schemas specified for this Stream.", + "ref": "ml.BackfillSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "deduplication_columns": { + "description": "Column paths used to identify duplicate rows during ingestion; only one row per\ndistinct combination of these values is kept. Use dot notation for nested fields\n(e.g. `value.user_id`). Empty list means every column is compared.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "ingestion_destination": { + "description": "Destination for the Databricks-managed Delta table that holds an offline copy of the streaming data for querying and training.\nThis table contains both 1) forward-filled data from the Stream and 2) backfilled data from the BackfillSource (if provided).\nThis table is created and managed by Databricks and is deleted when the Stream is deleted.", + "ref": "ml.IngestionDestination", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "ingestion_job_id": { + "description": "The ID of the Databricks Job that performs the forward-fill ingestion.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "ingestion_pipeline_id": { + "description": "The ID of the SDP pipeline that continuously copies new events from the streaming source\ninto the ingestion Delta table.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "ml.IngestionDestination": { + "description": "Destination for the Databricks-managed Delta table that holds an offline copy of the streaming data for querying and training.", + "fields": { + "delta_table_name": { + "description": "The full three-part name (catalog, schema, name) of the Delta table to be created for ingestion.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.InputTag": { + "description": "Tag for a dataset input.", + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.JobContext": { + "fields": { + "job_id": { + "description": "The job ID where this API invoked.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "job_run_id": { + "description": "The job run ID where this API was invoked.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.JobSpec": { + "fields": { + "access_token": { + "description": "The personal access token used to authorize webhook's job runs.", + "launch_stage": "GA" + }, + "job_id": { + "description": "ID of the job that the webhook runs.", + "launch_stage": "GA" + }, + "workspace_url": { + "description": "URL of the workspace containing the job that this webhook runs. If not specified, the job’s workspace URL is assumed to be the same as the workspace where the webhook is created.", + "launch_stage": "GA" + } + } + }, + "ml.JobSpecWithoutSecret": { + "fields": { + "job_id": { + "description": "ID of the job that the webhook runs.", + "launch_stage": "GA" + }, + "workspace_url": { + "description": "URL of the workspace containing the job that this webhook runs. If not specified, the job’s workspace URL is assumed to be the same as the workspace where the webhook is created.", + "launch_stage": "GA" + } + } + }, + "ml.KafkaConfig": { + "fields": { + "auth_config": { + "description": "Authentication configuration for connection to topics.", + "ref": "ml.AuthConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "backfill_source": { + "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config.", + "ref": "ml.BackfillSource", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "bootstrap_servers": { + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "extra_options": { + "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "key_schema": { + "description": "Schema configuration for extracting message keys from topics. At least one of key_schema and value_schema must be provided.", + "ref": "ml.SchemaConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "subscription_mode": { + "description": "Options to configure which Kafka topics to pull data from.", + "ref": "ml.SubscriptionMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "value_schema": { + "description": "Schema configuration for extracting message values from topics. At least one of key_schema and value_schema must be provided.", + "ref": "ml.SchemaConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.KafkaSource": { + "fields": { + "entity_column_identifiers": { + "description": "Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity column identifiers of the Kafka source.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "filter_condition": { + "description": "The filter condition applied to the source data before aggregation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name of the Kafka source, used to identify it. This is used to look up the corresponding KafkaConfig object. Can be distinct from topic name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "timeseries_column_identifier": { + "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column identifier of the Kafka source.", + "ref": "ml.ColumnIdentifier", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.KafkaStreamConfig": { + "description": "Kafka-specific configuration for a Stream.", + "fields": { + "extra_options": { + "description": "Miscellaneous source options. Accepted keys are source options or Kafka consumer options (kafka.*),\nvalidated against an allow-list at request time.\nAll auth configuration goes through the underlying UC Connection(s) or configs and should not be stored here.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscription_mode": { + "description": "Options to configure which Kafka topics to pull data from.", + "ref": "ml.KafkaSubscriptionMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.KafkaSubscriptionMode": { + "description": "Subscription mode for Kafka topic selection, matching standard Spark Structured Streaming options.", + "fields": { + "assign": { + "description": "A JSON string that contains the specific topic-partitions to consume from.\nFor example, for '{\"topicA\":[0,1],\"topicB\":[2,4]}', topicA's 0'th and 1st partitions will be consumed from.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscribe": { + "description": "A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscribe_pattern": { + "description": "A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.LastFunction": { + "description": "Returns the last value.", + "fields": { + "input": { + "description": "The input column from which the last value is returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.LineageContext": { + "description": "Lineage context information for tracking where an API was invoked. This will allow us to track lineage, which currently uses caller entity information for use across the Lineage Client and Observability in Lumberjack.", + "fields": { + "job_context": { + "description": "Job context information including job ID and run ID.", + "ref": "ml.JobContext", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "notebook_id": { + "description": "The notebook ID where this API was invoked.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.LinkedFeature": { + "description": "Feature for model version. ([ML-57150] Renamed from Feature to LinkedFeature)", + "fields": { + "feature_name": { + "description": "Feature name", + "launch_stage": "GA" + }, + "feature_table_id": { + "description": "Feature table id", + "launch_stage": "GA" + }, + "feature_table_name": { + "description": "Feature table name", + "launch_stage": "GA" + } + } + }, + "ml.ListArtifactsResponse": { + "fields": { + "files": { + "description": "The file location and metadata for artifacts.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "The token that can be used to retrieve the next page of artifact results.", + "launch_stage": "GA" + }, + "root_uri": { + "description": "The root artifact directory for the run.", + "launch_stage": "GA" + } + } + }, + "ml.ListExperimentsResponse": { + "fields": { + "experiments": { + "description": "Paginated Experiments beginning with the first item on the requested page.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Token that can be used to retrieve the next page of experiments.\nEmpty token means no more experiment is available for retrieval.", + "launch_stage": "GA" + } + } + }, + "ml.ListFeatureTagsResponse": { + "description": "Response message for ListFeatureTag.", + "fields": { + "feature_tags": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListFeaturesResponse": { + "fields": { + "features": { + "description": "List of features.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListKafkaConfigsResponse": { + "fields": { + "kafka_configs": { + "description": "List of Kafka configs. Schemas are not included in the response.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListMaterializedFeaturesResponse": { + "fields": { + "materialized_features": { + "description": "List of materialized features.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListModelsResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request next page of models for the same query.", + "launch_stage": "GA" + }, + "registered_models": { + "launch_stage": "GA" + } + } + }, + "ml.ListOnlineStoresResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "online_stores": { + "description": "List of online stores.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListRegistryWebhooks": { + "fields": { + "next_page_token": { + "description": "Token that can be used to retrieve the next page of artifact results", + "launch_stage": "GA" + }, + "webhooks": { + "description": "Array of registry webhooks.", + "launch_stage": "GA" + } + } + }, + "ml.ListStreamsResponse": { + "description": "Response to a ListStreamsRequest.", + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of results for this query.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "streams": { + "description": "List of Streams.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.ListTransitionRequestsResponse": { + "fields": { + "requests": { + "description": "Array of open transition requests.", + "launch_stage": "GA" + } + } + }, + "ml.LogBatch": { + "fields": { + "metrics": { + "description": "Metrics to log. A single request can contain up to 1000 metrics, and up to 1000\nmetrics, params, and tags in total.", + "launch_stage": "GA" + }, + "params": { + "description": "Params to log. A single request can contain up to 100 params, and up to 1000\nmetrics, params, and tags in total.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run to log under", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags to log. A single request can contain up to 100 tags, and up to 1000\nmetrics, params, and tags in total.", + "launch_stage": "GA" + } + } + }, + "ml.LogBatchResponse": {}, + "ml.LogInputs": { + "fields": { + "datasets": { + "description": "Dataset inputs", + "launch_stage": "GA" + }, + "models": { + "description": "Model inputs", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run to log under", + "launch_stage": "GA" + } + } + }, + "ml.LogInputsResponse": {}, + "ml.LogLoggedModelParamsRequest": { + "fields": { + "params": { + "description": "Parameters to attach to the model.", + "launch_stage": "GA" + } + } + }, + "ml.LogLoggedModelParamsRequestResponse": {}, + "ml.LogMetric": { + "fields": { + "dataset_digest": { + "description": "Dataset digest of the dataset associated with the metric,\ne.g. an md5 hash of the dataset that uniquely identifies it\nwithin datasets of the same name.", + "launch_stage": "GA" + }, + "dataset_name": { + "description": "The name of the dataset associated with the metric.\nE.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”", + "launch_stage": "GA" + }, + "key": { + "description": "Name of the metric.", + "launch_stage": "GA" + }, + "model_id": { + "description": "ID of the logged model associated with the metric, if applicable", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run under which to log the metric. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the metric. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + }, + "step": { + "description": "Step at which to log the metric", + "launch_stage": "GA" + }, + "timestamp": { + "description": "Unix timestamp in milliseconds at the time metric was logged.", + "launch_stage": "GA" + }, + "value": { + "description": "Double value of the metric being logged.", + "launch_stage": "GA" + } + } + }, + "ml.LogMetricResponse": {}, + "ml.LogModel": { + "fields": { + "model_json": { + "description": "MLmodel file in json format.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run to log under", + "launch_stage": "GA" + } + } + }, + "ml.LogModelResponse": {}, + "ml.LogOutputsRequest": { + "fields": { + "models": { + "description": "The model outputs from the Run.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The ID of the Run from which to log outputs.", + "launch_stage": "GA" + } + } + }, + "ml.LogOutputsResponse": {}, + "ml.LogParam": { + "fields": { + "key": { + "description": "Name of the param. Maximum size is 255 bytes.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run under which to log the param. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the param. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + }, + "value": { + "description": "String value of the param being logged. Maximum size is 500 bytes.", + "launch_stage": "GA" + } + } + }, + "ml.LogParamResponse": {}, + "ml.LoggedModel": { + "description": "A logged model message includes logged model attributes,\ntags, registration info, params, and linked run metrics.", + "fields": { + "data": { + "description": "The params and metrics attached to the logged model.", + "ref": "ml.LoggedModelData", + "launch_stage": "GA" + }, + "info": { + "description": "The logged model attributes such as model ID, status, tags, etc.", + "ref": "ml.LoggedModelInfo", + "launch_stage": "GA" + } + } + }, + "ml.LoggedModelData": { + "description": "A LoggedModelData message includes logged model params and linked metrics.", + "fields": { + "metrics": { + "description": "Performance metrics linked to the model.", + "launch_stage": "GA" + }, + "params": { + "description": "Immutable string key-value pairs of the model.", + "launch_stage": "GA" + } + } + }, + "ml.LoggedModelInfo": { + "description": "A LoggedModelInfo includes logged model attributes,\ntags, and registration info.", + "fields": { + "artifact_uri": { + "description": "The URI of the directory where model artifacts are stored.", + "launch_stage": "GA" + }, + "creation_timestamp_ms": { + "description": "The timestamp when the model was created in milliseconds since the UNIX epoch.", + "launch_stage": "GA" + }, + "creator_id": { + "description": "The ID of the user or principal that created the model.", + "launch_stage": "GA" + }, + "experiment_id": { + "description": "The ID of the experiment that owns the model.", + "launch_stage": "GA" + }, + "last_updated_timestamp_ms": { + "description": "The timestamp when the model was last updated in milliseconds since the UNIX epoch.", + "launch_stage": "GA" + }, + "model_id": { + "description": "The unique identifier for the logged model.", + "launch_stage": "GA" + }, + "model_type": { + "description": "The type of model, such as ``\"Agent\"``, ``\"Classifier\"``, ``\"LLM\"``.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the model.", + "launch_stage": "GA" + }, + "source_run_id": { + "description": "The ID of the run that created the model.", + "launch_stage": "GA" + }, + "status": { + "description": "The status of whether or not the model is ready for use.", + "ref": "ml.LoggedModelStatus", + "launch_stage": "GA" + }, + "status_message": { + "description": "Details on the current model status.", + "launch_stage": "GA" + }, + "tags": { + "description": "Mutable string key-value pairs set on the model.", + "launch_stage": "GA" + } + } + }, + "ml.LoggedModelParameter": { + "description": "Parameter associated with a LoggedModel.", + "fields": { + "key": { + "description": "The key identifying this param.", + "launch_stage": "GA" + }, + "value": { + "description": "The value of this param.", + "launch_stage": "GA" + } + } + }, + "ml.LoggedModelStatus": { + "description": "A LoggedModelStatus enum value represents the status of a logged\nmodel.", + "enum": [ + "LOGGED_MODEL_PENDING", + "LOGGED_MODEL_READY", + "LOGGED_MODEL_UPLOAD_FAILED" + ], + "enum_launch_stages": { + "LOGGED_MODEL_PENDING": "GA", + "LOGGED_MODEL_READY": "GA", + "LOGGED_MODEL_UPLOAD_FAILED": "GA" + } + }, + "ml.LoggedModelTag": { + "description": "Tag for a LoggedModel.", + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.MaterializedFeature": { + "description": "A materialized feature represents a feature that is continuously computed and stored.", + "fields": { + "cron_schedule": { + "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "cron_schedule_trigger": { + "description": "A cron-based schedule trigger for the materialization pipeline.", + "ref": "ml.CronSchedule", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "feature_name": { + "description": "The full name of the feature in Unity Catalog.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "is_online": { + "description": "True if this is an online materialized feature. False if it is an offline materialized feature.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_materialization_time": { + "description": "The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "materialized_feature_id": { + "description": "Server-assigned unique identifier for the materialized feature.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "offline_store_config": { + "description": "Destination for writing feature values to an offline Delta table.", + "ref": "ml.OfflineStoreConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "online_store_config": { + "description": "Destination for writing feature values to an online Lakebase table.", + "ref": "ml.OnlineStoreConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "pipeline_schedule_state": { + "description": "The schedule state of the materialization pipeline.", + "ref": "ml.MaterializedFeaturePipelineScheduleState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "streaming_mode": { + "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads.", + "ref": "ml.StreamingMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "table_name": { + "description": "The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "table_trigger": { + "description": "A trigger that fires when the upstream source table changes.", + "ref": "ml.TableTrigger", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.MaterializedFeaturePipelineScheduleState": { + "enum": [ + "SNAPSHOT", + "ACTIVE", + "PAUSED" + ], + "enum_launch_stages": { + "ACTIVE": "PRIVATE_PREVIEW", + "PAUSED": "PRIVATE_PREVIEW", + "SNAPSHOT": "PRIVATE_PREVIEW" + } + }, + "ml.MaxFunction": { + "description": "Computes the maximum value.", + "fields": { + "input": { + "description": "The input column from which the maximum is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.Metric": { + "description": "Metric associated with a run, represented as a key-value pair.", + "fields": { + "dataset_digest": { + "description": "The dataset digest of the dataset associated with the metric,\ne.g. an md5 hash of the dataset that uniquely identifies it\nwithin datasets of the same name.", + "launch_stage": "GA" + }, + "dataset_name": { + "description": "The name of the dataset associated with the metric.\nE.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”", + "launch_stage": "GA" + }, + "key": { + "description": "The key identifying the metric.", + "launch_stage": "GA" + }, + "model_id": { + "description": "The ID of the logged model or registered model version associated with\nthe metric, if applicable.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The ID of the run containing the metric.", + "launch_stage": "GA" + }, + "step": { + "description": "The step at which the metric was logged.", + "launch_stage": "GA" + }, + "timestamp": { + "description": "The timestamp at which the metric was recorded.", + "launch_stage": "GA" + }, + "value": { + "description": "The value of the metric.", + "launch_stage": "GA" + } + } + }, + "ml.MinFunction": { + "description": "Computes the minimum value.", + "fields": { + "input": { + "description": "The input column from which the minimum is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.Model": { + "fields": { + "creation_timestamp": { + "description": "Timestamp recorded when this `registered_model` was created.", + "launch_stage": "GA" + }, + "description": { + "description": "Description of this `registered_model`.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Timestamp recorded when metadata for this `registered_model` was last updated.", + "launch_stage": "GA" + }, + "latest_versions": { + "description": "Collection of latest model versions for each stage.\nOnly contains models with current `READY` status.", + "launch_stage": "GA" + }, + "name": { + "description": "Unique name for the model.", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags: Additional metadata key-value pairs for this `registered_model`.", + "launch_stage": "GA" + }, + "user_id": { + "description": "User that created this `registered_model`", + "launch_stage": "GA" + } + } + }, + "ml.ModelDatabricks": { + "fields": { + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "description": { + "description": "User-specified description for the object.", + "launch_stage": "GA" + }, + "id": { + "description": "Unique identifier for the object.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Last update time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "latest_versions": { + "description": "Array of model versions, each the latest version for its stage.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "permission_level": { + "description": "Permission level granted for the requesting user on this registered model", + "ref": "ml.PermissionLevel", + "launch_stage": "GA" + }, + "tags": { + "description": "Array of tags associated with the model.", + "launch_stage": "GA" + }, + "user_id": { + "description": "The username of the user that created the object.", + "launch_stage": "GA" + } + } + }, + "ml.ModelInput": { + "description": "Represents a LoggedModel or Registered Model Version input to a Run.", + "fields": { + "model_id": { + "description": "The unique identifier of the model.", + "launch_stage": "GA" + } + } + }, + "ml.ModelOutput": { + "description": "Represents a LoggedModel output of a Run.", + "fields": { + "model_id": { + "description": "The unique identifier of the model.", + "launch_stage": "GA" + }, + "step": { + "description": "The step at which the model was produced.", + "launch_stage": "GA" + } + } + }, + "ml.ModelTag": { + "description": "Tag for a registered model", + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.ModelVersion": { + "fields": { + "creation_timestamp": { + "description": "Timestamp recorded when this `model_version` was created.", + "launch_stage": "GA" + }, + "current_stage": { + "description": "Current stage for this `model_version`.", + "launch_stage": "GA" + }, + "description": { + "description": "Description of this `model_version`.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Timestamp recorded when metadata for this `model_version` was last updated.", + "launch_stage": "GA" + }, + "name": { + "description": "Unique name of the model", + "launch_stage": "GA" + }, + "run_id": { + "description": "MLflow run ID used when creating `model_version`, if `source` was generated by an\nexperiment run stored in MLflow tracking server.", + "launch_stage": "GA" + }, + "run_link": { + "description": "Run Link: Direct link to the run that generated this version", + "launch_stage": "GA" + }, + "source": { + "description": "URI indicating the location of the source model artifacts, used when creating `model_version`", + "launch_stage": "GA" + }, + "status": { + "description": "Current status of `model_version`", + "ref": "ml.ModelVersionStatus", + "launch_stage": "GA" + }, + "status_message": { + "description": "Details on current `status`, if it is pending or failed.", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags: Additional metadata key-value pairs for this `model_version`.", + "launch_stage": "GA" + }, + "user_id": { + "description": "User that created this `model_version`.", + "launch_stage": "GA" + }, + "version": { + "description": "Model's version number.", + "launch_stage": "GA" + } + } + }, + "ml.ModelVersionDatabricks": { + "fields": { + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "current_stage": { + "launch_stage": "GA" + }, + "description": { + "description": "User-specified description for the object.", + "launch_stage": "GA" + }, + "email_subscription_status": { + "description": "Email Subscription Status: This is the subscription status of the user to the model version\nUsers get subscribed by interacting with the model version.", + "ref": "ml.RegistryEmailSubscriptionType", + "launch_stage": "GA" + }, + "feature_list": { + "description": "Feature lineage of `model_version`.", + "ref": "ml.FeatureList", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Time of the object at last update, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "open_requests": { + "description": "Open requests for this `model_versions`.\nGap in sequence number is intentional and is done in order to\nmatch field sequence numbers of `ModelVersion` proto message", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.PermissionLevel", + "launch_stage": "GA" + }, + "run_id": { + "description": "Unique identifier for the MLflow tracking run associated with the source model artifacts.", + "launch_stage": "GA" + }, + "run_link": { + "description": "URL of the run associated with the model artifacts. This field is set at model version creation time only for model versions whose source run is from a tracking server that is different from the registry server.", + "launch_stage": "GA" + }, + "source": { + "description": "URI that indicates the location of the source model artifacts. This is used when creating the model version.", + "launch_stage": "GA" + }, + "status": { + "ref": "ml.status", + "launch_stage": "GA" + }, + "status_message": { + "description": "Details on the current status, for example why registration failed.", + "launch_stage": "GA" + }, + "tags": { + "description": "Array of tags that are associated with the model version.", + "launch_stage": "GA" + }, + "user_id": { + "description": "The username of the user that created the object.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.ModelVersionStatus": { + "description": "The status of the model version. Valid values are:\n* `PENDING_REGISTRATION`: Request to register a new model version is pending as server performs background tasks.\n\n* `FAILED_REGISTRATION`: Request to register a new model version has failed.\n\n* `READY`: Model version is ready for use.", + "enum": [ + "PENDING_REGISTRATION", + "FAILED_REGISTRATION", + "READY" + ], + "enum_launch_stages": { + "FAILED_REGISTRATION": "GA", + "PENDING_REGISTRATION": "GA", + "READY": "GA" + }, + "enum_descriptions": { + "FAILED_REGISTRATION": "Request to register a new model version has failed.", + "PENDING_REGISTRATION": "Request to register a new model version is pending as server performs background tasks.", + "READY": "Model version is ready for use." + } + }, + "ml.ModelVersionTag": { + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.MtlsConfig": { + "description": "Mutual-TLS (mTLS) authentication configuration. The keystore (client certificate +\nprivate key) and truststore (CAs trusted to verify the broker) live as JKS files on\nUnity Catalog volumes, with their passwords stored in Databricks secret scopes. This\nmatches the SSL setup pattern documented at\nhttps://docs.databricks.com/en/connect/streaming/kafka/authentication#use-ssl-to-connect-databricks-to-kafka.\n\nAt materialization time, the generated PySpark code passes the JKS file paths and\nresolved passwords through to the Kafka SSL options (kafka.ssl.keystore.location,\nkafka.ssl.keystore.password, kafka.ssl.key.password, kafka.ssl.truststore.location,\nkafka.ssl.truststore.password). Passwords are resolved on the Spark cluster via\ndbutils.secrets.get; this message stores only references, never password values.", + "fields": { + "disable_hostname_verification": { + "description": "Set to true only when the broker certificate's SAN intentionally does not match\nthe connection endpoint — for example when reaching the cluster through a\nPrivateLink endpoint whose DNS name is not in the broker certificate. Skipping\nthe hostname check removes a defense against man-in-the-middle attacks; do not\nenable casually. mTLS client authentication is unaffected by this option.\n\nSee the Apache Kafka SSL security guide for background on this check:\nhttps://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "key_password_ref": { + "description": "Secret-scope reference for the private key password. Often the same value as the\nkeystore password (keytool's default), but provided as a separate field because\nApache Kafka requires it as a distinct option (kafka.ssl.key.password).", + "ref": "ml.SecretScopeReference", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "keystore_location": { + "description": "Unity Catalog volume path to the JKS keystore file containing the client certificate\nand private key. e.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/client.jks\". The\nmaterialization compute must have read permission on this volume.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "keystore_password_ref": { + "description": "Secret-scope reference for the JKS keystore password.", + "ref": "ml.SecretScopeReference", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "truststore_location": { + "description": "Unity Catalog volume path to the JKS truststore file containing the CA certificate(s)\ntrusted to verify the Kafka broker's server certificate.\ne.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/truststore.jks\".", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "truststore_password_ref": { + "description": "Secret-scope reference for the JKS truststore password.", + "ref": "ml.SecretScopeReference", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.OfflineStoreConfig": { + "description": "Configuration for offline store destination.", + "fields": { + "catalog_name": { + "description": "The Unity Catalog catalog name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "schema_name": { + "description": "The Unity Catalog schema name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "table_name_prefix": { + "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a table with this prefix and a generated postfix.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.OnlineStore": { + "description": "An OnlineStore is a logical database instance that stores and serves features online.", + "fields": { + "capacity": { + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "creation_time": { + "description": "The timestamp when the online store was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The email of the creator of the online store.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the online store. This is the unique identifier for the online store.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "read_replica_count": { + "description": "The number of read replicas for the online store. Defaults to 0.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "state": { + "description": "The current state of the online store.", + "ref": "ml.OnlineStoreState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "usage_policy_id": { + "description": "The usage policy applied to the online store to track billing.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.OnlineStoreConfig": { + "description": "Configuration for online store destination.", + "fields": { + "catalog_name": { + "description": "The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "online_store_name": { + "description": "The name of the target online store.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "schema_name": { + "description": "The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "table_name_prefix": { + "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.OnlineStoreState": { + "enum": [ + "STARTING", + "AVAILABLE", + "DELETING", + "STOPPED", + "UPDATING", + "FAILING_OVER" + ], + "enum_launch_stages": { + "AVAILABLE": "PRIVATE_PREVIEW", + "DELETING": "PRIVATE_PREVIEW", + "FAILING_OVER": "PRIVATE_PREVIEW", + "STARTING": "PRIVATE_PREVIEW", + "STOPPED": "PRIVATE_PREVIEW", + "UPDATING": "PRIVATE_PREVIEW" + } + }, + "ml.Param": { + "description": "Param associated with a run.", + "fields": { + "key": { + "description": "Key identifying this param.", + "launch_stage": "GA" + }, + "value": { + "description": "Value associated with this param.", + "launch_stage": "GA" + } + } + }, + "ml.PermissionLevel": { + "description": "Permission level of the requesting user on the object. For what is allowed at each level, see [MLflow Model permissions](..).", + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_READ", + "CAN_MANAGE_STAGING_VERSIONS", + "CAN_MANAGE_PRODUCTION_VERSIONS", + "CAN_CREATE_REGISTERED_MODEL" + ], + "enum_launch_stages": { + "CAN_CREATE_REGISTERED_MODEL": "GA", + "CAN_EDIT": "GA", + "CAN_MANAGE": "GA", + "CAN_MANAGE_PRODUCTION_VERSIONS": "GA", + "CAN_MANAGE_STAGING_VERSIONS": "GA", + "CAN_READ": "GA" + } + }, + "ml.PublishSpec": { + "fields": { + "online_store": { + "description": "The name of the target online store.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "online_table_name": { + "description": "The full three-part (catalog, schema, table) name of the online table.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "publish_mode": { + "description": "The publish mode of the pipeline that syncs the online table with the source table.", + "ref": "ml.PublishSpecPublishMode", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.PublishSpecPublishMode": { + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ], + "enum_launch_stages": { + "CONTINUOUS": "PRIVATE_PREVIEW", + "SNAPSHOT": "PRIVATE_PREVIEW", + "TRIGGERED": "PRIVATE_PREVIEW" + } + }, + "ml.PublishTableRequest": { + "fields": { + "publish_spec": { + "description": "The specification for publishing the online table from the source table.", + "ref": "ml.PublishSpec", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.PublishTableResponse": { + "fields": { + "online_table_name": { + "description": "The full three-part (catalog, schema, table) name of the online table.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "pipeline_id": { + "description": "The ID of the pipeline that syncs the online table with the source table.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.RegisteredModelAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.RegisteredModelPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "ml.RegisteredModelAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "ml.RegisteredModelPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.RegisteredModelPermissionLevel", + "launch_stage": "GA" + } + } + }, + "ml.RegisteredModelPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_MANAGE_PRODUCTION_VERSIONS", + "CAN_MANAGE_STAGING_VERSIONS", + "CAN_EDIT", + "CAN_READ" + ] + }, + "ml.RegisteredModelPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "ml.RegisteredModelPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "ml.RegisteredModelPermissionLevel", + "launch_stage": "GA" + } + } + }, + "ml.RegisteredModelPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "ml.RegistryEmailSubscriptionType": { + "description": ".. note::\nExperimental: This entity may change or be removed in a future release without warning.\nEmail subscription types for registry notifications:\n- `ALL_EVENTS`: Subscribed to all events.\n- `DEFAULT`: Default subscription type.\n- `SUBSCRIBED`: Subscribed to notifications.\n- `UNSUBSCRIBED`: Not subscribed to notifications.", + "enum": [ + "ALL_EVENTS", + "DEFAULT", + "SUBSCRIBED", + "UNSUBSCRIBED" + ], + "enum_launch_stages": { + "ALL_EVENTS": "GA", + "DEFAULT": "GA", + "SUBSCRIBED": "GA", + "UNSUBSCRIBED": "GA" + }, + "enum_descriptions": { + "ALL_EVENTS": "Subscribed to all events.", + "DEFAULT": "Default subscription type.", + "SUBSCRIBED": "Subscribed to notifications.", + "UNSUBSCRIBED": "Not subscribed to notifications." + } + }, + "ml.RegistryWebhook": { + "fields": { + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "description": { + "description": "User-specified description for the webhook.", + "launch_stage": "GA" + }, + "events": { + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "launch_stage": "GA" + }, + "http_url_spec": { + "ref": "ml.HttpUrlSpecWithoutSecret", + "launch_stage": "GA" + }, + "id": { + "description": "Webhook ID", + "launch_stage": "GA" + }, + "job_spec": { + "ref": "ml.JobSpecWithoutSecret", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Time of the object at last update, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "model_name": { + "description": "Name of the model whose events would trigger this webhook.", + "launch_stage": "GA" + }, + "status": { + "ref": "ml.RegistryWebhookStatus", + "launch_stage": "GA" + } + } + }, + "ml.RegistryWebhookEvent": { + "enum": [ + "MODEL_VERSION_CREATED", + "MODEL_VERSION_TRANSITIONED_STAGE", + "TRANSITION_REQUEST_CREATED", + "COMMENT_CREATED", + "REGISTERED_MODEL_CREATED", + "MODEL_VERSION_TAG_SET", + "MODEL_VERSION_TRANSITIONED_TO_STAGING", + "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION", + "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED", + "TRANSITION_REQUEST_TO_STAGING_CREATED", + "TRANSITION_REQUEST_TO_PRODUCTION_CREATED", + "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + ], + "enum_launch_stages": { + "COMMENT_CREATED": "GA", + "MODEL_VERSION_CREATED": "GA", + "MODEL_VERSION_TAG_SET": "GA", + "MODEL_VERSION_TRANSITIONED_STAGE": "GA", + "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED": "GA", + "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION": "GA", + "MODEL_VERSION_TRANSITIONED_TO_STAGING": "GA", + "REGISTERED_MODEL_CREATED": "GA", + "TRANSITION_REQUEST_CREATED": "GA", + "TRANSITION_REQUEST_TO_ARCHIVED_CREATED": "GA", + "TRANSITION_REQUEST_TO_PRODUCTION_CREATED": "GA", + "TRANSITION_REQUEST_TO_STAGING_CREATED": "GA" + } + }, + "ml.RegistryWebhookStatus": { + "description": "Enable or disable triggering the webhook, or put the webhook into test mode. The default is `ACTIVE`:\n* `ACTIVE`: Webhook is triggered when an associated event happens.\n\n* `DISABLED`: Webhook is not triggered.\n\n* `TEST_MODE`: Webhook can be triggered through the test endpoint, but is not triggered on a real event.", + "enum": [ + "ACTIVE", + "DISABLED", + "TEST_MODE" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "DISABLED": "GA", + "TEST_MODE": "GA" + }, + "enum_descriptions": { + "ACTIVE": "Webhook is triggered when an associated event happens.", + "DISABLED": "Webhook is not triggered.", + "TEST_MODE": "Webhook can be triggered through the test endpoint, but is not triggered on a real event." + } + }, + "ml.RejectTransitionRequest": { + "description": "Details required to identify and reject a model version stage transition request.", + "fields": { + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "stage": { + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.RejectTransitionRequestResponse": { + "fields": { + "activity": { + "description": "New activity generated as a result of this operation.", + "ref": "ml.Activity", + "launch_stage": "GA" + } + } + }, + "ml.RenameModelRequest": { + "fields": { + "name": { + "description": "Registered model unique name identifier.", + "launch_stage": "GA" + }, + "new_name": { + "description": "If provided, updates the name for this `registered_model`.", + "launch_stage": "GA" + } + } + }, + "ml.RenameModelResponse": { + "fields": { + "registered_model": { + "ref": "ml.Model", + "launch_stage": "GA" + } + } + }, + "ml.RequestSource": { + "description": "A request-time data source whose value is provided at inference time: offline batch scoring or online serving endpoint", + "fields": { + "flat_schema": { + "description": "A flat schema with scalar-typed fields only.", + "ref": "ml.FlatSchema", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.RestoreExperiment": { + "fields": { + "experiment_id": { + "description": "ID of the associated experiment.", + "launch_stage": "GA" + } + } + }, + "ml.RestoreExperimentResponse": {}, + "ml.RestoreRun": { + "fields": { + "run_id": { + "description": "ID of the run to restore.", + "launch_stage": "GA" + } + } + }, + "ml.RestoreRunResponse": {}, + "ml.RestoreRuns": { + "fields": { + "experiment_id": { + "description": "The ID of the experiment containing the runs to restore.", + "launch_stage": "GA" + }, + "max_runs": { + "description": "An optional positive integer indicating the maximum number of runs to restore. The maximum allowed value for\nmax_runs is 10000.", + "launch_stage": "GA" + }, + "min_timestamp_millis": { + "description": "The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.", + "launch_stage": "GA" + } + } + }, + "ml.RestoreRunsResponse": { + "fields": { + "runs_restored": { + "description": "The number of runs restored.", + "launch_stage": "GA" + } + } + }, + "ml.RollingWindow": { + "description": "A rolling time window with an optional delay. This is the SQL-spec-aligned\nreplacement for ContinuousWindow: `delay` is the non-negative counterpart\nof the legacy non-positive `ContinuousWindow.offset`.", + "fields": { + "delay": { + "description": "The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "window_duration": { + "description": "The duration of the rolling window (must be positive).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.Run": { + "description": "A single run.", + "fields": { + "data": { + "description": "Run data.", + "ref": "ml.RunData", + "launch_stage": "GA" + }, + "info": { + "description": "Run metadata.", + "ref": "ml.RunInfo", + "launch_stage": "GA" + }, + "inputs": { + "description": "Run inputs.", + "ref": "ml.RunInputs", + "launch_stage": "GA" + } + } + }, + "ml.RunData": { + "description": "Run data (metrics, params, and tags).", + "fields": { + "metrics": { + "description": "Run metrics.", + "launch_stage": "GA" + }, + "params": { + "description": "Run parameters.", + "launch_stage": "GA" + }, + "tags": { + "description": "Additional metadata key-value pairs.", + "launch_stage": "GA" + } + } + }, + "ml.RunInfo": { + "description": "Metadata of a single run.", + "fields": { + "artifact_uri": { + "description": "URI of the directory where artifacts should be uploaded.\nThis can be a local path (starting with \"/\"), or a distributed file system (DFS)\npath, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.\nIf not set, the local ``./mlruns`` directory is chosen.", + "launch_stage": "GA" + }, + "end_time": { + "description": "Unix timestamp of when the run ended in milliseconds.", + "launch_stage": "GA" + }, + "experiment_id": { + "description": "The experiment ID.", + "launch_stage": "GA" + }, + "lifecycle_stage": { + "description": "Current life cycle stage of the experiment : OneOf(\"active\", \"deleted\")", + "launch_stage": "GA" + }, + "run_id": { + "description": "Unique identifier for the run.", + "launch_stage": "GA" + }, + "run_name": { + "description": "The name of the run.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use run_id instead] Unique identifier for the run. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + }, + "start_time": { + "description": "Unix timestamp of when the run started in milliseconds.", + "launch_stage": "GA" + }, + "status": { + "description": "Current status of the run.", + "ref": "ml.RunInfoStatus", + "launch_stage": "GA" + }, + "user_id": { + "description": "User who initiated the run.\nThis field is deprecated as of MLflow 1.0, and will be removed in a future\nMLflow release. Use 'mlflow.user' tag instead.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "ml.RunInfoStatus": { + "description": "Status of a run.", + "enum": [ + "RUNNING", + "SCHEDULED", + "FINISHED", + "FAILED", + "KILLED" + ], + "enum_launch_stages": { + "FAILED": "GA", + "FINISHED": "GA", + "KILLED": "GA", + "RUNNING": "GA", + "SCHEDULED": "GA" + } + }, + "ml.RunInputs": { + "description": "Run inputs.", + "fields": { + "dataset_inputs": { + "description": "Run metrics.", + "launch_stage": "GA" + }, + "model_inputs": { + "description": "Model inputs to the Run.", + "launch_stage": "GA" + } + } + }, + "ml.RunTag": { + "description": "Tag for a run.", + "fields": { + "key": { + "description": "The tag key.", + "launch_stage": "GA" + }, + "value": { + "description": "The tag value.", + "launch_stage": "GA" + } + } + }, + "ml.ScalarDataType": { + "description": "Scalar data types for request-time field definitions.\nOnly flat (non-nested) types are supported.", + "enum": [ + "INTEGER", + "FLOAT", + "BOOLEAN", + "STRING", + "DOUBLE", + "LONG", + "TIMESTAMP", + "DATE", + "SHORT", + "BINARY", + "DECIMAL" + ], + "enum_launch_stages": { + "BINARY": "PRIVATE_PREVIEW", + "BOOLEAN": "PRIVATE_PREVIEW", + "DATE": "PRIVATE_PREVIEW", + "DECIMAL": "PRIVATE_PREVIEW", + "DOUBLE": "PRIVATE_PREVIEW", + "FLOAT": "PRIVATE_PREVIEW", + "INTEGER": "PRIVATE_PREVIEW", + "LONG": "PRIVATE_PREVIEW", + "SHORT": "PRIVATE_PREVIEW", + "STRING": "PRIVATE_PREVIEW", + "TIMESTAMP": "PRIVATE_PREVIEW" + } + }, + "ml.SchemaConfig": { + "fields": { + "json_schema": { + "description": "Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.SearchExperiments": { + "fields": { + "filter": { + "description": "String representing a SQL filter condition (e.g. \"name ILIKE 'my-experiment%'\")", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of experiments desired. Max threshold is 3000.", + "launch_stage": "GA" + }, + "order_by": { + "description": "List of columns for ordering search results, which can include experiment name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by experiment id DESC.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token indicating the page of experiments to fetch", + "launch_stage": "GA" + }, + "view_type": { + "description": "Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments.", + "ref": "ml.ViewType", + "launch_stage": "GA" + } + } + }, + "ml.SearchExperimentsResponse": { + "fields": { + "experiments": { + "description": "Experiments that match the search criteria", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Token that can be used to retrieve the next page of experiments.\nAn empty token means that no more experiments are available for retrieval.", + "launch_stage": "GA" + } + } + }, + "ml.SearchLoggedModelsDataset": { + "fields": { + "dataset_digest": { + "description": "The digest of the dataset.", + "launch_stage": "GA" + }, + "dataset_name": { + "description": "The name of the dataset.", + "launch_stage": "GA" + } + } + }, + "ml.SearchLoggedModelsOrderBy": { + "fields": { + "ascending": { + "description": "Whether the search results order is ascending or not.", + "launch_stage": "GA" + }, + "dataset_digest": { + "description": "If ``field_name`` refers to a metric, this field specifies the digest of the dataset\nassociated with the metric. Only metrics associated with the specified dataset name\nand digest will be considered for ordering. This field may only be set if ``dataset_name``\nis also set.", + "launch_stage": "GA" + }, + "dataset_name": { + "description": "If ``field_name`` refers to a metric, this field specifies the name of the dataset\nassociated with the metric. Only metrics associated with the specified dataset name will be\nconsidered for ordering. This field may only be set if ``field_name`` refers to a metric.", + "launch_stage": "GA" + }, + "field_name": { + "description": "The name of the field to order by, e.g. \"metrics.accuracy\".", + "launch_stage": "GA" + } + } + }, + "ml.SearchLoggedModelsRequest": { + "fields": { + "datasets": { + "description": "List of datasets on which to apply the metrics filter clauses.\nFor example, a filter with `metrics.accuracy \u003e 0.9` and dataset info with name \"test_dataset\"\nmeans we will return all logged models with accuracy \u003e 0.9 on the test_dataset.\nMetric values from ANY dataset matching the criteria are considered.\nIf no datasets are specified, then metrics across all datasets are considered in the filter.", + "launch_stage": "GA" + }, + "experiment_ids": { + "description": "The IDs of the experiments in which to search for logged models.", + "launch_stage": "GA" + }, + "filter": { + "description": "A filter expression over logged model info and data that allows returning a subset of\nlogged models. The syntax is a subset of SQL that supports AND'ing together binary operations.\n\nExample: ``params.alpha \u003c 0.3 AND metrics.accuracy \u003e 0.9``.", + "launch_stage": "GA" + }, + "max_results": { + "description": "The maximum number of Logged Models to return. The maximum limit is 50.", + "launch_stage": "GA" + }, + "order_by": { + "description": "The list of columns for ordering the results, with additional fields for sorting criteria.", + "launch_stage": "GA" + }, + "page_token": { + "description": "The token indicating the page of logged models to fetch.", + "launch_stage": "GA" + } + } + }, + "ml.SearchLoggedModelsResponse": { + "fields": { + "models": { + "description": "Logged models that match the search criteria.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "The token that can be used to retrieve the next page of logged models.", + "launch_stage": "GA" + } + } + }, + "ml.SearchModelVersionsResponse": { + "fields": { + "model_versions": { + "description": "Models that match the search criteria", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "Pagination token to request next page of models for the same search query.", + "launch_stage": "GA" + } + } + }, + "ml.SearchModelsResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of models.", + "launch_stage": "GA" + }, + "registered_models": { + "description": "Registered Models that match the search criteria.", + "launch_stage": "GA" + } + } + }, + "ml.SearchRuns": { + "fields": { + "experiment_ids": { + "description": "List of experiment IDs to search over.", + "launch_stage": "GA" + }, + "filter": { + "description": "A filter expression over params, metrics, and tags, that allows returning a subset of\nruns. The syntax is a subset of SQL that supports ANDing together binary operations\nbetween a param, metric, or tag and a constant.\n\nExample: `metrics.rmse \u003c 1 and params.model_class = 'LogisticRegression'`\n\nYou can select columns with special characters (hyphen, space, period, etc.) by using double quotes:\n`metrics.\"model class\" = 'LinearRegression' and tags.\"user-name\" = 'Tomas'`\n\nSupported operators are `=`, `!=`, `\u003e`, `\u003e=`, `\u003c`, and `\u003c=`.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of runs desired. Max threshold is 50000", + "launch_stage": "GA" + }, + "order_by": { + "description": "List of columns to be ordered by, including attributes, params, metrics, and tags with an\noptional `\"DESC\"` or `\"ASC\"` annotation, where `\"ASC\"` is the default.\nExample: `[\"params.input DESC\", \"metrics.alpha ASC\", \"metrics.rmse\"]`.\nTiebreaks are done by start_time `DESC` followed by `run_id` for runs with the same start time\n(and this is the default ordering criterion if order_by is not provided).", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token for the current page of runs.", + "launch_stage": "GA" + }, + "run_view_type": { + "description": "Whether to display only active, only deleted, or all runs.\nDefaults to only active runs.", + "ref": "ml.ViewType", + "launch_stage": "GA" + } + } + }, + "ml.SearchRunsResponse": { + "fields": { + "next_page_token": { + "description": "Token for the next page of runs.", + "launch_stage": "GA" + }, + "runs": { + "description": "Runs that match the search criteria.", + "launch_stage": "GA" + } + } + }, + "ml.SecretScopeReference": { + "description": "Reference to an entry in a Databricks secret scope. The referenced value is fetched\non the Spark cluster at materialization time via dbutils.secrets.get(scope, key).", + "fields": { + "key": { + "description": "The key within the scope.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "scope": { + "description": "The Databricks secret scope name.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.SetExperimentTag": { + "fields": { + "experiment_id": { + "description": "ID of the experiment under which to log the tag. Must be provided.", + "launch_stage": "GA" + }, + "key": { + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "launch_stage": "GA" + }, + "value": { + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "launch_stage": "GA" + } + } + }, + "ml.SetExperimentTagResponse": {}, + "ml.SetLoggedModelTagsRequest": { + "fields": { + "tags": { + "description": "The tags to set on the logged model.", + "launch_stage": "GA" + } + } + }, + "ml.SetLoggedModelTagsResponse": {}, + "ml.SetModelTagRequest": { + "fields": { + "key": { + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "launch_stage": "GA" + }, + "name": { + "description": "Unique name of the model.", + "launch_stage": "GA" + }, + "value": { + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "launch_stage": "GA" + } + } + }, + "ml.SetModelTagResponse": {}, + "ml.SetModelVersionTagRequest": { + "fields": { + "key": { + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "launch_stage": "GA" + }, + "name": { + "description": "Unique name of the model.", + "launch_stage": "GA" + }, + "value": { + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number.", + "launch_stage": "GA" + } + } + }, + "ml.SetModelVersionTagResponse": {}, + "ml.SetTag": { + "fields": { + "key": { + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run under which to log the tag. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the tag. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + }, + "value": { + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "launch_stage": "GA" + } + } + }, + "ml.SetTagResponse": {}, + "ml.SlidingWindow": { + "fields": { + "slide_duration": { + "description": "The slide duration (interval by which windows advance, must be positive and less than duration).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "window_duration": { + "description": "The duration of the sliding window.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.StddevPopFunction": { + "description": "Computes the population standard deviation.", + "fields": { + "input": { + "description": "The input column from which the population standard deviation is computed. For Kafka sources,\nuse dot-prefixed path notation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.StddevSampFunction": { + "description": "Computes the sample standard deviation.", + "fields": { + "input": { + "description": "The input column from which the sample standard deviation is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.Stream": { + "description": "A Stream is a governed UC entity representing an external streaming data source.\nThe source_config oneof determines the streaming platform source (e.g. Kafka, Kinesis, etc.).", + "fields": { + "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the\nassociated object through the BROWSE privilege when include_browse is enabled in the request.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "connection_config": { + "description": "Specifies how to connect and authenticate to the stream platform.", + "ref": "ml.StreamConnectionConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "create_time": { + "description": "Time at which this Stream was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of the Stream creator.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "User-provided description.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "ingestion_config": { + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "ref": "ml.IngestionConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "name": { + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "schema_config": { + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "ref": "ml.StreamSchemaConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "source_config": { + "description": "Source-specific configuration. Determines the streaming platform source.", + "ref": "ml.StreamSourceConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "update_time": { + "description": "Time at which this Stream was last modified.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of user who last modified the Stream.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "ml.StreamConnectionConfig": { + "description": "Specifies how to connect and authenticate to the stream platform.", + "fields": { + "direct_mtls_config": { + "description": "Direct mTLS configuration for stream platform access. This is only used in the short term until UC Kafka Connections support mTLS (XTA-18030).\nOnce UC Kafka Connections support mTLS, this will be deprecated.", + "ref": "ml.DirectMtlsConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "uc_connection_name": { + "description": "Name of an existing UC Connection for stream platform access.\nMust be the correct type for the streaming platform (e.g. a Kafka Connection for a Kafka Stream).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.StreamSchemaConfig": { + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "fields": { + "direct_schemas": { + "description": "Schema definitions provided directly on the Stream.", + "ref": "ml.DirectSchemas", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.StreamSourceConfig": { + "description": "Source-specific configuration. Determines the streaming platform source.", + "fields": { + "kafka_stream_config": { + "description": "Configuration for Apache Kafka streams.", + "ref": "ml.KafkaStreamConfig", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.StreamingMode": { + "description": "The streaming mode configuration for a streaming materialization pipeline.", + "fields": { + "mode": { + "description": "The type of streaming mode used by the materialization pipeline.", + "ref": "ml.StreamingModeStreamingModeType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.StreamingModeStreamingModeType": { + "enum": [ + "STREAMING_MODE_TYPE_RTM", + "STREAMING_MODE_TYPE_MBM" + ], + "enum_launch_stages": { + "STREAMING_MODE_TYPE_MBM": "PRIVATE_PREVIEW", + "STREAMING_MODE_TYPE_RTM": "PRIVATE_PREVIEW" + } + }, + "ml.SubscriptionMode": { + "description": "Deprecated: Use KafkaSubscriptionMode instead.", + "fields": { + "assign": { + "description": "A JSON string that contains the specific topic-partitions to consume from.\nFor example, for '{\"topicA\":[0,1],\"topicB\":[2,4]}', topicA's 0'th and 1st partitions will be consumed from.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscribe": { + "description": "A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscribe_pattern": { + "description": "A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.SumFunction": { + "description": "Computes the sum of values.", + "fields": { + "input": { + "description": "The input column from which the sum is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.TableTrigger": { + "description": "A trigger that fires when the upstream source table changes." + }, + "ml.TestRegistryWebhookRequest": { + "description": "Details required to test a registry webhook.", + "fields": { + "event": { + "description": "If `event` is specified, the test trigger uses the specified event. If `event` is not specified, the test trigger uses a randomly chosen event associated with the webhook.", + "ref": "ml.RegistryWebhookEvent", + "launch_stage": "GA" + }, + "id": { + "description": "Webhook ID", + "launch_stage": "GA" + } + } + }, + "ml.TestRegistryWebhookResponse": { + "fields": { + "body": { + "description": "Body of the response from the webhook URL", + "launch_stage": "GA" + }, + "status_code": { + "description": "Status code returned by the webhook URL", + "launch_stage": "GA" + } + } + }, + "ml.TimeWindow": { + "fields": { + "continuous": { + "ref": "ml.ContinuousWindow", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "rolling": { + "ref": "ml.RollingWindow", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "sliding": { + "ref": "ml.SlidingWindow", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "tumbling": { + "ref": "ml.TumblingWindow", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.TimeseriesColumn": { + "fields": { + "name": { + "description": "The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \"event_timestamp\" from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.TransitionModelVersionStageDatabricks": { + "description": "Details required to transition a model version's stage.", + "fields": { + "archive_existing_versions": { + "description": "Specifies whether to archive all current model versions in the target stage.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "stage": { + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, + "ml.TransitionRequest": { + "description": "For activities, this contains the activity recorded for the action.\nFor comments, this contains the comment details.\nFor transition requests, this contains the transition request details.", + "fields": { + "available_actions": { + "description": "Array of actions on the activity allowed for the current viewer.", + "launch_stage": "GA" + }, + "comment": { + "description": "User-provided comment associated with the activity, comment, or transition request.", + "launch_stage": "GA" + }, + "creation_timestamp": { + "description": "Creation time of the object, as a Unix timestamp in milliseconds.", + "launch_stage": "GA" + }, + "to_stage": { + "description": "Target stage of the transition (if the activity is stage transition related). Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "user_id": { + "description": "The username of the user that created the object.", + "launch_stage": "GA" + } + } + }, + "ml.TransitionStageResponse": { + "fields": { + "model_version_databricks": { + "description": "Updated model version", + "ref": "ml.ModelVersionDatabricks", + "launch_stage": "GA" + } + } + }, + "ml.TumblingWindow": { + "fields": { + "window_duration": { + "description": "The duration of each tumbling window (non-overlapping, fixed-duration windows).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.UpdateComment": { + "description": "Details required to edit a comment on a model version.", + "fields": { + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "id": { + "description": "Unique identifier of an activity", + "launch_stage": "GA" + } + } + }, + "ml.UpdateCommentResponse": { + "fields": { + "comment": { + "description": "Updated comment object", + "ref": "ml.CommentObject", + "launch_stage": "GA" + } + } + }, + "ml.UpdateExperiment": { + "fields": { + "experiment_id": { + "description": "ID of the associated experiment.", + "launch_stage": "GA" + }, + "new_name": { + "description": "If provided, the experiment's name is changed to the new name. The new name must be unique.", + "launch_stage": "GA" + } + } + }, + "ml.UpdateExperimentResponse": {}, + "ml.UpdateModelRequest": { + "fields": { + "description": { + "description": "If provided, updates the description for this `registered_model`.", + "launch_stage": "GA" + }, + "name": { + "description": "Registered model unique name identifier.", + "launch_stage": "GA" + } + } + }, + "ml.UpdateModelResponse": { + "fields": { + "registered_model": { + "ref": "ml.Model", + "launch_stage": "GA" + } + } + }, + "ml.UpdateModelVersionRequest": { + "fields": { + "description": { + "description": "If provided, updates the description for this `registered_model`.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the registered model", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number", + "launch_stage": "GA" + } + } + }, + "ml.UpdateModelVersionResponse": { + "fields": { + "model_version": { + "description": "Return new version number generated for this model in registry.", + "ref": "ml.ModelVersion", + "launch_stage": "GA" + } + } + }, + "ml.UpdateRegistryWebhook": { + "description": "Details required to update a registry webhook. Only the fields that need to be updated should be specified, and both `http_url_spec` and `job_spec` should not be specified in the same request.", + "fields": { + "description": { + "description": "User-specified description for the webhook.", + "launch_stage": "GA" + }, + "events": { + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "launch_stage": "GA" + }, + "http_url_spec": { + "ref": "ml.HttpUrlSpec", + "launch_stage": "GA" + }, + "id": { + "description": "Webhook ID", + "launch_stage": "GA" + }, + "job_spec": { + "ref": "ml.JobSpec", + "launch_stage": "GA" + }, + "status": { + "ref": "ml.RegistryWebhookStatus", + "launch_stage": "GA" + } + } + }, + "ml.UpdateRun": { + "fields": { + "end_time": { + "description": "Unix timestamp in milliseconds of when the run ended.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run to update. Must be provided.", + "launch_stage": "GA" + }, + "run_name": { + "description": "Updated name of the run.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run to update. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "description": "Updated status of the run.", + "ref": "ml.UpdateRunStatus", + "launch_stage": "GA" + } + } + }, + "ml.UpdateRunResponse": { + "fields": { + "run_info": { + "description": "Updated metadata of the run.", + "ref": "ml.RunInfo", + "launch_stage": "GA" + } + } + }, + "ml.UpdateRunStatus": { + "description": "Status of a run.", + "enum": [ + "RUNNING", + "SCHEDULED", + "FINISHED", + "FAILED", + "KILLED" + ], + "enum_launch_stages": { + "FAILED": "GA", + "FINISHED": "GA", + "KILLED": "GA", + "RUNNING": "GA", + "SCHEDULED": "GA" + } + }, + "ml.UpdateWebhookResponse": { + "fields": { + "webhook": { + "ref": "ml.RegistryWebhook", + "launch_stage": "GA" + } + } + }, + "ml.VarPopFunction": { + "description": "Computes the population variance.", + "fields": { + "input": { + "description": "The input column from which the population variance is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.VarSampFunction": { + "description": "Computes the sample variance.", + "fields": { + "input": { + "description": "The input column from which the sample variance is computed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "ml.ViewType": { + "description": "Qualifier for the view type.", + "enum": [ + "ACTIVE_ONLY", + "DELETED_ONLY", + "ALL" + ], + "enum_launch_stages": { + "ACTIVE_ONLY": "GA", + "ALL": "GA", + "DELETED_ONLY": "GA" + } + }, + "ml.status": { + "description": "The status of the model version. Valid values are:\n* `PENDING_REGISTRATION`: Request to register a new model version is pending as server performs background tasks.\n\n* `FAILED_REGISTRATION`: Request to register a new model version has failed.\n\n* `READY`: Model version is ready for use.", + "enum": [ + "PENDING_REGISTRATION", + "FAILED_REGISTRATION", + "READY" + ], + "enum_launch_stages": { + "FAILED_REGISTRATION": "GA", + "PENDING_REGISTRATION": "GA", + "READY": "GA" + }, + "enum_descriptions": { + "FAILED_REGISTRATION": "Request to register a new model version has failed.", + "PENDING_REGISTRATION": "Request to register a new model version is pending as server performs background tasks.", + "READY": "Model version is ready for use." + } + }, + "networking.AzurePrivateEndpointInfo": { + "fields": { + "private_endpoint_name": { + "description": "The name of the Private Endpoint in the Azure subscription.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "private_endpoint_resource_guid": { + "description": "The GUID of the Private Endpoint resource in the Azure subscription.\nThis is assigned by Azure when the user sets up the Private Endpoint.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "private_endpoint_resource_id": { + "description": "The full resource ID of the Private Endpoint.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "private_link_service_id": { + "description": "The resource ID of the Databricks Private Link Service that this Private Endpoint connects to.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "networking.Endpoint": { + "description": "Endpoint represents a cloud networking resource in a user's cloud account and binds it to the Databricks account.", + "fields": { + "account_id": { + "description": "The Databricks Account in which the endpoint object exists.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "azure_private_endpoint_info": { + "description": "Info for an Azure private endpoint.", + "ref": "networking.AzurePrivateEndpointInfo", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + }, + "create_time": { + "description": "The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "display_name": { + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "endpoint_id": { + "description": "The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "name": { + "description": "The resource name of the endpoint, which uniquely identifies the endpoint.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "region": { + "description": "The cloud provider region where this endpoint is located.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "state": { + "description": "The state of the endpoint. The endpoint can only be used if the state is `APPROVED`.", + "ref": "networking.EndpointState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "use_case": { + "description": "The use case that determines the type of network connectivity this endpoint provides.\nThis field is automatically determined based on the endpoint configuration and cloud-specific settings.", + "ref": "networking.EndpointUseCase", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + } + } + }, + "networking.EndpointState": { + "enum": [ + "PENDING", + "APPROVED", + "FAILED", + "DISCONNECTED" + ], + "enum_launch_stages": { + "APPROVED": "PUBLIC_PREVIEW", + "DISCONNECTED": "PUBLIC_PREVIEW", + "FAILED": "PUBLIC_PREVIEW", + "PENDING": "PUBLIC_PREVIEW" + } + }, + "networking.EndpointUseCase": { + "enum": [ + "SERVICE_DIRECT" + ], + "enum_launch_stages": { + "SERVICE_DIRECT": "PUBLIC_PREVIEW" + } + }, + "networking.ListEndpointsResponse": { + "fields": { + "items": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "oauth2.CreateCustomAppIntegration": { + "fields": { + "confidential": { + "description": "This field indicates whether an OAuth client secret is required to authenticate this client.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the custom OAuth app", + "launch_stage": "GA" + }, + "redirect_urls": { + "description": "List of OAuth redirect urls", + "launch_stage": "GA" + }, + "scopes": { + "description": "OAuth scopes granted to the application.\nSupported scopes: all-apis, sql, offline_access, openid, profile, email.", + "launch_stage": "GA" + }, + "token_access_policy": { + "description": "Token access policy", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + }, + "user_authorized_scopes": { + "description": "Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.", + "launch_stage": "GA" + } + } + }, + "oauth2.CreateCustomAppIntegrationOutput": { + "fields": { + "client_id": { + "description": "OAuth client-id generated by the Databricks", + "launch_stage": "GA" + }, + "client_secret": { + "description": "OAuth client-secret generated by the Databricks.\nIf this is a confidential OAuth app client-secret will be generated.", + "launch_stage": "GA" + }, + "integration_id": { + "description": "Unique integration id for the custom OAuth app", + "launch_stage": "GA" + } + } + }, + "oauth2.CreatePublishedAppIntegration": { + "fields": { + "app_id": { + "description": "App id of the OAuth published app integration.\nFor example power-bi, tableau-deskop", + "launch_stage": "GA" + }, + "token_access_policy": { + "description": "Token access policy", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + } + } + }, + "oauth2.CreatePublishedAppIntegrationOutput": { + "fields": { + "integration_id": { + "description": "Unique integration id for the published OAuth app", + "launch_stage": "GA" + } + } + }, + "oauth2.CreateServicePrincipalSecretRequest": { + "fields": { + "lifetime": { + "description": "The lifetime of the secret in seconds. If this parameter is not provided, the secret will have a default lifetime of 730 days (63072000s).", + "launch_stage": "GA" + } + } + }, + "oauth2.CreateServicePrincipalSecretResponse": { + "fields": { + "create_time": { + "description": "UTC time when the secret was created", + "launch_stage": "GA" + }, + "expire_time": { + "description": "UTC time when the secret will expire. If the field is not present, the secret does not expire.", + "launch_stage": "GA" + }, + "id": { + "description": "ID of the secret", + "launch_stage": "GA" + }, + "secret": { + "description": "Secret Value", + "launch_stage": "GA" + }, + "secret_hash": { + "description": "Secret Hash", + "launch_stage": "GA" + }, + "status": { + "description": "Status of the secret", + "launch_stage": "GA" + }, + "update_time": { + "description": "UTC time when the secret was updated", + "launch_stage": "GA" + } + } + }, + "oauth2.DeleteCustomAppIntegrationOutput": {}, + "oauth2.DeletePublishedAppIntegrationOutput": {}, + "oauth2.FederationPolicy": { + "fields": { + "create_time": { + "description": "Creation time of the federation policy.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "description": { + "description": "Description of the federation policy.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "oidc_policy": { + "ref": "oauth2.OidcFederationPolicy", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy_id": { + "description": "The ID of the federation policy. Output only.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL", + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "service_principal_id": { + "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL", + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "uid": { + "description": "Unique, immutable id of the federation policy.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "update_time": { + "description": "Last update time of the federation policy.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "oauth2.GetCustomAppIntegrationOutput": { + "fields": { + "client_id": { + "description": "The client id of the custom OAuth app", + "launch_stage": "GA" + }, + "confidential": { + "description": "This field indicates whether an OAuth client secret is required to authenticate this client.", + "launch_stage": "GA" + }, + "create_time": { + "launch_stage": "GA" + }, + "created_by": { + "launch_stage": "GA" + }, + "creator_username": { + "launch_stage": "GA" + }, + "integration_id": { + "description": "ID of this custom app", + "launch_stage": "GA" + }, + "name": { + "description": "The display name of the custom OAuth app", + "launch_stage": "GA" + }, + "redirect_urls": { + "description": "List of OAuth redirect urls", + "launch_stage": "GA" + }, + "scopes": { + "launch_stage": "GA" + }, + "token_access_policy": { + "description": "Token access policy", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + }, + "user_authorized_scopes": { + "description": "Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.", + "launch_stage": "GA" + } + } + }, + "oauth2.GetCustomAppIntegrationsOutput": { + "fields": { + "apps": { + "description": "List of Custom OAuth App Integrations defined for the account.", + "launch_stage": "GA" + }, + "next_page_token": { + "launch_stage": "GA" + } + } + }, + "oauth2.GetPublishedAppIntegrationOutput": { + "fields": { + "app_id": { + "description": "App-id of the published app integration", + "launch_stage": "GA" + }, + "create_time": { + "launch_stage": "GA" + }, + "created_by": { + "launch_stage": "GA" + }, + "integration_id": { + "description": "Unique integration id for the published OAuth app", + "launch_stage": "GA" + }, + "name": { + "description": "Display name of the published OAuth app", + "launch_stage": "GA" + }, + "token_access_policy": { + "description": "Token access policy", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + } + } + }, + "oauth2.GetPublishedAppIntegrationsOutput": { + "fields": { + "apps": { + "description": "List of Published OAuth App Integrations defined for the account.", + "launch_stage": "GA" + }, + "next_page_token": { + "launch_stage": "GA" + } + } + }, + "oauth2.GetPublishedAppsOutput": { + "fields": { + "apps": { + "description": "List of Published OAuth Apps.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "oauth2.ListFederationPoliciesResponse": { + "fields": { + "next_page_token": { + "launch_stage": "GA" + }, + "policies": { + "launch_stage": "GA" + } + } + }, + "oauth2.ListServicePrincipalSecretsResponse": { + "fields": { + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.", + "launch_stage": "GA" + }, + "secrets": { + "description": "List of the secrets", + "launch_stage": "GA" + } + } + }, + "oauth2.OidcFederationPolicy": { + "description": "Specifies the policy to use for validating OIDC claims in your federated tokens.", + "fields": { + "audiences": { + "description": "The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "issuer": { + "description": "The required token issuer, as specified in the 'iss' claim of federated tokens.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "jwks_json": { + "description": "The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If jwks_uri and jwks_json\nare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "jwks_uri": { + "description": "URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If jwks_uri\nand jwks_json are both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "subject": { + "description": "The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "subject_claim": { + "description": "The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "oauth2.PublishedAppOutput": { + "fields": { + "app_id": { + "description": "Unique ID of the published OAuth app.", + "launch_stage": "GA" + }, + "client_id": { + "description": "Client ID of the published OAuth app. It is the client_id in the OAuth flow", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the published OAuth app.", + "launch_stage": "GA" + }, + "is_confidential_client": { + "description": "Whether the published OAuth app is a confidential client. It is always false for published OAuth apps.", + "launch_stage": "GA" + }, + "name": { + "description": "The display name of the published OAuth app.", + "launch_stage": "GA" + }, + "redirect_urls": { + "description": "Redirect URLs of the published OAuth app.", + "launch_stage": "GA" + }, + "scopes": { + "description": "Required scopes for the published OAuth app.", + "launch_stage": "GA" + } + } + }, + "oauth2.SecretInfo": { + "fields": { + "create_time": { + "description": "UTC time when the secret was created", + "launch_stage": "GA" + }, + "expire_time": { + "description": "UTC time when the secret will expire. If the field is not present, the secret does not expire.", + "launch_stage": "GA" + }, + "id": { + "description": "ID of the secret", + "launch_stage": "GA" + }, + "secret_hash": { + "description": "Secret Hash", + "launch_stage": "GA" + }, + "status": { + "description": "Status of the secret", + "launch_stage": "GA" + }, + "update_time": { + "description": "UTC time when the secret was updated", + "launch_stage": "GA" + } + } + }, + "oauth2.TokenAccessPolicy": { + "fields": { + "absolute_session_lifetime_in_minutes": { + "description": "Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature is enabled.\nThis is the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is issued\nduring refresh token rotation, it will inherit the same absolute TTL as the old refresh token.\nIn other words, this represents the maximum amount of time a user can stay logged in without re-authenticating.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "access_token_ttl_in_minutes": { + "description": "access token time to live in minutes", + "launch_stage": "GA" + }, + "enable_single_use_refresh_tokens": { + "description": "Whether to enable single-use refresh tokens (refresh token rotation).\nIf this feature is enabled, upon successfully getting a new access token using a refresh token, Databricks will\nissue a new refresh token along with the access token in the response and invalidate the old refresh token.\nThe client should use the new refresh token to get access tokens in future requests.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "refresh_token_ttl_in_minutes": { + "description": "Refresh token time to live in minutes.\nWhen single-use refresh tokens are enabled, this represents the TTL of an individual refresh token.\nIf the refresh token is used before it expires, a new one is issued with a renewed individual TTL.", + "launch_stage": "GA" + } + } + }, + "oauth2.UpdateCustomAppIntegration": { + "fields": { + "redirect_urls": { + "description": "List of OAuth redirect urls to be updated in the custom OAuth app integration", + "launch_stage": "GA" + }, + "scopes": { + "description": "List of OAuth scopes to be updated in the custom OAuth app integration, similar to redirect URIs this will fully\nreplace the existing values instead of appending", + "launch_stage": "GA" + }, + "token_access_policy": { + "description": "Token access policy to be updated in the custom OAuth app integration", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + }, + "user_authorized_scopes": { + "description": "Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.", + "launch_stage": "GA" + } + } + }, + "oauth2.UpdateCustomAppIntegrationOutput": {}, + "oauth2.UpdatePublishedAppIntegration": { + "fields": { + "token_access_policy": { + "description": "Token access policy to be updated in the published OAuth app integration", + "ref": "oauth2.TokenAccessPolicy", + "launch_stage": "GA" + } + } + }, + "oauth2.UpdatePublishedAppIntegrationOutput": {}, + "pipelines.ApplyEnvironmentRequestResponse": {}, + "pipelines.AutoFullRefreshPolicy": { + "description": "Policy for auto full refresh.", + "fields": { + "enabled": { + "description": "(Required, Mutable) Whether to enable auto full refresh or not.", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.CloneMode": { + "description": "Enum to specify which mode of clone to execute", + "enum": [ + "MIGRATE_TO_UC" + ], + "enum_launch_stages": { + "MIGRATE_TO_UC": "GA" + } + }, + "pipelines.ClonePipelineRequest": { + "fields": { + "allow_duplicate_names": { + "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "Budget policy of this pipeline.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "channel": { + "description": "SDP Release Channel that specifies which version to use.", + "launch_stage": "GA" + }, + "clone_mode": { + "description": "The type of clone to perform. Currently, only deep copies are supported", + "ref": "pipelines.CloneMode", + "launch_stage": "GA" + }, + "clusters": { + "description": "Cluster settings for this pipeline deployment.", + "launch_stage": "GA" + }, + "configuration": { + "description": "String-String configuration for this pipeline execution.", + "launch_stage": "GA" + }, + "continuous": { + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment type of this pipeline.", + "ref": "pipelines.PipelineDeployment", + "launch_stage": "GA" + }, + "development": { + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "launch_stage": "GA" + }, + "edition": { + "description": "Pipeline product edition.", + "launch_stage": "GA" + }, + "environment": { + "description": "Environment specification for this pipeline used to install dependencies.", + "ref": "pipelines.PipelinesEnvironment", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_log": { + "description": "Event log configuration for this pipeline", + "ref": "pipelines.EventLogSpec", + "launch_stage": "GA" + }, + "expected_last_modified": { + "description": "If present, the last-modified time of the pipeline settings before the clone.\nIf the settings were modified after that time, then the request will fail with\na conflict.", + "launch_stage": "GA" + }, + "filters": { + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "ref": "pipelines.Filters", + "launch_stage": "GA" + }, + "gateway_definition": { + "description": "The definition of a gateway pipeline to support change data capture.", + "ref": "pipelines.IngestionGatewayPipelineDefinition", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "description": "Unique identifier for this pipeline.", + "launch_stage": "GA" + }, + "ingestion_definition": { + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "ref": "pipelines.IngestionPipelineDefinition", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "libraries": { + "description": "Libraries or code needed by this deployment.", + "launch_stage": "GA" + }, + "name": { + "description": "Friendly identifier for this pipeline.", + "launch_stage": "GA" + }, + "notifications": { + "description": "List of notification settings for this pipeline.", + "launch_stage": "GA" + }, + "photon": { + "description": "Whether Photon is enabled for this pipeline.", + "launch_stage": "GA" + }, + "restart_window": { + "description": "Restart window of this pipeline.", + "ref": "pipelines.RestartWindow", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema": { + "description": "The default schema (database) where tables are read from or published to.", + "launch_stage": "GA" + }, + "serverless": { + "description": "Whether serverless compute is enabled for this pipeline.", + "launch_stage": "GA" + }, + "storage": { + "description": "DBFS root directory for storing checkpoints and tables.", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "launch_stage": "GA" + }, + "target": { + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "trigger": { + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "ref": "pipelines.PipelineTrigger", + "deprecated": true, + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "Usage policy of this pipeline.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.ClonePipelineResponse": { + "fields": { + "pipeline_id": { + "description": "The pipeline id of the cloned pipeline", + "launch_stage": "GA" + } + } + }, + "pipelines.ConfluenceConnectorOptions": { + "description": "Confluence specific options for ingestion", + "fields": { + "include_confluence_spaces": { + "description": "(Optional) Spaces to filter Confluence data on", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.ConnectionParameters": { + "fields": { + "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.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.ConnectorOptions": { + "description": "Wrapper message for source-specific options to support multiple connector types", + "fields": { + "confluence_options": { + "ref": "pipelines.ConfluenceConnectorOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "gdrive_options": { + "ref": "pipelines.GoogleDriveOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "google_ads_options": { + "ref": "pipelines.GoogleAdsOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "jira_options": { + "ref": "pipelines.JiraConnectorOptions", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "kafka_options": { + "ref": "pipelines.KafkaOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "meta_ads_options": { + "ref": "pipelines.MetaMarketingOptions", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "outlook_options": { + "ref": "pipelines.OutlookOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "sharepoint_options": { + "ref": "pipelines.SharepointOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "smartsheet_options": { + "ref": "pipelines.SmartsheetOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "tiktok_ads_options": { + "ref": "pipelines.TikTokAdsOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "zendesk_support_options": { + "ref": "pipelines.ZendeskSupportOptions", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.ConnectorType": { + "description": "For certain database sources LakeFlow Connect offers both query based and cdc\ningestion, ConnectorType can bse used to convey the type of ingestion.\nIf connection_name is provided for database sources, we default to Query Based ingestion", + "enum": [ + "CDC", + "QUERY_BASED" + ], + "enum_launch_stages": { + "CDC": "PUBLIC_BETA", + "QUERY_BASED": "PUBLIC_BETA" + } + }, + "pipelines.CreatePipeline": { + "fields": { + "allow_duplicate_names": { + "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "Budget policy of this pipeline.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "channel": { + "description": "SDP Release Channel that specifies which version to use.", + "launch_stage": "GA" + }, + "clusters": { + "description": "Cluster settings for this pipeline deployment.", + "launch_stage": "GA" + }, + "configuration": { + "description": "String-String configuration for this pipeline execution.", + "launch_stage": "GA" + }, + "continuous": { + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment type of this pipeline.", + "ref": "pipelines.PipelineDeployment", + "launch_stage": "GA" + }, + "development": { + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "launch_stage": "GA" + }, + "dry_run": { + "launch_stage": "GA" + }, + "edition": { + "description": "Pipeline product edition.", + "launch_stage": "GA" + }, + "environment": { + "description": "Environment specification for this pipeline used to install dependencies.", + "ref": "pipelines.PipelinesEnvironment", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_log": { + "description": "Event log configuration for this pipeline", + "ref": "pipelines.EventLogSpec", + "launch_stage": "GA" + }, + "filters": { + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "ref": "pipelines.Filters", + "launch_stage": "GA" + }, + "gateway_definition": { + "description": "The definition of a gateway pipeline to support change data capture.", + "ref": "pipelines.IngestionGatewayPipelineDefinition", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "description": "Unique identifier for this pipeline.", + "launch_stage": "GA" + }, + "ingestion_definition": { + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "ref": "pipelines.IngestionPipelineDefinition", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "libraries": { + "description": "Libraries or code needed by this deployment.", + "launch_stage": "GA" + }, + "name": { + "description": "Friendly identifier for this pipeline.", + "launch_stage": "GA" + }, + "notifications": { + "description": "List of notification settings for this pipeline.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "photon": { + "description": "Whether Photon is enabled for this pipeline.", + "launch_stage": "GA" + }, + "restart_window": { + "description": "Restart window of this pipeline.", + "ref": "pipelines.RestartWindow", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "run_as": { + "ref": "pipelines.RunAs", + "launch_stage": "GA" + }, + "schema": { + "description": "The default schema (database) where tables are read from or published to.", + "launch_stage": "GA" + }, + "serverless": { + "description": "Whether serverless compute is enabled for this pipeline.", + "launch_stage": "GA" + }, + "storage": { + "description": "DBFS root directory for storing checkpoints and tables.", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "launch_stage": "GA" + }, + "target": { + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "trigger": { + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "ref": "pipelines.PipelineTrigger", + "deprecated": true, + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "Usage policy of this pipeline.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.CreatePipelineResponse": { + "fields": { + "effective_settings": { + "description": "Only returned when dry_run is true.", + "ref": "pipelines.PipelineSpec", + "launch_stage": "GA" + }, + "pipeline_id": { + "description": "The unique identifier for the newly created pipeline. Only returned when dry_run is false.", + "launch_stage": "GA" + } + } + }, + "pipelines.CronTrigger": { + "fields": { + "quartz_cron_schedule": { + "launch_stage": "GA" + }, + "timezone_id": { + "launch_stage": "GA" + } + } + }, + "pipelines.DataPlaneId": { + "fields": { + "instance": { + "description": "The instance name of the data plane emitting an event.", + "launch_stage": "GA" + }, + "seq_no": { + "description": "A sequence number, unique and increasing within the data plane instance.", + "launch_stage": "GA" + } + } + }, + "pipelines.DataStagingOptions": { + "description": "Location of staged data storage", + "fields": { + "catalog_name": { + "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", + "launch_stage": "PUBLIC_BETA" + }, + "schema_name": { + "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "launch_stage": "PUBLIC_BETA" + }, + "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", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "pipelines.DayOfWeek": { + "description": "Days of week in which the window is allowed to happen.\nIf not specified all days of the week will be used.", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enum_launch_stages": { + "FRIDAY": "PUBLIC_PREVIEW", + "MONDAY": "PUBLIC_PREVIEW", + "SATURDAY": "PUBLIC_PREVIEW", + "SUNDAY": "PUBLIC_PREVIEW", + "THURSDAY": "PUBLIC_PREVIEW", + "TUESDAY": "PUBLIC_PREVIEW", + "WEDNESDAY": "PUBLIC_PREVIEW" + } + }, + "pipelines.DeletePipelineResponse": {}, + "pipelines.DeploymentKind": { + "description": "The deployment method that manages the pipeline:\n- BUNDLE: The pipeline is managed by a Databricks Asset Bundle.", + "enum": [ + "BUNDLE" + ], + "enum_launch_stages": { + "BUNDLE": "GA" + } + }, + "pipelines.EditPipeline": { + "fields": { + "allow_duplicate_names": { + "description": "If false, deployment will fail if name has changed and conflicts the name of another pipeline.", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "Budget policy of this pipeline.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "channel": { + "description": "SDP Release Channel that specifies which version to use.", + "launch_stage": "GA" + }, + "clusters": { + "description": "Cluster settings for this pipeline deployment.", + "launch_stage": "GA" + }, + "configuration": { + "description": "String-String configuration for this pipeline execution.", + "launch_stage": "GA" + }, + "continuous": { + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment type of this pipeline.", + "ref": "pipelines.PipelineDeployment", + "launch_stage": "GA" + }, + "development": { + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "launch_stage": "GA" + }, + "edition": { + "description": "Pipeline product edition.", + "launch_stage": "GA" + }, + "environment": { + "description": "Environment specification for this pipeline used to install dependencies.", + "ref": "pipelines.PipelinesEnvironment", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_log": { + "description": "Event log configuration for this pipeline", + "ref": "pipelines.EventLogSpec", + "launch_stage": "GA" + }, + "expected_last_modified": { + "description": "If present, the last-modified time of the pipeline settings before the edit.\nIf the settings were modified after that time, then the request will fail with\na conflict.", + "launch_stage": "GA" + }, + "filters": { + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "ref": "pipelines.Filters", + "launch_stage": "GA" + }, + "gateway_definition": { + "description": "The definition of a gateway pipeline to support change data capture.", + "ref": "pipelines.IngestionGatewayPipelineDefinition", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "description": "Unique identifier for this pipeline.", + "launch_stage": "GA" + }, + "ingestion_definition": { + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "ref": "pipelines.IngestionPipelineDefinition", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "libraries": { + "description": "Libraries or code needed by this deployment.", + "launch_stage": "GA" + }, + "name": { + "description": "Friendly identifier for this pipeline.", + "launch_stage": "GA" + }, + "notifications": { + "description": "List of notification settings for this pipeline.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "photon": { + "description": "Whether Photon is enabled for this pipeline.", + "launch_stage": "GA" + }, + "restart_window": { + "description": "Restart window of this pipeline.", + "ref": "pipelines.RestartWindow", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "run_as": { + "ref": "pipelines.RunAs", + "launch_stage": "GA" + }, + "schema": { + "description": "The default schema (database) where tables are read from or published to.", + "launch_stage": "GA" + }, + "serverless": { + "description": "Whether serverless compute is enabled for this pipeline.", + "launch_stage": "GA" + }, + "storage": { + "description": "DBFS root directory for storing checkpoints and tables.", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "launch_stage": "GA" + }, + "target": { + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "trigger": { + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "ref": "pipelines.PipelineTrigger", + "deprecated": true, + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "Usage policy of this pipeline.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.EditPipelineResponse": {}, + "pipelines.ErrorDetail": { + "fields": { + "exceptions": { + "description": "The exception thrown for this error, with its chain of cause.", + "launch_stage": "GA" + }, + "fatal": { + "description": "Whether this error is considered fatal, that is, unrecoverable.", + "launch_stage": "GA" + } + } + }, + "pipelines.EventLevel": { + "description": "The severity level of the event.", + "enum": [ + "INFO", + "WARN", + "ERROR", + "METRICS" + ], + "enum_launch_stages": { + "ERROR": "GA", + "INFO": "GA", + "METRICS": "GA", + "WARN": "GA" + } + }, + "pipelines.EventLogSpec": { + "description": "Configurable event log parameters.", + "fields": { + "catalog": { + "description": "The UC catalog the event log is published under.", + "launch_stage": "GA" + }, + "name": { + "description": "The name the event log is published to in UC.", + "launch_stage": "GA" + }, + "schema": { + "description": "The UC schema the event log is published under.", + "launch_stage": "GA" + } + } + }, + "pipelines.FileFilter": { + "fields": { + "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", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.FileIngestionOptions": { + "fields": { + "corrupt_record_column": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "file_filters": { + "description": "Generic options", + "launch_stage": "PRIVATE_PREVIEW" + }, + "format": { + "description": "required for TableSpec", + "ref": "pipelines.FileIngestionOptionsFileFormat", + "launch_stage": "PRIVATE_PREVIEW" + }, + "format_options": { + "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "launch_stage": "PRIVATE_PREVIEW" + }, + "ignore_corrupt_files": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "infer_column_types": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "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", + "launch_stage": "PRIVATE_PREVIEW" + }, + "rescued_data_column": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "schema_evolution_mode": { + "ref": "pipelines.FileIngestionOptionsSchemaEvolutionMode", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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", + "launch_stage": "PRIVATE_PREVIEW" + }, + "single_variant_column": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.FileIngestionOptionsFileFormat": { + "enum": [ + "BINARYFILE", + "JSON", + "CSV", + "XML", + "EXCEL", + "PARQUET", + "AVRO", + "ORC" + ], + "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" + } + }, + "pipelines.FileIngestionOptionsSchemaEvolutionMode": { + "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "enum": [ + "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING", + "ADD_NEW_COLUMNS", + "RESCUE", + "FAIL_ON_NEW_COLUMNS", + "NONE" + ], + "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" + } + }, + "pipelines.FileLibrary": { + "fields": { + "path": { + "description": "The absolute path of the source code.", + "launch_stage": "GA" + } + } + }, + "pipelines.Filters": { + "fields": { + "exclude": { + "description": "Paths to exclude.", + "launch_stage": "GA" + }, + "include": { + "description": "Paths to include.", + "launch_stage": "GA" + } + } + }, + "pipelines.GetPipelinePermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "pipelines.GetPipelineResponse": { + "fields": { + "cause": { + "description": "An optional message detailing the cause of the pipeline state.", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "The ID of the cluster that the pipeline is running on.", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The username of the pipeline creator.", + "launch_stage": "GA" + }, + "effective_budget_policy_id": { + "description": "Serverless budget policy ID of this pipeline.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "effective_publishing_mode": { + "description": "Publishing mode of the pipeline", + "ref": "pipelines.PublishingMode", + "launch_stage": "GA" + }, + "health": { + "description": "The health of a pipeline.", + "ref": "pipelines.GetPipelineResponseHealth", + "launch_stage": "GA" + }, + "last_modified": { + "description": "The last time the pipeline settings were modified or created.", + "launch_stage": "GA" + }, + "latest_updates": { + "description": "Status of the latest updates for the pipeline. Ordered with the newest update first.", + "launch_stage": "GA" + }, + "name": { + "description": "A human friendly identifier for the pipeline, taken from the `spec`.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "pipeline_id": { + "description": "The ID of the pipeline.", + "launch_stage": "GA" + }, + "run_as": { + "description": "The user or service principal that the pipeline runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the pipeline.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", + "ref": "pipelines.RunAs", + "launch_stage": "GA" + }, + "run_as_user_name": { + "description": "Username of the user that the pipeline will run on behalf of.", + "launch_stage": "GA" + }, + "spec": { + "description": "The pipeline specification. This field is not returned when called by `ListPipelines`.", + "ref": "pipelines.PipelineSpec", + "launch_stage": "GA" + }, + "state": { + "description": "The pipeline state.", + "ref": "pipelines.PipelineState", + "launch_stage": "GA" + } + } + }, + "pipelines.GetPipelineResponseHealth": { + "description": "The health of a pipeline.", + "enum": [ + "HEALTHY", + "UNHEALTHY" + ], + "enum_launch_stages": { + "HEALTHY": "GA", + "UNHEALTHY": "GA" + } + }, + "pipelines.GetUpdateResponse": { + "fields": { + "update": { + "description": "The current update info.", + "ref": "pipelines.UpdateInfo", + "launch_stage": "GA" + } + } + }, + "pipelines.GoogleAdsConfig": { + "fields": { + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.GoogleAdsOptions": { + "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "fields": { + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.GoogleDriveOptions": { + "fields": { + "entity_type": { + "ref": "pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "launch_stage": "PRIVATE_PREVIEW" + }, + "file_ingestion_options": { + "ref": "pipelines.FileIngestionOptions", + "launch_stage": "PRIVATE_PREVIEW" + }, + "url": { + "description": "Google Drive URL.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.GoogleDriveOptionsGoogleDriveEntityType": { + "enum": [ + "FILE", + "FILE_METADATA", + "PERMISSION" + ], + "enum_launch_stages": { + "FILE": "PRIVATE_PREVIEW", + "FILE_METADATA": "PRIVATE_PREVIEW", + "PERMISSION": "PRIVATE_PREVIEW" + } + }, + "pipelines.IngestionConfig": { + "fields": { + "report": { + "description": "Select a specific source report.", + "ref": "pipelines.ReportSpec", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema": { + "description": "Select all tables from a specific source schema.", + "ref": "pipelines.SchemaSpec", + "launch_stage": "PUBLIC_PREVIEW" + }, + "table": { + "description": "Select a specific source table.", + "ref": "pipelines.TableSpec", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.IngestionGatewayPipelineDefinition": { + "fields": { + "connection_id": { + "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "connection_name": { + "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "connection_parameters": { + "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "ref": "pipelines.ConnectionParameters", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "gateway_storage_catalog": { + "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "gateway_storage_schema": { + "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.IngestionPipelineDefinition": { + "fields": { + "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.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "connector_type": { + "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "ref": "pipelines.ConnectorType", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "data_staging_options": { + "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "ref": "pipelines.DataStagingOptions", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "full_refresh_window": { + "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "ref": "pipelines.OperationTimeWindow", + "preview": "PUBLIC", + "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.", + "preview": "PUBLIC", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "netsuite_jar_path": { + "description": "Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "objects": { + "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_configurations": { + "description": "Top-level source configurations", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_type": { + "description": "The type of the foreign source.\nThe source type will be inferred from the source connection or ingestion gateway.\nThis field is output only and will be ignored if provided.", + "ref": "pipelines.IngestionSourceType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "table_configuration": { + "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", + "ref": "pipelines.TableSpecificConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig": { + "description": "Configurations that are only applicable for query-based ingestion connectors.", + "fields": { + "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.", + "preview": "PUBLIC", + "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.", + "preview": "PUBLIC", + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "pipelines.IngestionPipelineDefinitionWorkdayReportParameters": { + "fields": { + "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.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "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}", + "launch_stage": "PRIVATE_PREVIEW" + }, + "report_parameters": { + "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue": { + "fields": { + "key": { + "description": "Key for the report parameter, can be a column name or other metadata", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.IngestionSourceType": { + "enum": [ + "MYSQL", + "POSTGRESQL", + "SQLSERVER", + "SALESFORCE", + "BIGQUERY", + "NETSUITE", + "WORKDAY_RAAS", + "GA4_RAW_DATA", + "SERVICENOW", + "MANAGED_POSTGRESQL", + "ORACLE", + "TERADATA", + "SHAREPOINT", + "DYNAMICS365", + "GOOGLE_DRIVE", + "JIRA", + "CONFLUENCE", + "META_MARKETING", + "ZENDESK", + "FOREIGN_CATALOG" + ], + "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" + } + }, + "pipelines.JiraConnectorOptions": { + "description": "Jira specific options for ingestion", + "fields": { + "include_jira_spaces": { + "description": "(Optional) Projects to filter Jira data on", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "pipelines.JsonTransformerOptions": { + "fields": { + "as_variant": { + "description": "Parse the entire value as a single Variant column.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "schema": { + "description": "Inline schema string for JSON parsing (Spark DDL format).", + "launch_stage": "PRIVATE_PREVIEW" + }, + "schema_evolution_mode": { + "description": "(Optional) Schema evolution mode for schema inference.", + "ref": "pipelines.FileIngestionOptionsSchemaEvolutionMode", + "launch_stage": "PRIVATE_PREVIEW" + }, + "schema_file_path": { + "description": "Path to a schema file (.ddl).", + "launch_stage": "PRIVATE_PREVIEW" + }, + "schema_hints": { + "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.KafkaOptions": { + "fields": { + "client_config": { + "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "key_transformer": { + "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "ref": "pipelines.Transformer", + "launch_stage": "PRIVATE_PREVIEW" + }, + "max_offsets_per_trigger": { + "description": "Internal option to control the maximum number of offsets to process per trigger.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "starting_offset": { + "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "launch_stage": "PRIVATE_PREVIEW" + }, + "topic_pattern": { + "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "topics": { + "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "value_transformer": { + "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "ref": "pipelines.Transformer", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.ListPipelineEventsResponse": { + "fields": { + "events": { + "description": "The list of events matching the request criteria.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "If present, a token to fetch the next page of events.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "If present, a token to fetch the previous page of events.", + "launch_stage": "GA" + } + } + }, + "pipelines.ListPipelinesResponse": { + "fields": { + "next_page_token": { + "description": "If present, a token to fetch the next page of events.", + "launch_stage": "GA" + }, + "statuses": { + "description": "The list of events matching the request criteria.", + "launch_stage": "GA" + } + } + }, + "pipelines.ListUpdatesResponse": { + "fields": { + "next_page_token": { + "description": "If present, then there are more results, and this a token to be used in a subsequent request\nto fetch the next page.", + "launch_stage": "GA" + }, + "prev_page_token": { + "description": "If present, then this token can be used in a subsequent request to fetch the previous page.", + "launch_stage": "GA" + }, + "updates": { + "launch_stage": "GA" + } + } + }, + "pipelines.ManualTrigger": {}, + "pipelines.MaturityLevel": { + "description": "Maturity level for EventDetails.", + "enum": [ + "STABLE", + "EVOLVING", + "DEPRECATED" + ], + "enum_launch_stages": { + "DEPRECATED": "GA", + "EVOLVING": "GA", + "STABLE": "GA" + } + }, + "pipelines.MetaMarketingOptions": { + "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "fields": { + "action_attribution_windows": { + "description": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "launch_stage": "PUBLIC_BETA" + }, + "action_breakdowns": { + "description": "(Optional) Action breakdowns to configure for data aggregation", + "launch_stage": "PUBLIC_BETA" + }, + "action_report_time": { + "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "launch_stage": "PUBLIC_BETA" + }, + "breakdowns": { + "description": "(Optional) Breakdowns to configure for data aggregation", + "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.", + "launch_stage": "PUBLIC_BETA" + }, + "level": { + "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "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", + "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)", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "pipelines.NotebookLibrary": { + "fields": { + "path": { + "description": "The absolute path of the source code.", + "launch_stage": "GA" + } + } + }, + "pipelines.Notifications": { + "fields": { + "alerts": { + "description": "A list of alerts that trigger the sending of notifications to the configured\ndestinations. The supported alerts are:\n\n* `on-update-success`: A pipeline update completes successfully.\n* `on-update-failure`: Each time a pipeline update fails.\n* `on-update-fatal-failure`: A pipeline update fails with a non-retryable (fatal) error.\n* `on-flow-failure`: A single data flow fails.", + "launch_stage": "GA" + }, + "email_recipients": { + "description": "A list of email addresses notified when a configured alert is triggered.", + "launch_stage": "GA" + } + } + }, + "pipelines.OperationTimeWindow": { + "description": "Proto representing a window", + "fields": { + "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.", + "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.", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.Origin": { + "fields": { + "batch_id": { + "description": "The id of a batch. Unique within a flow.", + "launch_stage": "GA" + }, + "cloud": { + "description": "The cloud provider, e.g., AWS or Azure.", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "The id of the cluster where an execution happens. Unique within a region.", + "launch_stage": "GA" + }, + "dataset_name": { + "description": "The name of a dataset. Unique within a pipeline.", + "launch_stage": "GA" + }, + "flow_id": { + "description": "The id of the flow. Globally unique. Incremental queries will generally\nreuse the same id while complete queries will have a new id per update.", + "launch_stage": "GA" + }, + "flow_name": { + "description": "The name of the flow. Not unique.", + "launch_stage": "GA" + }, + "host": { + "description": "The optional host name where the event was triggered", + "launch_stage": "GA" + }, + "ingestion_source_catalog_name": { + "description": "The name of the source catalog name (if known) from whose data ingestion is described by this event.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "ingestion_source_connection_name": { + "description": "The name of the source UC connection (if known) from whose data ingestion is described by this event.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "ingestion_source_schema_name": { + "description": "The name of the source schema name (if known) from whose data ingestion is described by this event.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "ingestion_source_table_name": { + "description": "The name of the source table name (if known) from whose data ingestion is described by this event.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "ingestion_source_table_version": { + "description": "An optional implementation-defined source table version of a dataset being (re)ingested.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "maintenance_id": { + "description": "The id of a maintenance run. Globally unique.", + "launch_stage": "GA" + }, + "materialization_name": { + "description": "Materialization name.", + "launch_stage": "GA" + }, + "org_id": { + "description": "The org id of the user. Unique within a cloud.", + "launch_stage": "GA" + }, + "pipeline_id": { + "description": "The id of the pipeline. Globally unique.", + "launch_stage": "GA" + }, + "pipeline_name": { + "description": "The name of the pipeline. Not unique.", + "launch_stage": "GA" + }, + "region": { + "description": "The cloud region.", + "launch_stage": "GA" + }, + "request_id": { + "description": "The id of the request that caused an update.", + "launch_stage": "GA" + }, + "table_id": { + "description": "The id of a (delta) table. Globally unique.", + "launch_stage": "GA" + }, + "uc_resource_id": { + "description": "The Unity Catalog id of the MV or ST being updated.", + "launch_stage": "GA" + }, + "update_id": { + "description": "The id of an execution. Globally unique.", + "launch_stage": "GA" + } + } + }, + "pipelines.OutlookAttachmentMode": { + "description": "Attachment behavior mode for Outlook ingestion", + "enum": [ + "ALL", + "NON_INLINE_ONLY", + "INLINE_ONLY", + "NONE" + ], + "enum_launch_stages": { + "ALL": "PRIVATE_PREVIEW", + "INLINE_ONLY": "PRIVATE_PREVIEW", + "NONE": "PRIVATE_PREVIEW", + "NON_INLINE_ONLY": "PRIVATE_PREVIEW" + } + }, + "pipelines.OutlookBodyFormat": { + "description": "Body format for Outlook email content", + "enum": [ + "TEXT_HTML", + "TEXT_PLAIN" + ], + "enum_launch_stages": { + "TEXT_HTML": "PRIVATE_PREVIEW", + "TEXT_PLAIN": "PRIVATE_PREVIEW" + } + }, + "pipelines.OutlookOptions": { + "description": "Outlook specific options for ingestion", + "fields": { + "attachment_mode": { + "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "ref": "pipelines.OutlookAttachmentMode", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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": "pipelines.OutlookBodyFormat", + "launch_stage": "PRIVATE_PREVIEW" + }, + "folder_filter": { + "description": "Deprecated. Use include_folders instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "sender_filter": { + "description": "Deprecated. Use include_senders instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "subject_filter": { + "description": "Deprecated. Use include_subjects instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.PathPattern": { + "fields": { + "include": { + "description": "The source code to include for pipelines", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.PipelineAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "pipelines.PipelinePermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineCluster": { + "fields": { + "apply_policy_default_values": { + "description": "Note: This field won't be persisted. Only API users will check this field.", + "launch_stage": "GA" + }, + "autoscale": { + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "ref": "pipelines.PipelineClusterAutoscale", + "launch_stage": "GA" + }, + "aws_attributes": { + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AwsAttributes", + "launch_stage": "GA" + }, + "azure_attributes": { + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.AzureAttributes", + "launch_stage": "GA" + }, + "cluster_log_conf": { + "description": "The configuration for delivering spark logs to a long-term storage destination.\nOnly dbfs destinations are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "ref": "compute.ClusterLogConf", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "launch_stage": "GA" + }, + "driver_instance_pool_id": { + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "launch_stage": "GA" + }, + "driver_node_type_id": { + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.", + "launch_stage": "GA" + }, + "enable_local_disk_encryption": { + "description": "Whether to enable local disk encryption for the cluster.", + "launch_stage": "GA" + }, + "gcp_attributes": { + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "ref": "compute.GcpAttributes", + "launch_stage": "GA" + }, + "init_scripts": { + "description": "The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "launch_stage": "GA" + }, + "instance_pool_id": { + "description": "The optional ID of the instance pool to which the cluster belongs.", + "launch_stage": "GA" + }, + "label": { + "description": "A label for the cluster specification, either `default` to configure the default cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`.", + "launch_stage": "GA" + }, + "node_type_id": { + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "launch_stage": "GA" + }, + "num_workers": { + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "launch_stage": "GA" + }, + "spark_conf": { + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nSee :method:clusters/create for more details.", + "launch_stage": "GA" + }, + "spark_env_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "launch_stage": "GA" + }, + "ssh_public_keys": { + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineClusterAutoscale": { + "fields": { + "max_workers": { + "description": "The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`.", + "launch_stage": "GA" + }, + "min_workers": { + "description": "The minimum number of workers the cluster can scale down to when underutilized.\nIt is also the initial number of workers the cluster will have after creation.", + "launch_stage": "GA" + }, + "mode": { + "description": "Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.", + "ref": "pipelines.PipelineClusterAutoscaleMode", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineClusterAutoscaleMode": { + "description": "Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.", + "enum": [ + "ENHANCED", + "LEGACY" + ], + "enum_launch_stages": { + "ENHANCED": "GA", + "LEGACY": "GA" + } + }, + "pipelines.PipelineDeployment": { + "fields": { + "deployment_id": { + "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "kind": { + "description": "The deployment method that manages the pipeline.", + "ref": "pipelines.DeploymentKind", + "launch_stage": "GA" + }, + "metadata_file_path": { + "description": "The path to the file containing metadata about the deployment.", + "launch_stage": "GA" + }, + "version_id": { + "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.PipelineEvent": { + "fields": { + "error": { + "description": "Information about an error captured by the event.", + "ref": "pipelines.ErrorDetail", + "launch_stage": "GA" + }, + "event_type": { + "description": "The event type. Should always correspond to the details", + "launch_stage": "GA" + }, + "id": { + "description": "A time-based, globally unique id.", + "launch_stage": "GA" + }, + "level": { + "description": "The severity level of the event.", + "ref": "pipelines.EventLevel", + "launch_stage": "GA" + }, + "maturity_level": { + "description": "Maturity level for event_type.", + "ref": "pipelines.MaturityLevel", + "launch_stage": "GA" + }, + "message": { + "description": "The display message associated with the event.", + "launch_stage": "GA" + }, + "origin": { + "description": "Describes where the event originates from.", + "ref": "pipelines.Origin", + "launch_stage": "GA" + }, + "sequence": { + "description": "A sequencing object to identify and order events.", + "ref": "pipelines.Sequencing", + "launch_stage": "GA" + }, + "timestamp": { + "description": "The time of the event.", + "launch_stage": "GA" + }, + "truncation": { + "description": "Information about which fields were truncated from this event due to size constraints.\nIf empty or absent, no truncation occurred.\nSee https://docs.databricks.com/en/ldp/monitor-event-logs for information on\nretrieving complete event data.", + "ref": "pipelines.Truncation", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineLibrary": { + "fields": { + "file": { + "description": "The path to a file that defines a pipeline and is stored in the Databricks Repos.", + "ref": "pipelines.FileLibrary", + "launch_stage": "GA" + }, + "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": "pipelines.PathPattern", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "jar": { + "description": "URI of the jar to be installed. Currently only DBFS is supported.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "maven": { + "description": "Specification of a maven library to be installed.", + "ref": "compute.MavenLibrary", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "notebook": { + "description": "The path to a notebook that defines a pipeline and is stored in the Databricks workspace.", + "ref": "pipelines.NotebookLibrary", + "launch_stage": "GA" + }, + "whl": { + "description": "URI of the whl to be installed.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "pipelines.PipelinePermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "pipelines.PipelinePermissionLevel", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelinePermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "IS_OWNER", + "CAN_RUN", + "CAN_VIEW" + ] + }, + "pipelines.PipelinePermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "pipelines.PipelinePermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "pipelines.PipelinePermissionLevel", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelinePermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineSpec": { + "fields": { + "budget_policy_id": { + "description": "Budget policy of this pipeline.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "channel": { + "description": "SDP Release Channel that specifies which version to use.", + "launch_stage": "GA" + }, + "clusters": { + "description": "Cluster settings for this pipeline deployment.", + "launch_stage": "GA" + }, + "configuration": { + "description": "String-String configuration for this pipeline execution.", + "launch_stage": "GA" + }, + "continuous": { + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "launch_stage": "GA" + }, + "deployment": { + "description": "Deployment type of this pipeline.", + "ref": "pipelines.PipelineDeployment", + "launch_stage": "GA" + }, + "development": { + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "launch_stage": "GA" + }, + "edition": { + "description": "Pipeline product edition.", + "launch_stage": "GA" + }, + "environment": { + "description": "Environment specification for this pipeline used to install dependencies.", + "ref": "pipelines.PipelinesEnvironment", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "event_log": { + "description": "Event log configuration for this pipeline", + "ref": "pipelines.EventLogSpec", + "launch_stage": "GA" + }, + "filters": { + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "ref": "pipelines.Filters", + "launch_stage": "GA" + }, + "gateway_definition": { + "description": "The definition of a gateway pipeline to support change data capture.", + "ref": "pipelines.IngestionGatewayPipelineDefinition", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "description": "Unique identifier for this pipeline.", + "launch_stage": "GA" + }, + "ingestion_definition": { + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "ref": "pipelines.IngestionPipelineDefinition", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "libraries": { + "description": "Libraries or code needed by this deployment.", + "launch_stage": "GA" + }, + "name": { + "description": "Friendly identifier for this pipeline.", + "launch_stage": "GA" + }, + "notifications": { + "description": "List of notification settings for this pipeline.", + "launch_stage": "GA" + }, + "photon": { + "description": "Whether Photon is enabled for this pipeline.", + "launch_stage": "GA" + }, + "restart_window": { + "description": "Restart window of this pipeline.", + "ref": "pipelines.RestartWindow", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema": { + "description": "The default schema (database) where tables are read from or published to.", + "launch_stage": "GA" + }, + "serverless": { + "description": "Whether serverless compute is enabled for this pipeline.", + "launch_stage": "GA" + }, + "storage": { + "description": "DBFS root directory for storing checkpoints and tables.", + "launch_stage": "GA" + }, + "tags": { + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "launch_stage": "GA" + }, + "target": { + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "deprecated": true, + "launch_stage": "GA" + }, + "trigger": { + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "ref": "pipelines.PipelineTrigger", + "deprecated": true, + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "Usage policy of this pipeline.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.PipelineState": { + "description": "The pipeline state.", + "enum": [ + "DEPLOYING", + "STARTING", + "RUNNING", + "STOPPING", + "DELETED", + "RECOVERING", + "FAILED", + "RESETTING", + "IDLE" + ], + "enum_launch_stages": { + "DELETED": "GA", + "DEPLOYING": "GA", + "FAILED": "GA", + "IDLE": "GA", + "RECOVERING": "GA", + "RESETTING": "GA", + "RUNNING": "GA", + "STARTING": "GA", + "STOPPING": "GA" + } + }, + "pipelines.PipelineStateInfo": { + "fields": { + "cluster_id": { + "description": "The unique identifier of the cluster running the pipeline.", + "launch_stage": "GA" + }, + "creator_user_name": { + "description": "The username of the pipeline creator.", + "launch_stage": "GA" + }, + "health": { + "description": "The health of a pipeline.", + "ref": "pipelines.PipelineStateInfoHealth", + "deprecated": true, + "launch_stage": "GA" + }, + "latest_updates": { + "description": "Status of the latest updates for the pipeline. Ordered with the newest update first.", + "launch_stage": "GA" + }, + "name": { + "description": "The user-friendly name of the pipeline.", + "launch_stage": "GA" + }, + "pipeline_id": { + "description": "The unique identifier of the pipeline.", + "launch_stage": "GA" + }, + "run_as_user_name": { + "description": "The username that the pipeline runs as. This is a read only value derived from the pipeline owner.", + "launch_stage": "GA" + }, + "state": { + "ref": "pipelines.PipelineState", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelineStateInfoHealth": { + "description": "The health of a pipeline.", + "enum": [ + "HEALTHY", + "UNHEALTHY" + ], + "enum_launch_stages": { + "HEALTHY": "GA", + "UNHEALTHY": "GA" + } + }, + "pipelines.PipelineTrigger": { + "fields": { + "cron": { + "ref": "pipelines.CronTrigger", + "launch_stage": "GA" + }, + "manual": { + "ref": "pipelines.ManualTrigger", + "launch_stage": "GA" + } + } + }, + "pipelines.PipelinesEnvironment": { + "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.", + "fields": { + "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", + "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\"`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.PostgresCatalogConfig": { + "description": "PG-specific catalog-level configuration parameters", + "fields": { + "slot_config": { + "description": "Optional. The Postgres slot configuration to use for logical replication", + "ref": "pipelines.PostgresSlotConfig", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.PostgresSlotConfig": { + "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", + "fields": { + "publication_name": { + "description": "The name of the publication to use for the Postgres source", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "slot_name": { + "description": "The name of the logical replication slot to use for the Postgres source", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.PublishingMode": { + "description": "Enum representing the publishing mode of a pipeline.", + "enum": [ + "LEGACY_PUBLISHING_MODE", + "DEFAULT_PUBLISHING_MODE" + ], + "enum_launch_stages": { + "DEFAULT_PUBLISHING_MODE": "GA", + "LEGACY_PUBLISHING_MODE": "GA" + } + }, + "pipelines.ReplaceWhereOverride": { + "description": "Specifies a replace_where predicate override for a replace where flow.", + "fields": { + "flow_name": { + "description": "Name of the flow to apply this override to.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "predicate_override": { + "description": "SQL predicate string to use as replace_where condition.\nExample: `date = '2024-10-10' AND city = 'xyz'`", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.ReportSpec": { + "fields": { + "destination_catalog": { + "description": "Required. Destination catalog to store table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "destination_schema": { + "description": "Required. Destination schema to store table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "destination_table": { + "description": "Required. Destination table name. The pipeline fails if a table with that name already exists.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_url": { + "description": "Required. Report URL in the source system.", + "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": "pipelines.TableSpecificConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.RestartWindow": { + "fields": { + "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.", + "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.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", + "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.\nIf not specified, UTC will be used.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.RewindDatasetSpec": { + "description": "Configuration for rewinding a specific dataset.", + "fields": { + "cascade": { + "description": "Whether to cascade the rewind to dependent datasets. Must be specified.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "identifier": { + "description": "The identifier of the dataset (e.g., \"main.foo.tbl1\").", + "launch_stage": "PRIVATE_PREVIEW" + }, + "reset_checkpoints": { + "description": "Whether to reset checkpoints for this dataset.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.RewindSpec": { + "description": "Information about a rewind being requested for this pipeline or some of the datasets in it.", + "fields": { + "datasets": { + "description": "List of datasets to rewind with specific configuration for each. When not specified,\nall datasets will be rewound with cascade = true and reset_checkpoints = true.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "dry_run": { + "description": "If true, this is a dry run and we should emit the RewindSummary but not perform the rewind.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "rewind_timestamp": { + "description": "The base timestamp to rewind to. Exactly one of rewind_timestamp or rewind_point_id must be\nspecified.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.RunAs": { + "description": "Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline.\n\nOnly `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown.", + "fields": { + "service_principal_name": { + "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "launch_stage": "GA" + }, + "user_name": { + "description": "The email of an active workspace user. Users can only set this field to their own email.", + "launch_stage": "GA" + } + } + }, + "pipelines.SchemaSpec": { + "fields": { + "connector_options": { + "description": "(Optional) Source Specific Connector Options", + "ref": "pipelines.ConnectorOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "destination_catalog": { + "description": "Required. Destination catalog to store tables.", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_catalog": { + "description": "The source catalog name. Might be optional depending on the type of source.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_schema": { + "description": "Required. Schema name in the source database.", + "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": "pipelines.TableSpecificConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.Sequencing": { + "fields": { + "control_plane_seq_no": { + "description": "A sequence number, unique and increasing per pipeline.", + "launch_stage": "GA" + }, + "data_plane_id": { + "description": "the ID assigned by the data plane.", + "ref": "pipelines.DataPlaneId", + "launch_stage": "GA" + } + } + }, + "pipelines.SerializedException": { + "fields": { + "class_name": { + "description": "Runtime class of the exception", + "launch_stage": "GA" + }, + "message": { + "description": "Exception message", + "launch_stage": "GA" + }, + "stack": { + "description": "Stack trace consisting of a list of stack frames", + "launch_stage": "GA" + } + } + }, + "pipelines.SharepointOptions": { + "fields": { + "entity_type": { + "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "ref": "pipelines.SharepointOptionsSharepointEntityType", + "launch_stage": "PRIVATE_PREVIEW" + }, + "file_ingestion_options": { + "description": "(Optional) File ingestion options for processing files.", + "ref": "pipelines.FileIngestionOptions", + "launch_stage": "PRIVATE_PREVIEW" + }, + "url": { + "description": "Required. The SharePoint URL.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.SharepointOptionsSharepointEntityType": { + "enum": [ + "FILE", + "FILE_METADATA", + "PERMISSION", + "LIST" + ], + "enum_launch_stages": { + "FILE": "PRIVATE_PREVIEW", + "FILE_METADATA": "PRIVATE_PREVIEW", + "LIST": "PRIVATE_PREVIEW", + "PERMISSION": "PRIVATE_PREVIEW" + } + }, + "pipelines.SmartsheetOptions": { + "description": "Smartsheet specific options for ingestion", + "fields": { + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.SourceCatalogConfig": { + "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", + "fields": { + "postgres": { + "description": "Postgres-specific catalog-level configuration parameters", + "ref": "pipelines.PostgresCatalogConfig", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_catalog": { + "description": "Source catalog name", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.SourceConfig": { + "fields": { + "catalog": { + "description": "Catalog-level source configuration parameters", + "ref": "pipelines.SourceCatalogConfig", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "google_ads_config": { + "ref": "pipelines.GoogleAdsConfig", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.StackFrame": { + "fields": { + "declaring_class": { + "description": "Class from which the method call originated", + "launch_stage": "GA" + }, + "file_name": { + "description": "File where the method is defined", + "launch_stage": "GA" + }, + "line_number": { + "description": "Line from which the method was called", + "launch_stage": "GA" + }, + "method_name": { + "description": "Name of the method which was called", + "launch_stage": "GA" + } + } + }, + "pipelines.StartUpdate": { + "fields": { + "cause": { + "ref": "pipelines.StartUpdateCause", + "launch_stage": "GA" + }, + "full_refresh": { + "description": "If true, this update will reset all tables before running.", + "launch_stage": "GA" + }, + "full_refresh_selection": { + "description": "A list of tables to update with fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Key/value map of parameters to pass to the pipeline execution", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "refresh_selection": { + "description": "A list of tables to update without fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "launch_stage": "GA" + }, + "replace_where_overrides": { + "description": "A list of predicate overrides for replace_where flows in this update.\nOnly replace_where flows may be specified. Flows not listed use their original predicate.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "reset_checkpoint_selection": { + "description": "A list of flows for which this update should reset the streaming checkpoint. This selection will not clear\nthe data in the flow's target table. Flows in this list may also appear in refresh_selection and full_refresh_selection.", + "launch_stage": "GA" + }, + "rewind_spec": { + "description": "The information about the requested rewind operation.\nIf specified this is a rewind mode update.", + "ref": "pipelines.RewindSpec", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "validate_only": { + "description": "If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.", + "launch_stage": "GA" + } + } + }, + "pipelines.StartUpdateCause": { + "description": "What triggered this update.", + "enum": [ + "API_CALL", + "RETRY_ON_FAILURE", + "SERVICE_UPGRADE", + "SCHEMA_CHANGE", + "JOB_TASK", + "USER_ACTION", + "INFRASTRUCTURE_MAINTENANCE" + ], + "enum_launch_stages": { + "API_CALL": "GA", + "INFRASTRUCTURE_MAINTENANCE": "GA", + "JOB_TASK": "GA", + "RETRY_ON_FAILURE": "GA", + "SCHEMA_CHANGE": "GA", + "SERVICE_UPGRADE": "GA", + "USER_ACTION": "GA" + } + }, + "pipelines.StartUpdateResponse": { + "fields": { + "update_id": { + "launch_stage": "GA" + } + } + }, + "pipelines.StopPipelineResponse": {}, + "pipelines.TableSpec": { + "fields": { + "connector_options": { + "description": "(Optional) Source Specific Connector Options", + "ref": "pipelines.ConnectorOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "destination_catalog": { + "description": "Required. Destination catalog to store table.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "destination_schema": { + "description": "Required. Destination schema to store table.", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_catalog": { + "description": "Source catalog name. Might be optional depending on the type of source.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_schema": { + "description": "Schema name in the source database. Might be optional depending on the type of source.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "source_table": { + "description": "Required. Table name in the source database.", + "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": "pipelines.TableSpecificConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "pipelines.TableSpecificConfig": { + "fields": { + "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": "pipelines.AutoFullRefreshPolicy", + "preview": "PUBLIC", + "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`.", + "preview": "PUBLIC", + "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`.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "primary_keys": { + "description": "The primary key of the table used to apply changes.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query_based_connector_config": { + "ref": "pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "preview": "PUBLIC", + "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.", + "preview": "PUBLIC", + "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", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "scd_type": { + "ref": "pipelines.TableSpecificConfigScdType", + "preview": "PUBLIC", + "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.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "workday_report_parameters": { + "description": "(Optional) Additional custom parameters for Workday Report", + "ref": "pipelines.IngestionPipelineDefinitionWorkdayReportParameters", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.TableSpecificConfigScdType": { + "description": "The SCD type to use to ingest the table.", + "enum": [ + "SCD_TYPE_1", + "SCD_TYPE_2", + "APPEND_ONLY" + ], + "enum_launch_stages": { + "APPEND_ONLY": "PUBLIC_PREVIEW", + "SCD_TYPE_1": "PUBLIC_PREVIEW", + "SCD_TYPE_2": "PUBLIC_PREVIEW" + } + }, + "pipelines.TikTokAdsOptions": { + "description": "TikTok Ads specific options for ingestion", + "fields": { + "data_level": { + "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "ref": "pipelines.TikTokAdsOptionsTikTokDataLevel", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.)", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "report_type": { + "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "ref": "pipelines.TikTokAdsOptionsTikTokReportType", + "launch_stage": "PRIVATE_PREVIEW" + }, + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.TikTokAdsOptionsTikTokDataLevel": { + "description": "Data level for TikTok Ads report aggregation.", + "enum": [ + "AUCTION_ADVERTISER", + "AUCTION_CAMPAIGN", + "AUCTION_ADGROUP", + "AUCTION_AD" + ], + "enum_launch_stages": { + "AUCTION_AD": "PRIVATE_PREVIEW", + "AUCTION_ADGROUP": "PRIVATE_PREVIEW", + "AUCTION_ADVERTISER": "PRIVATE_PREVIEW", + "AUCTION_CAMPAIGN": "PRIVATE_PREVIEW" + } + }, + "pipelines.TikTokAdsOptionsTikTokReportType": { + "description": "Report type for TikTok Ads API.", + "enum": [ + "BASIC", + "AUDIENCE", + "PLAYABLE_AD", + "DSA", + "BUSINESS_CENTER", + "GMV_MAX" + ], + "enum_launch_stages": { + "AUDIENCE": "PRIVATE_PREVIEW", + "BASIC": "PRIVATE_PREVIEW", + "BUSINESS_CENTER": "PRIVATE_PREVIEW", + "DSA": "PRIVATE_PREVIEW", + "GMV_MAX": "PRIVATE_PREVIEW", + "PLAYABLE_AD": "PRIVATE_PREVIEW" + } + }, + "pipelines.Transformer": { + "description": "Specifies how to transform binary data into structured data.", + "fields": { + "format": { + "description": "Required: the wire format of the data.", + "ref": "pipelines.TransformerFormat", + "launch_stage": "PRIVATE_PREVIEW" + }, + "json_options": { + "ref": "pipelines.JsonTransformerOptions", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "pipelines.TransformerFormat": { + "enum": [ + "STRING", + "JSON" + ], + "enum_launch_stages": { + "JSON": "PRIVATE_PREVIEW", + "STRING": "PRIVATE_PREVIEW" + } + }, + "pipelines.Truncation": { + "description": "Information about truncations applied to this event.", + "fields": { + "truncated_fields": { + "description": "List of fields that were truncated from this event. If empty or absent,\nno truncation occurred.", + "launch_stage": "GA" + } + } + }, + "pipelines.TruncationTruncationDetail": { + "description": "Details about a specific field that was truncated.", + "fields": { + "field_name": { + "description": "The name of the truncated field (e.g., \"error\").\nCorresponds to field names in PipelineEvent.", + "launch_stage": "GA" + } + } + }, + "pipelines.UpdateInfo": { + "fields": { + "cause": { + "description": "What triggered this update.", + "ref": "pipelines.UpdateInfoCause", + "launch_stage": "GA" + }, + "cluster_id": { + "description": "The ID of the cluster that the update is running on.", + "launch_stage": "GA" + }, + "config": { + "description": "The pipeline configuration with system defaults applied where unspecified by the user.\nNot returned by ListUpdates.", + "ref": "pipelines.PipelineSpec", + "launch_stage": "GA" + }, + "creation_time": { + "description": "The time when this update was created.", + "launch_stage": "GA" + }, + "full_refresh": { + "description": "If true, this update will reset all tables before running.", + "launch_stage": "GA" + }, + "full_refresh_selection": { + "description": "A list of tables to update with fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Key/value map of parameters used to initiate the update", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "pipeline_id": { + "description": "The ID of the pipeline.", + "launch_stage": "GA" + }, + "refresh_selection": { + "description": "A list of tables to update without fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "launch_stage": "GA" + }, + "state": { + "description": "The update state.", + "ref": "pipelines.UpdateInfoState", + "launch_stage": "GA" + }, + "update_id": { + "description": "The ID of this update.", + "launch_stage": "GA" + }, + "validate_only": { + "description": "If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.", + "launch_stage": "GA" + } + } + }, + "pipelines.UpdateInfoCause": { + "description": "What triggered this update.", + "enum": [ + "API_CALL", + "RETRY_ON_FAILURE", + "SERVICE_UPGRADE", + "SCHEMA_CHANGE", + "JOB_TASK", + "USER_ACTION", + "INFRASTRUCTURE_MAINTENANCE" + ], + "enum_launch_stages": { + "API_CALL": "GA", + "INFRASTRUCTURE_MAINTENANCE": "GA", + "JOB_TASK": "GA", + "RETRY_ON_FAILURE": "GA", + "SCHEMA_CHANGE": "GA", + "SERVICE_UPGRADE": "GA", + "USER_ACTION": "GA" + } + }, + "pipelines.UpdateInfoState": { + "description": "The update state.", + "enum": [ + "QUEUED", + "CREATED", + "WAITING_FOR_RESOURCES", + "INITIALIZING", + "RESETTING", + "SETTING_UP_TABLES", + "RUNNING", + "STOPPING", + "COMPLETED", + "FAILED", + "CANCELED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "COMPLETED": "GA", + "CREATED": "GA", + "FAILED": "GA", + "INITIALIZING": "GA", + "QUEUED": "GA", + "RESETTING": "GA", + "RUNNING": "GA", + "SETTING_UP_TABLES": "GA", + "STOPPING": "GA", + "WAITING_FOR_RESOURCES": "GA" + } + }, + "pipelines.UpdateStateInfo": { + "fields": { + "creation_time": { + "launch_stage": "GA" + }, + "state": { + "ref": "pipelines.UpdateStateInfoState", + "launch_stage": "GA" + }, + "update_id": { + "launch_stage": "GA" + } + } + }, + "pipelines.UpdateStateInfoState": { + "description": "The update state.", + "enum": [ + "QUEUED", + "CREATED", + "WAITING_FOR_RESOURCES", + "INITIALIZING", + "RESETTING", + "SETTING_UP_TABLES", + "RUNNING", + "STOPPING", + "COMPLETED", + "FAILED", + "CANCELED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "COMPLETED": "GA", + "CREATED": "GA", + "FAILED": "GA", + "INITIALIZING": "GA", + "QUEUED": "GA", + "RESETTING": "GA", + "RUNNING": "GA", + "SETTING_UP_TABLES": "GA", + "STOPPING": "GA", + "WAITING_FOR_RESOURCES": "GA" + } + }, + "pipelines.ZendeskSupportOptions": { + "description": "Zendesk Support specific options for ingestion", + "fields": { + "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.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "postgres.Branch": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the branch was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA" + }, + "parent": { + "description": "The project containing this branch (API resource hierarchy).\nFormat: projects/{project_id}\n\nNote: This field indicates where the branch exists in the resource hierarchy.\nFor point-in-time branching from another branch, see `status.source_branch`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The spec contains the branch configuration.", + "ref": "postgres.BranchSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "The current status of a Branch.", + "ref": "postgres.BranchStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "uid": { + "description": "System-generated unique ID for the branch.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the branch was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.BranchOperationMetadata": {}, + "postgres.BranchSpec": { + "fields": { + "expire_time": { + "description": "Absolute expiration timestamp. When set, the branch will expire at this time.\nMutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "is_protected": { + "description": "When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "no_expiry": { + "description": "Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or expire_time instead.\nMutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "source_branch": { + "description": "The name of the source branch from which this branch was created (data lineage for point-in-time recovery).\nIf not specified, defaults to the project's default branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + }, + "source_branch_lsn": { + "description": "The Log Sequence Number (LSN) on the source branch from which this branch was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + }, + "source_branch_time": { + "description": "The point in time on the source branch from which this branch was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + }, + "ttl": { + "description": "Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.\nMutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.BranchStatus": { + "fields": { + "branch_id": { + "description": "Part of the resource name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "current_state": { + "description": "The branch's state, indicating if it is initializing, ready for use, or archived.", + "ref": "postgres.BranchStatusState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "default": { + "description": "Whether the branch is the project's default branch.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "delete_time": { + "description": "A timestamp indicating when the branch was deleted.\nEmpty if the branch is not deleted.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expire_time": { + "description": "Absolute expiration time for the branch. Empty if expiration is disabled.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "is_protected": { + "description": "Whether the branch is protected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "logical_size_bytes": { + "description": "The logical size of the branch.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pending_state": { + "description": "The pending state of the branch, if a state transition is in progress.", + "ref": "postgres.BranchStatusState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "purge_time": { + "description": "A timestamp indicating when the branch is scheduled to be purged.\nEmpty if the branch is not deleted, otherwise set to a timestamp in the future.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_branch": { + "description": "The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_branch_lsn": { + "description": "The Log Sequence Number (LSN) on the source branch from which this branch was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_branch_time": { + "description": "The point in time on the source branch from which this branch was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state_change_time": { + "description": "A timestamp indicating when the `current_state` began.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.BranchStatusState": { + "description": "The state of the branch.", + "enum": [ + "INIT", + "IMPORTING", + "RESETTING", + "READY", + "ARCHIVED", + "DELETED" + ], + "enum_launch_stages": { + "ARCHIVED": "PUBLIC_BETA", + "DELETED": "PRIVATE_PREVIEW", + "IMPORTING": "PUBLIC_BETA", + "INIT": "PUBLIC_BETA", + "READY": "PUBLIC_BETA", + "RESETTING": "PUBLIC_BETA" + } + }, + "postgres.Catalog": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the catalog was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The full resource path of the catalog.\n\nFormat: \"catalogs/{catalog_id}\".", + "launch_stage": "PUBLIC_BETA" + }, + "spec": { + "description": "The desired state of the Catalog.", + "ref": "postgres.CatalogCatalogSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "The observed state of the Catalog.", + "ref": "postgres.CatalogCatalogStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "uid": { + "description": "System-generated unique identifier for the catalog.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the catalog was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.CatalogCatalogSpec": { + "description": "The desired state of the Catalog.", + "fields": { + "branch": { + "description": "The resource path of the branch associated with the catalog.\n\nFormat: projects/{project_id}/branches/{branch_id}.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "create_database_if_missing": { + "description": "If set to true, the specified postgres_database is created on behalf of the calling user\nif it does not already exist. In this case, the calling user has a role created for\nthem in Postgres if they do not already have one.\n\nDefaults to false, meaning that the request fails if the specified postgres_database does not already exist.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "postgres_database": { + "description": "The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.\nThis database must already exist, unless create_database_if_missing is set to true on creation.\n\nA database can only be registered with one UC catalog at a time.\nTo re-register a database with a different catalog, the existing catalog must be deleted first.\n\nA child branch inherits the fact of parent's registration. This means the same-named database\nin a child branch cannot be registered with a second catalog\nwhile the parent's registration exists. To allow registering the database of a child branch,\ndrop and recreate the database on the child branch.\nThis removes the fact of parent's registration from this branch only.\n\nDoing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered\nin the Catalog drops the fact of registration of the database. So the user should avoid doing so.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + } + } + }, + "postgres.CatalogCatalogStatus": { + "description": "The observed state of the Catalog.", + "fields": { + "branch": { + "description": "The resource path of the branch associated with the catalog.\n\nFormat: projects/{project_id}/branches/{branch_id}.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "postgres_database": { + "description": "The name of the Postgres database associated with the catalog.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "project": { + "description": "The resource path of the project associated with the catalog.\n\nFormat: projects/{project_id}.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.CatalogOperationMetadata": {}, + "postgres.Database": { + "description": "Database represents a Postgres database within a Branch.", + "fields": { + "create_time": { + "description": "A timestamp indicating when the database was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "launch_stage": "PUBLIC_BETA" + }, + "parent": { + "description": "The branch containing this database.\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The desired state of the Database.", + "ref": "postgres.DatabaseDatabaseSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "The observed state of the Database.", + "ref": "postgres.DatabaseDatabaseStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the database was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.DatabaseCredential": { + "fields": { + "expire_time": { + "description": "Timestamp in UTC of when this credential expires.", + "launch_stage": "PUBLIC_BETA" + }, + "token": { + "description": "The OAuth token that can be used as a password when connecting to a database.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.DatabaseDatabaseSpec": { + "fields": { + "postgres_database": { + "description": "The name of the Postgres database.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\nRequired when creating the Database.\n\nTo rename, pass a valid postgres identifier when updating the Database.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "role": { + "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nA database always has an owner.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.DatabaseDatabaseStatus": { + "fields": { + "database_id": { + "description": "Part of the resource name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "postgres_database": { + "description": "The name of the Postgres database.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "role": { + "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.DatabaseOperationMetadata": {}, + "postgres.DatabricksServiceExceptionWithDetailsProto": { + "description": "Databricks Error that is returned by all Databricks APIs.", + "fields": { + "details": { + "launch_stage": "PUBLIC_BETA" + }, + "error_code": { + "ref": "postgres.ErrorCode", + "launch_stage": "PUBLIC_BETA" + }, + "message": { + "launch_stage": "PUBLIC_BETA" + }, + "stack_trace": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.DeltaTableSyncInfo": { + "fields": { + "delta_commit_time": { + "description": "The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "delta_commit_version": { + "description": "The Delta Lake commit version that was last successfully synced.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.Endpoint": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the compute endpoint was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "launch_stage": "PUBLIC_BETA" + }, + "parent": { + "description": "The branch containing this endpoint (API resource hierarchy).\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.", + "ref": "postgres.EndpointSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "Current operational status of the compute endpoint.", + "ref": "postgres.EndpointStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "uid": { + "description": "System-generated unique ID for the endpoint.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the compute endpoint was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.EndpointGroupSpec": { + "fields": { + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "postgres.EndpointGroupStatus": { + "fields": { + "enable_readable_secondaries": { + "description": "Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "postgres.EndpointHosts": { + "description": "Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint.", + "fields": { + "host": { + "description": "The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects\nto the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "read_only_host": { + "description": "An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,\nthis attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined\nif the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.EndpointOperationMetadata": {}, + "postgres.EndpointSettings": { + "description": "A collection of settings for a compute endpoint.", + "fields": { + "pg_settings": { + "description": "A raw representation of Postgres settings.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.EndpointSpec": { + "fields": { + "autoscaling_limit_max_cu": { + "description": "The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "autoscaling_limit_min_cu": { + "description": "The minimum number of Compute Units. Minimum value is 0.5.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "disabled": { + "description": "Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "endpoint_type": { + "description": "The endpoint type. A branch can only have one READ_WRITE endpoint.", + "ref": "postgres.EndpointType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "group": { + "description": "Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults\nto non HA settings, with a single compute backing the endpoint (and no readable secondaries\nfor Read/Write endpoints).", + "ref": "postgres.EndpointGroupSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.suspension` in the update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "settings": { + "ref": "postgres.EndpointSettings", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.suspension` in the update_mask.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.EndpointStatus": { + "fields": { + "autoscaling_limit_max_cu": { + "description": "The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "autoscaling_limit_min_cu": { + "description": "The minimum number of Compute Units.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "current_state": { + "ref": "postgres.EndpointStatusState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "disabled": { + "description": "Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "endpoint_id": { + "description": "Part of the resource name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "endpoint_type": { + "description": "The endpoint type. A branch can only have one READ_WRITE endpoint.", + "ref": "postgres.EndpointType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "group": { + "description": "Details on the HA configuration of the endpoint.", + "ref": "postgres.EndpointGroupStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "hosts": { + "description": "Contains host information for connecting to the endpoint.", + "ref": "postgres.EndpointHosts", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pending_state": { + "ref": "postgres.EndpointStatusState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "settings": { + "ref": "postgres.EndpointSettings", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "suspend_timeout_duration": { + "description": "Duration of inactivity after which the compute endpoint is automatically suspended.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.EndpointStatusState": { + "description": "The state of the compute endpoint.", + "enum": [ + "INIT", + "ACTIVE", + "IDLE", + "DEGRADED" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_BETA", + "DEGRADED": "PRIVATE_PREVIEW", + "IDLE": "PUBLIC_BETA", + "INIT": "PUBLIC_BETA" + } + }, + "postgres.EndpointType": { + "description": "The compute endpoint type. Either `read_write` or `read_only`.", + "enum": [ + "ENDPOINT_TYPE_READ_WRITE", + "ENDPOINT_TYPE_READ_ONLY" + ], + "enum_launch_stages": { + "ENDPOINT_TYPE_READ_ONLY": "PUBLIC_BETA", + "ENDPOINT_TYPE_READ_WRITE": "PUBLIC_BETA" + } + }, + "postgres.ErrorCode": { + "description": "Error codes returned by Databricks APIs to indicate specific failure conditions.", + "enum": [ + "UNKNOWN", + "INTERNAL_ERROR", + "TEMPORARILY_UNAVAILABLE", + "IO_ERROR", + "BAD_REQUEST", + "SERVICE_UNDER_MAINTENANCE", + "WORKSPACE_TEMPORARILY_UNAVAILABLE", + "DEADLINE_EXCEEDED", + "CANCELLED", + "RESOURCE_EXHAUSTED", + "ABORTED", + "NOT_FOUND", + "ALREADY_EXISTS", + "UNAUTHENTICATED", + "UNAVAILABLE", + "INVALID_PARAMETER_VALUE", + "ENDPOINT_NOT_FOUND", + "MALFORMED_REQUEST", + "INVALID_STATE", + "PERMISSION_DENIED", + "FEATURE_DISABLED", + "CUSTOMER_UNAUTHORIZED", + "REQUEST_LIMIT_EXCEEDED", + "RESOURCE_CONFLICT", + "UNPARSEABLE_HTTP_ERROR", + "NOT_IMPLEMENTED", + "DATA_LOSS", + "INVALID_STATE_TRANSITION", + "COULD_NOT_ACQUIRE_LOCK", + "RESOURCE_ALREADY_EXISTS", + "RESOURCE_DOES_NOT_EXIST", + "QUOTA_EXCEEDED", + "MAX_BLOCK_SIZE_EXCEEDED", + "MAX_READ_SIZE_EXCEEDED", + "PARTIAL_DELETE", + "MAX_LIST_SIZE_EXCEEDED", + "DRY_RUN_FAILED", + "RESOURCE_LIMIT_EXCEEDED", + "DIRECTORY_NOT_EMPTY", + "DIRECTORY_PROTECTED", + "MAX_NOTEBOOK_SIZE_EXCEEDED", + "MAX_CHILD_NODE_SIZE_EXCEEDED", + "SEARCH_QUERY_TOO_LONG", + "SEARCH_QUERY_TOO_SHORT", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST", + "PERMISSION_NOT_PROPAGATED", + "DEPLOYMENT_TIMEOUT", + "GIT_CONFLICT", + "GIT_UNKNOWN_REF", + "GIT_SENSITIVE_TOKEN_DETECTED", + "GIT_URL_NOT_ON_ALLOW_LIST", + "GIT_REMOTE_ERROR", + "PROJECTS_OPERATION_TIMEOUT", + "IPYNB_FILE_IN_REPO", + "INSECURE_PARTNER_RESPONSE", + "MALFORMED_PARTNER_RESPONSE", + "METASTORE_DOES_NOT_EXIST", + "DAC_DOES_NOT_EXIST", + "CATALOG_DOES_NOT_EXIST", + "SCHEMA_DOES_NOT_EXIST", + "TABLE_DOES_NOT_EXIST", + "SHARE_DOES_NOT_EXIST", + "RECIPIENT_DOES_NOT_EXIST", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST", + "EXTERNAL_LOCATION_DOES_NOT_EXIST", + "PRINCIPAL_DOES_NOT_EXIST", + "PROVIDER_DOES_NOT_EXIST", + "METASTORE_ALREADY_EXISTS", + "DAC_ALREADY_EXISTS", + "CATALOG_ALREADY_EXISTS", + "SCHEMA_ALREADY_EXISTS", + "TABLE_ALREADY_EXISTS", + "SHARE_ALREADY_EXISTS", + "RECIPIENT_ALREADY_EXISTS", + "STORAGE_CREDENTIAL_ALREADY_EXISTS", + "EXTERNAL_LOCATION_ALREADY_EXISTS", + "PROVIDER_ALREADY_EXISTS", + "CATALOG_NOT_EMPTY", + "SCHEMA_NOT_EMPTY", + "METASTORE_NOT_EMPTY", + "PROVIDER_SHARE_NOT_ACCESSIBLE" + ], + "enum_launch_stages": { + "ABORTED": "PUBLIC_BETA", + "ALREADY_EXISTS": "PUBLIC_BETA", + "BAD_REQUEST": "PUBLIC_BETA", + "CANCELLED": "PUBLIC_BETA", + "CATALOG_ALREADY_EXISTS": "PUBLIC_BETA", + "CATALOG_DOES_NOT_EXIST": "PUBLIC_BETA", + "CATALOG_NOT_EMPTY": "PUBLIC_BETA", + "COULD_NOT_ACQUIRE_LOCK": "PUBLIC_BETA", + "CUSTOMER_UNAUTHORIZED": "PUBLIC_BETA", + "DAC_ALREADY_EXISTS": "PUBLIC_BETA", + "DAC_DOES_NOT_EXIST": "PUBLIC_BETA", + "DATA_LOSS": "PUBLIC_BETA", + "DEADLINE_EXCEEDED": "PUBLIC_BETA", + "DEPLOYMENT_TIMEOUT": "PUBLIC_BETA", + "DIRECTORY_NOT_EMPTY": "PUBLIC_BETA", + "DIRECTORY_PROTECTED": "PUBLIC_BETA", + "DRY_RUN_FAILED": "PUBLIC_BETA", + "ENDPOINT_NOT_FOUND": "PUBLIC_BETA", + "EXTERNAL_LOCATION_ALREADY_EXISTS": "PUBLIC_BETA", + "EXTERNAL_LOCATION_DOES_NOT_EXIST": "PUBLIC_BETA", + "FEATURE_DISABLED": "PUBLIC_BETA", + "GIT_CONFLICT": "PUBLIC_BETA", + "GIT_REMOTE_ERROR": "PUBLIC_BETA", + "GIT_SENSITIVE_TOKEN_DETECTED": "PUBLIC_BETA", + "GIT_UNKNOWN_REF": "PUBLIC_BETA", + "GIT_URL_NOT_ON_ALLOW_LIST": "PUBLIC_BETA", + "INSECURE_PARTNER_RESPONSE": "PUBLIC_BETA", + "INTERNAL_ERROR": "PUBLIC_BETA", + "INVALID_PARAMETER_VALUE": "PUBLIC_BETA", + "INVALID_STATE": "PUBLIC_BETA", + "INVALID_STATE_TRANSITION": "PUBLIC_BETA", + "IO_ERROR": "PUBLIC_BETA", + "IPYNB_FILE_IN_REPO": "PUBLIC_BETA", + "MALFORMED_PARTNER_RESPONSE": "PUBLIC_BETA", + "MALFORMED_REQUEST": "PUBLIC_BETA", + "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST": "PUBLIC_BETA", + "MAX_BLOCK_SIZE_EXCEEDED": "PUBLIC_BETA", + "MAX_CHILD_NODE_SIZE_EXCEEDED": "PUBLIC_BETA", + "MAX_LIST_SIZE_EXCEEDED": "PUBLIC_BETA", + "MAX_NOTEBOOK_SIZE_EXCEEDED": "PUBLIC_BETA", + "MAX_READ_SIZE_EXCEEDED": "PUBLIC_BETA", + "METASTORE_ALREADY_EXISTS": "PUBLIC_BETA", + "METASTORE_DOES_NOT_EXIST": "PUBLIC_BETA", + "METASTORE_NOT_EMPTY": "PUBLIC_BETA", + "NOT_FOUND": "PUBLIC_BETA", + "NOT_IMPLEMENTED": "PUBLIC_BETA", + "PARTIAL_DELETE": "PUBLIC_BETA", + "PERMISSION_DENIED": "PUBLIC_BETA", + "PERMISSION_NOT_PROPAGATED": "PUBLIC_BETA", + "PRINCIPAL_DOES_NOT_EXIST": "PUBLIC_BETA", + "PROJECTS_OPERATION_TIMEOUT": "PUBLIC_BETA", + "PROVIDER_ALREADY_EXISTS": "PUBLIC_BETA", + "PROVIDER_DOES_NOT_EXIST": "PUBLIC_BETA", + "PROVIDER_SHARE_NOT_ACCESSIBLE": "PUBLIC_BETA", + "QUOTA_EXCEEDED": "PUBLIC_BETA", + "RECIPIENT_ALREADY_EXISTS": "PUBLIC_BETA", + "RECIPIENT_DOES_NOT_EXIST": "PUBLIC_BETA", + "REQUEST_LIMIT_EXCEEDED": "PUBLIC_BETA", + "RESOURCE_ALREADY_EXISTS": "PUBLIC_BETA", + "RESOURCE_CONFLICT": "PUBLIC_BETA", + "RESOURCE_DOES_NOT_EXIST": "PUBLIC_BETA", + "RESOURCE_EXHAUSTED": "PUBLIC_BETA", + "RESOURCE_LIMIT_EXCEEDED": "PUBLIC_BETA", + "SCHEMA_ALREADY_EXISTS": "PUBLIC_BETA", + "SCHEMA_DOES_NOT_EXIST": "PUBLIC_BETA", + "SCHEMA_NOT_EMPTY": "PUBLIC_BETA", + "SEARCH_QUERY_TOO_LONG": "PUBLIC_BETA", + "SEARCH_QUERY_TOO_SHORT": "PUBLIC_BETA", + "SERVICE_UNDER_MAINTENANCE": "PUBLIC_BETA", + "SHARE_ALREADY_EXISTS": "PUBLIC_BETA", + "SHARE_DOES_NOT_EXIST": "PUBLIC_BETA", + "STORAGE_CREDENTIAL_ALREADY_EXISTS": "PUBLIC_BETA", + "STORAGE_CREDENTIAL_DOES_NOT_EXIST": "PUBLIC_BETA", + "TABLE_ALREADY_EXISTS": "PUBLIC_BETA", + "TABLE_DOES_NOT_EXIST": "PUBLIC_BETA", + "TEMPORARILY_UNAVAILABLE": "PUBLIC_BETA", + "UNAUTHENTICATED": "PUBLIC_BETA", + "UNAVAILABLE": "PUBLIC_BETA", + "UNKNOWN": "PUBLIC_BETA", + "UNPARSEABLE_HTTP_ERROR": "PUBLIC_BETA", + "WORKSPACE_TEMPORARILY_UNAVAILABLE": "PUBLIC_BETA" + } + }, + "postgres.GenerateDatabaseCredentialRequest": { + "fields": { + "claims": { + "description": "The returned token will be scoped to UC tables with the specified permissions.", + "launch_stage": "PUBLIC_BETA" + }, + "endpoint": { + "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "postgres.InitialEndpointSpec": { + "description": "Configuration for the initial Read/Write endpoint created during project creation.", + "fields": { + "group": { + "description": "Settings for HA configuration of the endpoint.", + "ref": "postgres.EndpointGroupSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.ListBranchesResponse": { + "fields": { + "branches": { + "description": "List of branches in the project.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "Token to request the next page of branches.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.ListDatabasesResponse": { + "fields": { + "databases": { + "description": "List of databases.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "Pagination token to request the next page of databases.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.ListEndpointsResponse": { + "fields": { + "endpoints": { + "description": "List of compute endpoints in the branch.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "next_page_token": { + "description": "Token to request the next page of compute endpoints.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.ListProjectsResponse": { + "fields": { + "next_page_token": { + "description": "Token to request the next page of projects.", + "launch_stage": "PUBLIC_BETA" + }, + "projects": { + "description": "List of all projects in the workspace that the user has permission to access.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.ListRolesResponse": { + "fields": { + "next_page_token": { + "description": "Token to request the next page of Postgres roles.", + "launch_stage": "PUBLIC_BETA" + }, + "roles": { + "description": "List of Postgres roles in the branch.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.NewPipelineSpec": { + "fields": { + "budget_policy_id": { + "description": "Budget policy to set on the newly created pipeline.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "storage_catalog": { + "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "storage_schema": { + "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "fields": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "launch_stage": "PUBLIC_BETA" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "ref": "postgres.DatabricksServiceExceptionWithDetailsProto", + "launch_stage": "PUBLIC_BETA" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata.", + "launch_stage": "PUBLIC_BETA" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "launch_stage": "PUBLIC_BETA" + }, + "response": { + "description": "The normal, successful response of the operation.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.Project": { + "fields": { + "create_time": { + "description": "A timestamp indicating when the project was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "delete_time": { + "description": "A timestamp indicating when the project was soft-deleted.\nEmpty if the project is not deleted, otherwise set to a timestamp in the past.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "initial_endpoint_spec": { + "description": "Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly\ncreated project. If omitted, the initial endpoint created will have default settings, without high availability\nconfigured. This field does not apply to any endpoints created after project creation. Use\nspec.default_endpoint_settings to configure default settings for endpoints created after project creation.", + "ref": "postgres.InitialEndpointSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "launch_stage": "PUBLIC_BETA" + }, + "purge_time": { + "description": "A timestamp indicating when the project is scheduled for permanent deletion.\nEmpty if the project is not deleted, otherwise set to a timestamp in the future.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.", + "ref": "postgres.ProjectSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "The current status of a Project.", + "ref": "postgres.ProjectStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "uid": { + "description": "System-generated unique ID for the project.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "A timestamp indicating when the project was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.ProjectCustomTag": { + "fields": { + "key": { + "description": "The key of the custom tag.", + "launch_stage": "PUBLIC_BETA" + }, + "value": { + "description": "The value of the custom tag.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.ProjectDefaultEndpointSettings": { + "description": "A collection of settings for a compute endpoint.", + "fields": { + "autoscaling_limit_max_cu": { + "description": "The maximum number of Compute Units. Minimum value is 0.5.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "autoscaling_limit_min_cu": { + "description": "The minimum number of Compute Units. Minimum value is 0.5.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "pg_settings": { + "description": "A raw representation of Postgres settings.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.ProjectOperationMetadata": {}, + "postgres.ProjectSpec": { + "fields": { + "budget_policy_id": { + "description": "The desired budget policy to associate with the project.\nSee status.budget_policy_id for the policy that is actually applied to the project.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_tags": { + "description": "Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.\nTo update tags, provide the new tag list and include \"spec.custom_tags\" in the update_mask.\nTo clear all tags, provide an empty list and include \"spec.custom_tags\" in the update_mask.\nTo preserve existing tags, omit this field from the update_mask (or use wildcard \"*\" which auto-excludes empty tags).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "default_branch": { + "description": "The full resource path for the default branch of the project\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "default_endpoint_settings": { + "ref": "postgres.ProjectDefaultEndpointSettings", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "display_name": { + "description": "Human-readable project name. Length should be between 1 and 256 characters.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "enable_pg_native_login": { + "description": "Whether to enable PG native password login on all endpoints in this project. Defaults to false.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "history_retention_duration": { + "description": "The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "pg_version": { + "description": "The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "IMMUTABLE" + ] + } + } + }, + "postgres.ProjectStatus": { + "fields": { + "branch_logical_size_limit_bytes": { + "description": "The logical size limit for a branch.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "budget_policy_id": { + "description": "The budget policy that is applied to the project.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "custom_tags": { + "description": "The effective custom tags associated with the project.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "default_branch": { + "description": "The full resource path of the default branch of the project", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "default_endpoint_settings": { + "description": "The effective default endpoint settings.", + "ref": "postgres.ProjectDefaultEndpointSettings", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "The effective human-readable project name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "enable_pg_native_login": { + "description": "Whether to enable PG native password login on all endpoints in this project.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "history_retention_duration": { + "description": "The effective number of seconds to retain the shared history for point in time recovery.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "owner": { + "description": "The email of the project owner.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pg_version": { + "description": "The effective major Postgres version number.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "project_id": { + "description": "Part of the resource name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "synthetic_storage_size_bytes": { + "description": "The current space occupied by the project in storage.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.ProvisioningInfoState": { + "enum": [ + "PROVISIONING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING", + "DEGRADED" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_BETA", + "DEGRADED": "PUBLIC_BETA", + "DELETING": "PUBLIC_BETA", + "FAILED": "PUBLIC_BETA", + "PROVISIONING": "PUBLIC_BETA", + "UPDATING": "PUBLIC_BETA" + } + }, + "postgres.ProvisioningPhase": { + "description": "The current phase of the data synchronization pipeline.", + "enum": [ + "PROVISIONING_PHASE_MAIN", + "PROVISIONING_PHASE_INDEX_SCAN", + "PROVISIONING_PHASE_INDEX_SORT" + ], + "enum_launch_stages": { + "PROVISIONING_PHASE_INDEX_SCAN": "PUBLIC_BETA", + "PROVISIONING_PHASE_INDEX_SORT": "PUBLIC_BETA", + "PROVISIONING_PHASE_MAIN": "PUBLIC_BETA" + } + }, + "postgres.RequestedClaims": { + "fields": { + "permission_set": { + "ref": "postgres.RequestedClaimsPermissionSet", + "launch_stage": "PUBLIC_BETA" + }, + "resources": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.RequestedClaimsPermissionSet": { + "enum": [ + "READ_ONLY" + ], + "enum_launch_stages": { + "READ_ONLY": "PUBLIC_BETA" + } + }, + "postgres.RequestedResource": { + "fields": { + "table_name": { + "description": "The full Unity Catalog table name.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.Role": { + "description": "Role represents a Postgres role within a Branch.", + "fields": { + "create_time": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "launch_stage": "PUBLIC_BETA" + }, + "parent": { + "description": "The Branch where this Role exists.\nFormat: projects/{project_id}/branches/{branch_id}", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The spec contains the role configuration, including identity type, authentication method, and role attributes.", + "ref": "postgres.RoleRoleSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "Current status of the role, including its identity type, authentication method, and role attributes.", + "ref": "postgres.RoleRoleStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.RoleAttributes": { + "description": "Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref:\nhttps://www.postgresql.org/docs/16/sql-createrole.html\nThe values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical\nunderscores between words.", + "fields": { + "bypassrls": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "createdb": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "createrole": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.RoleAuthMethod": { + "description": "How the role is authenticated when connecting to Postgres.", + "enum": [ + "NO_LOGIN", + "PG_PASSWORD_SCRAM_SHA_256", + "LAKEBASE_OAUTH_V1" + ], + "enum_launch_stages": { + "LAKEBASE_OAUTH_V1": "PUBLIC_BETA", + "NO_LOGIN": "PUBLIC_BETA", + "PG_PASSWORD_SCRAM_SHA_256": "PUBLIC_BETA" + } + }, + "postgres.RoleIdentityType": { + "description": "The type of the Databricks managed identity that this Role represents.\nLeave empty if you wish to create a regular Postgres role not associated with a Databricks identity.", + "enum": [ + "USER", + "SERVICE_PRINCIPAL", + "GROUP" + ], + "enum_launch_stages": { + "GROUP": "PUBLIC_BETA", + "SERVICE_PRINCIPAL": "PUBLIC_BETA", + "USER": "PUBLIC_BETA" + } + }, + "postgres.RoleMembershipRole": { + "description": "Roles that the DatabaseInstanceRole can be a member of.", + "enum": [ + "DATABRICKS_SUPERUSER" + ], + "enum_launch_stages": { + "DATABRICKS_SUPERUSER": "PUBLIC_BETA" + } + }, + "postgres.RoleOperationMetadata": {}, + "postgres.RoleRoleSpec": { + "fields": { + "attributes": { + "description": "The desired API-exposed Postgres role attribute to associate with the role. Optional.", + "ref": "postgres.RoleAttributes", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "auth_method": { + "description": "Controls how the Postgres role authenticates when a client opens a database\nconnection. Supported values:\n\n* LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks\nOAuth access token derived from the backing managed identity (the\nDatabricks user, service principal, or group named by the role's\n`postgres_role`). No static password exists for roles using this method.\n* PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres\npassword verified server-side using the SCRAM-SHA-256 mechanism.\nLakebase generates a password for the role.\n* NO_LOGIN: the role cannot open a Postgres session at all. Useful for\nroles that exist only to own objects or to aggregate privileges that\nare then granted to other, loginable roles.\n\nIf auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:\n* For the managed identities, OAUTH is used.\n* For the regular postgres roles, authentication based on postgres passwords is used.\n\nNOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1\nis the default auth method (group can login as well).", + "ref": "postgres.RoleAuthMethod", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "identity_type": { + "description": "The type of role.\nWhen specifying a managed-identity, the chosen role_id must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP", + "ref": "postgres.RoleIdentityType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "membership_roles": { + "description": "An enum value for a standard role that this role is a member of.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "postgres_role": { + "description": "The name of the Postgres role.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\n\nRequired when creating the Role.\n\nIf you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role\nmust be one of the following:\n\n1. user email for IdentityType.USER\n2. app ID for IdentityType.SERVICE_PRINCIPAL\n2. group name for IdentityType.GROUP", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.RoleRoleStatus": { + "fields": { + "attributes": { + "description": "The PG role attributes associated with the role.", + "ref": "postgres.RoleAttributes", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "auth_method": { + "ref": "postgres.RoleAuthMethod", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "identity_type": { + "description": "The type of the role.", + "ref": "postgres.RoleIdentityType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "membership_roles": { + "description": "An enum value for a standard role that this role is a member of.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "postgres_role": { + "description": "The name of the Postgres role.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "role_id": { + "description": "Part of the resource name.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.SyncedTable": { + "fields": { + "create_time": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Output only. The Full resource name of the synced table in Postgres\nwhere (catalog, schema, table) are the UC entity names.\n\nFormat \"synced_tables/{catalog}.{schema}.{table}\"\n\nFor the corresponding source table in the Unity catalog look for the \"source_table_full_name\" attribute.", + "launch_stage": "PUBLIC_BETA" + }, + "spec": { + "description": "Configuration details of the synced table, such as the source table, scheduling policy, etc.\nThis attribute is specified at creation time and most fields are returned as is on subsequent queries.", + "ref": "postgres.SyncedTableSyncedTableSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL", + "INPUT_ONLY" + ] + }, + "status": { + "description": "Synced Table data synchronization status.", + "ref": "postgres.SyncedTableSyncedTableStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "uid": { + "description": "The Unity Catalog table ID for this synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.SyncedTableOperationMetadata": { + "description": "Metadata for SyncedTable long-running operations." + }, + "postgres.SyncedTablePipelineProgress": { + "description": "Progress information of the Synced Table data synchronization pipeline.", + "fields": { + "estimated_completion_time_seconds": { + "description": "The estimated time remaining to complete this update in seconds.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "latest_version_currently_processing": { + "description": "The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_progress_completion": { + "description": "The completion ratio of this update. This is a number between 0 and 1.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "synced_row_count": { + "description": "The number of rows that have been synced in this update.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "total_row_count": { + "description": "The total number of rows that need to be synced in this update. This number may be an estimate.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.SyncedTablePosition": { + "fields": { + "delta_table_sync_info": { + "ref": "postgres.DeltaTableSyncInfo", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_end_time": { + "description": "The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sync_start_time": { + "description": "The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.SyncedTableState": { + "description": "The state of a synced table.", + "enum": [ + "SYNCED_TABLE_PROVISIONING", + "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES", + "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT", + "SYNCED_TABLE_ONLINE", + "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE", + "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE", + "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE", + "SYNCED_TABLE_OFFLINE", + "SYNCED_TABLE_OFFLINE_FAILED", + "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", + "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enum_launch_stages": { + "SYNCED_TABLE_OFFLINE": "PUBLIC_BETA", + "SYNCED_TABLE_OFFLINE_FAILED": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE_PIPELINE_FAILED": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE": "PUBLIC_BETA", + "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES": "PUBLIC_BETA", + "SYNCED_TABLE_PROVISIONING": "PUBLIC_BETA", + "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT": "PUBLIC_BETA", + "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES": "PUBLIC_BETA" + } + }, + "postgres.SyncedTableSyncedTableSpec": { + "fields": { + "branch": { + "description": "The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.\nThe request will fail if this is false and the database/schema do not exist.\n\nDefaults to true if omitted.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "existing_pipeline_id": { + "description": "ID of an existing pipeline to bin-pack this synced table into.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "new_pipeline_spec": { + "description": "Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "ref": "postgres.NewPipelineSpec", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "postgres_database": { + "description": "The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "primary_key_columns": { + "description": "Primary Key columns to be used for data insert/update in the destination.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "scheduling_policy": { + "description": "Scheduling policy of the underlying pipeline.", + "ref": "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "source_table_full_name": { + "description": "Three-part (catalog, schema, table) name of the source Delta table.\n\nFor the corresponding destination table, use any of the two:\n\n* synced_table_id used at the creation of the SyncedTable\n* \"name\" consisting of \"synced_tables/\" prefix and the full name of the destination table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "timeseries_key": { + "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { + "description": "Scheduling policy of the synced table's underlying pipeline.", + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ], + "enum_launch_stages": { + "CONTINUOUS": "PUBLIC_BETA", + "SNAPSHOT": "PUBLIC_BETA", + "TRIGGERED": "PUBLIC_BETA" + } + }, + "postgres.SyncedTableSyncedTableStatus": { + "fields": { + "detailed_state": { + "description": "The state of the synced table.", + "ref": "postgres.SyncedTableState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_processed_commit_version": { + "description": "The last source table Delta version that was successfully synced to the synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_sync": { + "description": "Summary of the last successful synchronization from source to destination.", + "ref": "postgres.SyncedTablePosition", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "last_sync_time": { + "description": "The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "A text description of the current state of the synced table.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "ongoing_sync_progress": { + "ref": "postgres.SyncedTablePipelineProgress", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "pipeline_id": { + "description": "ID of the associated pipeline.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "project": { + "description": "The full resource name of the project associated with the table.\n\nFormat: \"projects/{project_id}\".", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "provisioning_phase": { + "description": "The current phase of the data synchronization pipeline.", + "ref": "postgres.ProvisioningPhase", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "unity_catalog_provisioning_state": { + "description": "The provisioning state of the synced table entity in Unity Catalog.", + "ref": "postgres.ProvisioningInfoState", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.UndeleteBranchRequest": {}, + "postgres.UndeleteProjectRequest": { + "description": "Request to restore a soft-deleted project within its retention period." + }, + "provisioning.AwsCredentials": { + "fields": { + "sts_role": { + "ref": "provisioning.StsRole", + "launch_stage": "GA" + } + } + }, + "provisioning.AwsKeyInfo": { + "fields": { + "key_alias": { + "description": "The AWS KMS key alias.", + "launch_stage": "GA" + }, + "key_arn": { + "description": "The AWS KMS key's Amazon Resource Name (ARN).", + "launch_stage": "GA" + }, + "key_region": { + "description": "The AWS KMS key region.", + "launch_stage": "GA" + }, + "reuse_key_for_cluster_volumes": { + "description": "This field applies only if the `use_cases` property includes `STORAGE`. If this is set to true or omitted, the key is also used to encrypt\ncluster EBS volumes. If you do not want to use this key for encrypting EBS volumes, set to false.", + "launch_stage": "GA" + } + } + }, + "provisioning.AzureKeyInfo": { + "fields": { + "disk_encryption_set_id": { + "description": "The Disk Encryption Set id that is used to represent the key info used for\nManaged Disk BYOK use case", + "launch_stage": "GA" + }, + "key_access_configuration": { + "description": "The structure to store key access credential\nThis is set if the Managed Identity is being used to access the Azure Key Vault key.", + "ref": "provisioning.KeyAccessConfiguration", + "launch_stage": "GA" + }, + "key_name": { + "description": "The name of the key in KeyVault.", + "launch_stage": "GA" + }, + "key_vault_uri": { + "description": "The base URI of the KeyVault.", + "launch_stage": "GA" + }, + "tenant_id": { + "description": "The tenant id where the KeyVault lives.", + "launch_stage": "GA" + }, + "version": { + "description": "The current key version.", + "launch_stage": "GA" + } + } + }, + "provisioning.AzureWorkspaceInfo": { + "fields": { + "resource_group": { + "description": "Azure Resource Group name", + "launch_stage": "GA" + }, + "subscription_id": { + "description": "Azure Subscription ID", + "launch_stage": "GA" + } + } + }, + "provisioning.CloudResourceContainer": { + "fields": { + "gcp": { + "ref": "provisioning.CustomerFacingGcpCloudResourceContainer", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateAwsKeyInfo": { + "fields": { + "key_alias": { + "description": "The AWS KMS key alias.", + "launch_stage": "GA" + }, + "key_arn": { + "description": "The AWS KMS key's Amazon Resource Name (ARN).", + "launch_stage": "GA" + }, + "key_region": { + "description": "The AWS KMS key region.", + "launch_stage": "GA" + }, + "reuse_key_for_cluster_volumes": { + "description": "This field applies only if the `use_cases` property includes `STORAGE`. If this is set to true or omitted, the key is also used to encrypt\ncluster EBS volumes. If you do not want to use this key for encrypting EBS volumes, set to false.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateAzureKeyInfo": { + "fields": { + "disk_encryption_set_id": { + "description": "The Disk Encryption Set id that is used to represent the key info used for\nManaged Disk BYOK use case", + "launch_stage": "PRIVATE_PREVIEW" + }, + "key_access_configuration": { + "description": "The structure to store key access credential\nThis is set if the Managed Identity is being used to access the Azure Key Vault key.", + "ref": "provisioning.KeyAccessConfiguration", + "launch_stage": "PRIVATE_PREVIEW" + }, + "key_name": { + "description": "The name of the key in KeyVault.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "key_vault_uri": { + "description": "The base URI of the KeyVault.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "tenant_id": { + "description": "The tenant id where the KeyVault lives.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "version": { + "description": "The current key version.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "provisioning.CreateCredentialAwsCredentials": { + "fields": { + "sts_role": { + "ref": "provisioning.CreateCredentialStsRole", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateCredentialRequest": { + "fields": { + "aws_credentials": { + "ref": "provisioning.CreateCredentialAwsCredentials", + "launch_stage": "GA" + }, + "credentials_name": { + "description": "The human-readable name of the credential configuration object.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateCredentialStsRole": { + "fields": { + "role_arn": { + "description": "The Amazon Resource Name (ARN) of the cross account IAM role.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateCustomerManagedKeyRequest": { + "fields": { + "aws_key_info": { + "ref": "provisioning.CreateAwsKeyInfo", + "launch_stage": "GA" + }, + "azure_key_info": { + "ref": "provisioning.CreateAzureKeyInfo", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "gcp_key_info": { + "ref": "provisioning.CreateGcpKeyInfo", + "launch_stage": "GA" + }, + "use_cases": { + "description": "The cases that the key can be used for.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateGcpKeyInfo": { + "fields": { + "gcp_service_account": { + "description": "Globally unique service account email that has access to the KMS key.\nThe service account exists within the Databricks CP project.", + "ref": "provisioning.GcpServiceAccount", + "launch_stage": "GA" + }, + "kms_key_id": { + "description": "Globally unique kms key resource id of the form\nprojects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4", + "launch_stage": "GA" + }, + "manual": { + "description": "When true, Databricks will not use OAuth to grant the service account\naccess to the KMS key. The customer is responsible for granting access\nmanually.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "provisioning.CreateNetworkRequest": { + "fields": { + "gcp_network_info": { + "ref": "provisioning.GcpNetworkInfo", + "launch_stage": "GA" + }, + "network_name": { + "description": "The human-readable name of the network configuration.", + "launch_stage": "GA" + }, + "security_group_ids": { + "description": "IDs of one to five security groups associated with this network. Security group IDs **cannot** be used in multiple network configurations.", + "launch_stage": "GA" + }, + "subnet_ids": { + "description": "IDs of at least two subnets associated with this network. Subnet IDs **cannot** be used in multiple network configurations.", + "launch_stage": "GA" + }, + "vpc_endpoints": { + "ref": "provisioning.NetworkVPCEndpoints", + "launch_stage": "GA" + }, + "vpc_id": { + "description": "The ID of the VPC associated with this network configuration. VPC IDs can be used in multiple networks.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreatePrivateAccessSettingsRequest": { + "fields": { + "allowed_vpc_endpoint_ids": { + "description": "An array of Databricks VPC endpoint IDs. This is the Databricks ID returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\nOnly used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints registered in your Databricks account that can connect to your workspace over AWS PrivateLink.\nNote: If hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.", + "launch_stage": "GA" + }, + "private_access_level": { + "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object.\n`ACCOUNT` level access (the default) allows only VPC endpoints that are registered in your Databricks account connect to your workspace.\n`ENDPOINT` level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.", + "ref": "provisioning.PrivateAccessLevel", + "launch_stage": "GA" + }, + "private_access_settings_name": { + "description": "The human-readable name of the private access settings object.", + "launch_stage": "GA" + }, + "public_access_enabled": { + "description": "Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.", + "launch_stage": "GA" + }, + "region": { + "description": "The AWS region for workspaces attached to this private access settings object.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateStorageConfigurationRequest": { + "fields": { + "role_arn": { + "description": "Optional IAM role that is used to access the workspace catalog which is created during workspace creation\nfor UC by Default. If a storage configuration with this field populated is used to create a workspace,\nthen a workspace catalog is created together with the workspace. The workspace catalog shares the root\nbucket with internal workspace storage (including DBFS root) but uses a dedicated bucket path prefix.", + "launch_stage": "GA" + }, + "root_bucket_info": { + "description": "Root S3 bucket information.", + "ref": "provisioning.RootBucketInfo", + "launch_stage": "GA" + }, + "storage_configuration_name": { + "description": "The human-readable name of the storage configuration.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateVpcEndpointRequest": { + "fields": { + "aws_vpc_endpoint_id": { + "description": "The ID of the VPC endpoint object in AWS.", + "launch_stage": "GA" + }, + "gcp_vpc_endpoint_info": { + "description": "The cloud info of this vpc endpoint.", + "ref": "provisioning.GcpVpcEndpointInfo", + "launch_stage": "GA" + }, + "region": { + "description": "The region in which this VPC endpoint object exists.", + "launch_stage": "GA" + }, + "vpc_endpoint_name": { + "description": "The human-readable name of the storage configuration.", + "launch_stage": "GA" + } + } + }, + "provisioning.CreateWorkspaceRequest": { + "fields": { + "aws_region": { + "launch_stage": "GA" + }, + "cloud": { + "description": "DEPRECATED: This field is being ignored by the server and will be removed in the future.\nThe cloud name. This field always has the value `gcp`.", + "deprecated": true, + "launch_stage": "GA" + }, + "cloud_resource_container": { + "ref": "provisioning.CloudResourceContainer", + "launch_stage": "GA" + }, + "compute_mode": { + "description": "If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don't need to provide any resources managed by you, such as credentials, storage, or network.\nIf the compute mode is `HYBRID` (which is the default option), a classic workspace is created that uses customer-managed resources.", + "ref": "provisioning.CustomerFacingComputeMode", + "launch_stage": "GA" + }, + "credentials_id": { + "description": "ID of the workspace's credential configuration object.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The\nvalue can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.", + "launch_stage": "GA" + }, + "deployment_name": { + "description": "The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is \u003cworkspace-deployment-name\u003e.cloud.databricks.com. For example, if the deployment name is abcsales, your workspace URL will be https://abcsales.cloud.databricks.com. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain.\nTo set this value, you must have a deployment name prefix. Contact your Databricks account team to add an account deployment name prefix to your account.\nWorkspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is acme and the workspace deployment name is workspace-1, the JSON response for the deployment_name field becomes acme-workspace-1. The workspace URL would be acme-workspace-1.cloud.databricks.com.\nYou can also set the deployment_name to the reserved keyword EMPTY if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is acme and the workspace deployment name is EMPTY, the deployment_name becomes acme only and the workspace URL is acme.cloud.databricks.com.\nThis value must be unique across all non-deleted deployments across all AWS regions.\nIf a new workspace omits this property, the server generates a unique deployment name for you with the pattern dbc-xxxxxxxx-xxxx.", + "launch_stage": "GA" + }, + "gcp_managed_network_config": { + "ref": "provisioning.GcpManagedNetworkConfig", + "launch_stage": "GA" + }, + "gke_config": { + "ref": "provisioning.GkeConfig", + "launch_stage": "GA" + }, + "location": { + "description": "The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`).", + "launch_stage": "GA" + }, + "managed_services_customer_managed_key_id": { + "description": "The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property use_cases must contain MANAGED_SERVICES.", + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "The object ID of network connectivity config. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks and optional private link to access your resources.", + "launch_stage": "GA" + }, + "network_id": { + "description": "The ID of the workspace's network configuration object. To use AWS PrivateLink, this field is required.", + "launch_stage": "GA" + }, + "pricing_tier": { + "ref": "provisioning.PricingTier", + "launch_stage": "GA" + }, + "private_access_settings_id": { + "description": "ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.\nBefore configuring PrivateLink, read the [Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\",", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "ID of the workspace's storage configuration object.", + "launch_stage": "GA" + }, + "storage_customer_managed_key_id": { + "description": "The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property use_cases must contain STORAGE.", + "launch_stage": "GA" + }, + "workspace_name": { + "description": "The human-readable name of the workspace.", + "launch_stage": "GA" + } + } + }, + "provisioning.Credential": { + "fields": { + "account_id": { + "description": "The Databricks account ID that hosts the credential.", + "launch_stage": "GA" + }, + "aws_credentials": { + "ref": "provisioning.AwsCredentials", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when the credential was created.", + "launch_stage": "GA" + }, + "credentials_id": { + "description": "Databricks credential configuration ID.", + "launch_stage": "GA" + }, + "credentials_name": { + "description": "The human-readable name of the credential configuration object.", + "launch_stage": "GA" + } + } + }, + "provisioning.CustomerFacingComputeMode": { + "description": "Corresponds to compute mode defined here:\nhttps://src.dev.databricks.com/databricks/universe@9076536b18479afd639d1c1f9dd5a59f72215e69/-/blob/central/api/common.proto?L872", + "enum": [ + "HYBRID", + "SERVERLESS" + ], + "enum_launch_stages": { + "HYBRID": "GA", + "SERVERLESS": "GA" + } + }, + "provisioning.CustomerFacingGcpCloudResourceContainer": { + "fields": { + "project_id": { + "launch_stage": "GA" + } + } + }, + "provisioning.CustomerFacingStorageMode": { + "enum": [ + "CUSTOMER_HOSTED", + "DEFAULT_STORAGE" + ], + "enum_launch_stages": { + "CUSTOMER_HOSTED": "GA", + "DEFAULT_STORAGE": "GA" + } + }, + "provisioning.CustomerManagedKey": { + "fields": { + "account_id": { + "description": "The Databricks account ID that holds the customer-managed key.", + "launch_stage": "GA" + }, + "aws_key_info": { + "ref": "provisioning.AwsKeyInfo", + "launch_stage": "GA" + }, + "azure_key_info": { + "ref": "provisioning.AzureKeyInfo", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when the customer key was created.", + "launch_stage": "GA" + }, + "customer_managed_key_id": { + "description": "ID of the encryption key configuration object.", + "launch_stage": "GA" + }, + "gcp_key_info": { + "ref": "provisioning.GcpKeyInfo", + "launch_stage": "GA" + }, + "use_cases": { + "description": "The cases that the key can be used for.", + "launch_stage": "GA" + } + } + }, + "provisioning.EndpointUseCase": { + "enum": [ + "WORKSPACE_ACCESS", + "DATAPLANE_RELAY_ACCESS", + "GENERAL_ACCESS" + ], + "enum_launch_stages": { + "DATAPLANE_RELAY_ACCESS": "GA", + "GENERAL_ACCESS": "PUBLIC_BETA", + "WORKSPACE_ACCESS": "GA" + } + }, + "provisioning.ErrorType": { + "description": "ErrorType and WarningType are used to represent the type of error or warning by NetworkHealth and NetworkWarning defined in central/api/accounts/accounts.proto", + "enum": [ + "credentials", + "vpc", + "subnet", + "securityGroup", + "networkAcl" + ], + "enum_launch_stages": { + "credentials": "GA", + "networkAcl": "GA", + "securityGroup": "GA", + "subnet": "GA", + "vpc": "GA" + } + }, + "provisioning.GcpCommonNetworkConfig": { + "description": "The shared network config for GCP workspace.\nThis object has common network configurations that are network attributions of a workspace.\nDEPRECATED. Use GkeConfig instead.", + "fields": { + "gke_cluster_master_ip_range": { + "description": "The IP range that will be used to allocate GKE cluster master resources from.\nThis field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.", + "launch_stage": "GA" + }, + "gke_connectivity_type": { + "description": "The type of network connectivity of the GKE cluster.", + "ref": "provisioning.GkeConfigConnectivityType", + "launch_stage": "GA" + } + } + }, + "provisioning.GcpKeyInfo": { + "fields": { + "gcp_service_account": { + "description": "Globally unique service account email that has access to the KMS key.\nThe service account exists within the Databricks CP project.", + "ref": "provisioning.GcpServiceAccount", + "launch_stage": "GA" + }, + "kms_key_id": { + "description": "Globally unique kms key resource id of the form\nprojects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4", + "launch_stage": "GA" + }, + "manual": { + "description": "When true, Databricks will not use OAuth to grant the service account\naccess to the KMS key. The customer is responsible for granting access\nmanually.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "provisioning.GcpManagedNetworkConfig": { + "description": "The network configuration for the workspace.", + "fields": { + "gke_cluster_pod_ip_range": { + "description": "The IP range that will be used to allocate GKE cluster Pods from.", + "launch_stage": "GA" + }, + "gke_cluster_service_ip_range": { + "description": "The IP range that will be used to allocate GKE cluster Services from.", + "launch_stage": "GA" + }, + "subnet_cidr": { + "description": "The IP range which will be used to allocate GKE cluster nodes from.\nNote: Pods, services and master IP range must be mutually exclusive.", + "launch_stage": "GA" + } + } + }, + "provisioning.GcpNetworkInfo": { + "fields": { + "network_project_id": { + "description": "The GCP project ID for network resources. This project is where the VPC and subnet resides.", + "launch_stage": "GA" + }, + "pod_ip_range_name": { + "description": "Name of the secondary range within the subnet that will be used by GKE as Pod IP range.\nThis is BYO VPC specific. DB VPC uses network.getGcpManagedNetworkConfig.getGkeClusterPodIpRange", + "launch_stage": "GA" + }, + "service_ip_range_name": { + "description": "Name of the secondary range within the subnet that will be used by GKE as Service IP range.", + "launch_stage": "GA" + }, + "subnet_id": { + "description": "The customer-provided Subnet ID that will be available to Clusters in Workspaces using this\nNetwork.", + "launch_stage": "GA" + }, + "subnet_region": { + "launch_stage": "GA" + }, + "vpc_id": { + "description": "The customer-provided VPC ID.", + "launch_stage": "GA" + } + } + }, + "provisioning.GcpServiceAccount": { + "fields": { + "service_account_email": { + "launch_stage": "GA" + } + } + }, + "provisioning.GcpVpcEndpointInfo": { + "fields": { + "endpoint_region": { + "launch_stage": "GA" + }, + "project_id": { + "launch_stage": "GA" + }, + "psc_connection_id": { + "launch_stage": "GA" + }, + "psc_endpoint_name": { + "launch_stage": "GA" + }, + "service_attachment_id": { + "launch_stage": "GA" + } + } + }, + "provisioning.GkeConfig": { + "description": "The configurations of the GKE cluster used by the GCP workspace.", + "fields": { + "connectivity_type": { + "description": "The type of network connectivity of the GKE cluster.", + "ref": "provisioning.GkeConfigConnectivityType", + "launch_stage": "GA" + }, + "master_ip_range": { + "description": "The IP range that will be used to allocate GKE cluster master resources from.\nThis field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.", + "launch_stage": "GA" + } + } + }, + "provisioning.GkeConfigConnectivityType": { + "description": "Specifies the network connectivity types for the GKE nodes and the GKE master network.\n\nSet to `PRIVATE_NODE_PUBLIC_MASTER` for a private GKE cluster\nfor the workspace. The GKE nodes will not have public IPs.\n\nSet to `PUBLIC_NODE_PUBLIC_MASTER` for a public GKE cluster.\nThe nodes of a public GKE cluster have public IP addresses.", + "enum": [ + "PRIVATE_NODE_PUBLIC_MASTER", + "PUBLIC_NODE_PUBLIC_MASTER" + ], + "enum_launch_stages": { + "PRIVATE_NODE_PUBLIC_MASTER": "GA", + "PUBLIC_NODE_PUBLIC_MASTER": "GA" + } + }, + "provisioning.KeyAccessConfiguration": { + "description": "The credential ID that is used to access the key vault.", + "fields": { + "credential_id": { + "launch_stage": "GA" + } + } + }, + "provisioning.KeyUseCase": { + "enum": [ + "MANAGED_SERVICES", + "STORAGE" + ], + "enum_launch_stages": { + "MANAGED_SERVICES": "GA", + "STORAGE": "GA" + } + }, + "provisioning.Network": { + "fields": { + "account_id": { + "description": "The Databricks account ID associated with this network configuration.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when the network was created.", + "launch_stage": "GA" + }, + "error_messages": { + "description": "Array of error messages about the network configuration.", + "launch_stage": "GA" + }, + "gcp_network_info": { + "ref": "provisioning.GcpNetworkInfo", + "launch_stage": "GA" + }, + "network_id": { + "description": "The Databricks network configuration ID.", + "launch_stage": "GA" + }, + "network_name": { + "description": "The human-readable name of the network configuration.", + "launch_stage": "GA" + }, + "security_group_ids": { + "description": "IDs of one to five security groups associated with this network. Security group IDs **cannot** be used in multiple network configurations.", + "launch_stage": "GA" + }, + "subnet_ids": { + "description": "IDs of at least two subnets associated with this network. Subnet IDs **cannot** be used in multiple network configurations.", + "launch_stage": "GA" + }, + "vpc_endpoints": { + "ref": "provisioning.NetworkVPCEndpoints", + "launch_stage": "GA" + }, + "vpc_id": { + "description": "The ID of the VPC associated with this network configuration. VPC IDs can be used in multiple networks.", + "launch_stage": "GA" + }, + "vpc_status": { + "ref": "provisioning.VpcStatus", + "launch_stage": "GA" + }, + "warning_messages": { + "description": "Array of warning messages about the network configuration.", + "launch_stage": "GA" + }, + "workspace_id": { + "description": "Workspace ID associated with this network configuration.", + "launch_stage": "GA" + } + } + }, + "provisioning.NetworkHealth": { + "fields": { + "error_message": { + "description": "Details of the error.", + "launch_stage": "GA" + }, + "error_type": { + "ref": "provisioning.ErrorType", + "launch_stage": "GA" + } + } + }, + "provisioning.NetworkVPCEndpoints": { + "fields": { + "dataplane_relay": { + "description": "The VPC endpoint ID used by this network to access the Databricks secure cluster connectivity relay.", + "launch_stage": "GA" + }, + "rest_api": { + "description": "The VPC endpoint ID used by this network to access the Databricks REST API.", + "launch_stage": "GA" + } + } + }, + "provisioning.NetworkWarning": { + "fields": { + "warning_message": { + "description": "Details of the warning.", + "launch_stage": "GA" + }, + "warning_type": { + "ref": "provisioning.WarningType", + "launch_stage": "GA" + } + } + }, + "provisioning.PricingTier": { + "enum": [ + "UNKNOWN", + "COMMUNITY_EDITION", + "STANDARD", + "PREMIUM", + "ENTERPRISE", + "DEDICATED" + ], + "enum_launch_stages": { + "COMMUNITY_EDITION": "GA", + "DEDICATED": "GA", + "ENTERPRISE": "GA", + "PREMIUM": "GA", + "STANDARD": "GA", + "UNKNOWN": "GA" + } + }, + "provisioning.PrivateAccessLevel": { + "enum": [ + "ENDPOINT", + "ACCOUNT" + ], + "enum_launch_stages": { + "ACCOUNT": "GA", + "ENDPOINT": "GA" + } + }, + "provisioning.PrivateAccessSettings": { + "description": "*", + "fields": { + "account_id": { + "description": "The Databricks account ID that hosts the private access settings.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "allowed_vpc_endpoint_ids": { + "description": "An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\nOnly used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink.\nIf hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.", + "launch_stage": "GA" + }, + "private_access_level": { + "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object.\n`ACCOUNT` level access (the default) allows only VPC endpoints that are registered in your Databricks account connect to your workspace.\n`ENDPOINT` level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.", + "ref": "provisioning.PrivateAccessLevel", + "launch_stage": "GA" + }, + "private_access_settings_id": { + "description": "Databricks private access settings ID.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "private_access_settings_name": { + "description": "The human-readable name of the private access settings object.", + "launch_stage": "GA" + }, + "public_access_enabled": { + "description": "Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.", + "launch_stage": "GA" + }, + "region": { + "description": "The AWS region for workspaces attached to this private access settings object.", + "launch_stage": "GA" + } + } + }, + "provisioning.RootBucketInfo": { + "fields": { + "bucket_name": { + "description": "Name of the S3 bucket", + "launch_stage": "GA" + } + } + }, + "provisioning.StorageConfiguration": { + "fields": { + "account_id": { + "description": "The Databricks account ID associated with this storage configuration.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when the storage configuration was created.", + "launch_stage": "GA" + }, + "role_arn": { + "description": "Optional IAM role that is used to access the workspace catalog which is created during workspace creation\nfor UC by Default. If a storage configuration with this field populated is used to create a workspace,\nthen a workspace catalog is created together with the workspace. The workspace catalog shares the root\nbucket with internal workspace storage (including DBFS root) but uses a dedicated bucket path prefix.", + "launch_stage": "GA" + }, + "root_bucket_info": { + "description": "The root bucket information for the storage configuration.", + "ref": "provisioning.RootBucketInfo", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "Databricks storage configuration ID.", + "launch_stage": "GA" + }, + "storage_configuration_name": { + "description": "The human-readable name of the storage configuration.", + "launch_stage": "GA" + } + } + }, + "provisioning.StsRole": { + "fields": { + "role_arn": { + "description": "The Amazon Resource Name (ARN) of the cross account IAM role.", + "launch_stage": "GA" + } + } + }, + "provisioning.VPCEndpoint": { + "description": "*", + "fields": { + "account_id": { + "description": "The Databricks account ID that hosts the VPC endpoint configuration.\nTODO - This may signal an OpenAPI diff; it does not show up in the generated spec", + "launch_stage": "GA" + }, + "aws_account_id": { + "description": "The AWS Account in which the VPC endpoint object exists.", + "launch_stage": "GA" + }, + "aws_endpoint_service_id": { + "description": "The ID of the Databricks [endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html) that this VPC endpoint is connected to. For a list of endpoint service IDs for each supported AWS region, see the [Databricks PrivateLink documentation](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).", + "launch_stage": "GA" + }, + "aws_vpc_endpoint_id": { + "description": "The ID of the VPC endpoint object in AWS.", + "launch_stage": "GA" + }, + "gcp_vpc_endpoint_info": { + "description": "The cloud info of this vpc endpoint.\nInfo for a GCP vpc endpoint.", + "ref": "provisioning.GcpVpcEndpointInfo", + "launch_stage": "GA" + }, + "region": { + "description": "The AWS region in which this VPC endpoint object exists.", + "launch_stage": "GA" + }, + "state": { + "description": "The current state (such as `available` or `rejected`) of the VPC endpoint. Derived from AWS. For the full set of values, see [AWS DescribeVpcEndpoint documentation](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).", + "launch_stage": "GA" + }, + "use_case": { + "description": "This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint.\nIf the VPC endpoint connects to the Databricks control plane for either the front-end connection or the back-end REST API connection, the value is GENERAL_ACCESS.\nIf the VPC endpoint connects to the Databricks workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS.", + "ref": "provisioning.EndpointUseCase", + "launch_stage": "GA" + }, + "vpc_endpoint_id": { + "description": "Databricks VPC endpoint ID. This is the Databricks-specific name of the VPC endpoint. Do not confuse this with the `aws_vpc_endpoint_id`, which is the ID within AWS of the VPC endpoint.", + "launch_stage": "GA" + }, + "vpc_endpoint_name": { + "description": "The human-readable name of the storage configuration.", + "launch_stage": "GA" + } + } + }, + "provisioning.VpcStatus": { + "enum": [ + "VALID", + "BROKEN", + "UNATTACHED", + "WARNED" + ], + "enum_launch_stages": { + "BROKEN": "GA", + "UNATTACHED": "GA", + "VALID": "GA", + "WARNED": "GA" + } + }, + "provisioning.WarningType": { + "enum": [ + "subnet", + "securityGroup" + ], + "enum_launch_stages": { + "securityGroup": "GA", + "subnet": "GA" + } + }, + "provisioning.Workspace": { + "fields": { + "account_id": { + "description": "Databricks account ID.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "aws_region": { + "launch_stage": "GA" + }, + "azure_workspace_info": { + "ref": "provisioning.AzureWorkspaceInfo", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "cloud": { + "description": "The cloud name. This field can have values like `azure`, `gcp`.", + "launch_stage": "GA" + }, + "cloud_resource_container": { + "ref": "provisioning.CloudResourceContainer", + "launch_stage": "GA" + }, + "compute_mode": { + "description": "The compute mode of the workspace.", + "ref": "provisioning.CustomerFacingComputeMode", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creation_time": { + "description": "Time in epoch milliseconds when the workspace was created.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "credentials_id": { + "description": "ID of the workspace's credential configuration object.", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string,\nwith maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.", + "launch_stage": "GA" + }, + "deployment_name": { + "launch_stage": "GA" + }, + "expected_workspace_status": { + "description": "A client owned field used to indicate the workspace status that the client expects to be in.\nFor now this is only used to unblock Temporal workflow for GCP least privileged workspace.", + "ref": "provisioning.WorkspaceStatus", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "gcp_managed_network_config": { + "ref": "provisioning.GcpManagedNetworkConfig", + "launch_stage": "GA" + }, + "gke_config": { + "ref": "provisioning.GkeConfig", + "launch_stage": "GA" + }, + "location": { + "description": "The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`).", + "launch_stage": "GA" + }, + "managed_services_customer_managed_key_id": { + "description": "ID of the key configuration for encrypting managed services.", + "launch_stage": "GA" + }, + "network": { + "description": "The network configuration for the workspace.\n\nDEPRECATED. Use `network_id` instead.", + "ref": "provisioning.WorkspaceNetwork", + "deprecated": true, + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "The object ID of network connectivity config.", + "launch_stage": "GA" + }, + "network_id": { + "description": "If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not\nBYO VPC, then the network_id will be empty.", + "launch_stage": "GA" + }, + "pricing_tier": { + "ref": "provisioning.PricingTier", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "private_access_settings_id": { + "description": "ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.\n\nBefore configuring PrivateLink, read the [Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\",", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "ID of the workspace's storage configuration object.", + "launch_stage": "GA" + }, + "storage_customer_managed_key_id": { + "description": "ID of the key configuration for encrypting workspace storage.", + "launch_stage": "GA" + }, + "storage_mode": { + "description": "The storage mode of the workspace.", + "ref": "provisioning.CustomerFacingStorageMode", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "workspace_id": { + "description": "A unique integer ID for the workspace", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "workspace_name": { + "description": "The human-readable name of the workspace.", + "launch_stage": "GA" + }, + "workspace_status": { + "description": "The status of a workspace", + "ref": "provisioning.WorkspaceStatus", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "workspace_status_message": { + "description": "Message describing the current workspace status.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "provisioning.WorkspaceNetwork": { + "description": "The network configuration for workspaces.", + "fields": { + "gcp_common_network_config": { + "description": "The shared network config for GCP workspace.\nThis object has common network configurations that are network attributions of a workspace.\nThis object is input-only.", + "ref": "provisioning.GcpCommonNetworkConfig", + "launch_stage": "GA" + }, + "gcp_managed_network_config": { + "description": "The mutually exclusive network deployment modes. The option decides which network mode the\nworkspace will use.\nThe network config for GCP workspace with Databricks managed network.\nThis object is input-only and will not be provided when listing workspaces.\nSee go/gcp-byovpc-alpha-design for interface decisions.", + "ref": "provisioning.GcpManagedNetworkConfig", + "launch_stage": "GA" + }, + "network_id": { + "description": "The ID of the network object, if the workspace is a BYOVPC workspace.\nThis should apply to workspaces on all clouds in internal services. In accounts-rest-api, user will use\nworkspace.network_id for input and output instead.\nCurrently (2021-06-19) the network ID is only used by GCP.", + "launch_stage": "GA" + } + } + }, + "provisioning.WorkspaceStatus": { + "description": "The different statuses of a workspace. The following represents the current set of valid\ntransitions from status to status:\nNOT_PROVISIONED\n-\u003e PROVISIONING\n-\u003e CANCELLED\nPROVISIONING\n-\u003e RUNNING\n-\u003e FAILED\n-\u003e CANCELLED (note that this transition is disallowed in the MultiWorkspace Project)\nRUNNING\n-\u003e PROVISIONING\n-\u003e BANNED\n-\u003e CANCELLED\nFAILED\n-\u003e PROVISIONING\n-\u003e CANCELLED\nBANNED\n-\u003e RUNNING\n-\u003e CANCELLED\nNote that a transition from any state to itself is also valid.\nTODO(PLAT-5867): add a transition from CANCELLED to some other value (e.g. RECOVERING)", + "enum": [ + "NOT_PROVISIONED", + "PROVISIONING", + "RUNNING", + "FAILED", + "BANNED", + "CANCELLING" + ], + "enum_launch_stages": { + "BANNED": "GA", + "CANCELLING": "GA", + "FAILED": "GA", + "NOT_PROVISIONED": "GA", + "PROVISIONING": "GA", + "RUNNING": "GA" + } + }, + "qualitymonitorv2.AnomalyDetectionConfig": { + "fields": { + "excluded_table_full_names": { + "description": "List of fully qualified table names to exclude from anomaly detection.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "last_run_id": { + "description": "Run id of the last run of the workflow", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "latest_run_status": { + "description": "The status of the last run of the workflow.", + "ref": "qualitymonitorv2.AnomalyDetectionRunStatus", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "qualitymonitorv2.AnomalyDetectionRunStatus": { + "description": "Status of Anomaly Detection Job Run", + "enum": [ + "ANOMALY_DETECTION_RUN_STATUS_UNKNOWN", + "ANOMALY_DETECTION_RUN_STATUS_RUNNING", + "ANOMALY_DETECTION_RUN_STATUS_CANCELED", + "ANOMALY_DETECTION_RUN_STATUS_PENDING", + "ANOMALY_DETECTION_RUN_STATUS_SUCCESS", + "ANOMALY_DETECTION_RUN_STATUS_FAILED", + "ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED", + "ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR" + ], + "enum_launch_stages": { + "ANOMALY_DETECTION_RUN_STATUS_CANCELED": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_FAILED": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_PENDING": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_RUNNING": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_SUCCESS": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_UNKNOWN": "PUBLIC_BETA", + "ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR": "PUBLIC_BETA" + } + }, + "qualitymonitorv2.ListQualityMonitorResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + }, + "quality_monitors": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "qualitymonitorv2.PercentNullValidityCheck": { + "fields": { + "column_names": { + "description": "List of column names to check for null percentage", + "launch_stage": "PUBLIC_BETA" + }, + "upper_bound": { + "description": "Optional upper bound; we should use auto determined bounds for now", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "qualitymonitorv2.QualityMonitor": { + "fields": { + "anomaly_detection_config": { + "ref": "qualitymonitorv2.AnomalyDetectionConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "object_id": { + "description": "The uuid of the request object. For example, schema id.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "object_type": { + "description": "The type of the monitored object. Can be one of the following: schema.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "validity_check_configurations": { + "description": "Validity check configurations for anomaly detection.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + } + } + }, + "qualitymonitorv2.RangeValidityCheck": { + "fields": { + "column_names": { + "description": "List of column names to check for range validity", + "launch_stage": "PUBLIC_BETA" + }, + "lower_bound": { + "description": "Lower bound for the range", + "launch_stage": "PUBLIC_BETA" + }, + "upper_bound": { + "description": "Upper bound for the range", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "qualitymonitorv2.UniquenessValidityCheck": { + "fields": { + "column_names": { + "description": "List of column names to check for uniqueness", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "qualitymonitorv2.ValidityCheckConfiguration": { + "fields": { + "name": { + "description": "Can be set by system. Does not need to be user facing.", + "launch_stage": "PUBLIC_BETA" + }, + "percent_null_validity_check": { + "ref": "qualitymonitorv2.PercentNullValidityCheck", + "launch_stage": "PUBLIC_BETA" + }, + "range_validity_check": { + "ref": "qualitymonitorv2.RangeValidityCheck", + "launch_stage": "PUBLIC_BETA" + }, + "uniqueness_validity_check": { + "ref": "qualitymonitorv2.UniquenessValidityCheck", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "serving.AI21LabsConfig": { + "fields": { + "ai21labs_api_key": { + "description": "The Databricks secret key reference for an AI21 Labs API key. If you\nprefer to paste your API key directly, see `ai21labs_api_key_plaintext`.\nYou must provide an API key using one of the following fields:\n`ai21labs_api_key` or `ai21labs_api_key_plaintext`.", + "launch_stage": "GA" + }, + "ai21labs_api_key_plaintext": { + "description": "An AI21 Labs API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `ai21labs_api_key`. You\nmust provide an API key using one of the following fields:\n`ai21labs_api_key` or `ai21labs_api_key_plaintext`.", + "launch_stage": "GA" + } + } + }, + "serving.AiGatewayConfig": { + "fields": { + "fallback_config": { + "description": "Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.", + "ref": "serving.FallbackConfig", + "launch_stage": "GA" + }, + "guardrails": { + "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "ref": "serving.AiGatewayGuardrails", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "inference_table_config": { + "description": "Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.", + "ref": "serving.AiGatewayInferenceTableConfig", + "launch_stage": "GA" + }, + "rate_limits": { + "description": "Configuration for rate limits which can be set to limit endpoint traffic.", + "launch_stage": "GA" + }, + "usage_tracking_config": { + "description": "Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.", + "ref": "serving.AiGatewayUsageTrackingConfig", + "launch_stage": "GA" + } + } + }, + "serving.AiGatewayGuardrailParameters": { + "fields": { + "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.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW" + }, + "pii": { + "description": "Configuration for guardrail PII filter.", + "ref": "serving.AiGatewayGuardrailPiiBehavior", + "launch_stage": "PUBLIC_PREVIEW" + }, + "safety": { + "description": "Indicates whether the safety filter is enabled.", + "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.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.AiGatewayGuardrailPiiBehavior": { + "fields": { + "behavior": { + "description": "Configuration for input guardrail filters.", + "ref": "serving.AiGatewayGuardrailPiiBehaviorBehavior", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.AiGatewayGuardrailPiiBehaviorBehavior": { + "enum": [ + "NONE", + "BLOCK", + "MASK" + ], + "enum_launch_stages": { + "BLOCK": "PUBLIC_PREVIEW", + "MASK": "PUBLIC_PREVIEW", + "NONE": "PUBLIC_PREVIEW" + } + }, + "serving.AiGatewayGuardrails": { + "fields": { + "input": { + "description": "Configuration for input guardrail filters.", + "ref": "serving.AiGatewayGuardrailParameters", + "launch_stage": "PUBLIC_PREVIEW" + }, + "output": { + "description": "Configuration for output guardrail filters.", + "ref": "serving.AiGatewayGuardrailParameters", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.AiGatewayInferenceTableConfig": { + "fields": { + "catalog_name": { + "description": "The name of the catalog in Unity Catalog. Required when enabling inference tables.\nNOTE: On update, you have to disable inference table first in order to change the catalog name.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Indicates whether the inference table is enabled.", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema in Unity Catalog. Required when enabling inference tables.\nNOTE: On update, you have to disable inference table first in order to change the schema name.", + "launch_stage": "GA" + }, + "table_name_prefix": { + "description": "The prefix of the table in Unity Catalog.\nNOTE: On update, you have to disable inference table first in order to change the prefix name.", + "launch_stage": "GA" + } + } + }, + "serving.AiGatewayRateLimit": { + "fields": { + "calls": { + "description": "Used to specify how many calls are allowed for a key within the renewal_period.", + "launch_stage": "GA" + }, + "key": { + "description": "Key field for a rate limit. Currently, 'user', 'user_group, 'service_principal', and 'endpoint' are supported,\nwith 'endpoint' being the default if not specified.", + "ref": "serving.AiGatewayRateLimitKey", + "launch_stage": "GA" + }, + "principal": { + "description": "Principal field for a user, user group, or service principal to apply rate limiting to. Accepts a user email, group name, or service principal application ID.", + "launch_stage": "GA" + }, + "renewal_period": { + "description": "Renewal period field for a rate limit. Currently, only 'minute' is supported.", + "ref": "serving.AiGatewayRateLimitRenewalPeriod", + "launch_stage": "GA" + }, + "tokens": { + "description": "Used to specify how many tokens are allowed for a key within the renewal_period.", + "launch_stage": "GA" + } + } + }, + "serving.AiGatewayRateLimitKey": { + "enum": [ + "user", + "endpoint", + "user_group", + "service_principal" + ], + "enum_launch_stages": { + "endpoint": "PUBLIC_PREVIEW", + "service_principal": "PUBLIC_PREVIEW", + "user": "PUBLIC_PREVIEW", + "user_group": "PUBLIC_PREVIEW" + } + }, + "serving.AiGatewayRateLimitRenewalPeriod": { + "enum": [ + "minute" + ], + "enum_launch_stages": { + "minute": "PUBLIC_PREVIEW" + } + }, + "serving.AiGatewayUsageTrackingConfig": { + "fields": { + "enabled": { + "description": "Whether to enable usage tracking.", + "launch_stage": "GA" + } + } + }, + "serving.AmazonBedrockConfig": { + "fields": { + "aws_access_key_id": { + "description": "The Databricks secret key reference for an AWS access key ID with\npermissions to interact with Bedrock services. If you prefer to paste\nyour API key directly, see `aws_access_key_id_plaintext`. You must provide an API\nkey using one of the following fields: `aws_access_key_id` or\n`aws_access_key_id_plaintext`.", + "launch_stage": "GA" + }, + "aws_access_key_id_plaintext": { + "description": "An AWS access key ID with permissions to interact with Bedrock services\nprovided as a plaintext string. If you prefer to reference your key using\nDatabricks Secrets, see `aws_access_key_id`. You must provide an API key\nusing one of the following fields: `aws_access_key_id` or\n`aws_access_key_id_plaintext`.", + "launch_stage": "GA" + }, + "aws_region": { + "description": "The AWS region to use. Bedrock has to be enabled there.", + "launch_stage": "GA" + }, + "aws_secret_access_key": { + "description": "The Databricks secret key reference for an AWS secret access key paired\nwith the access key ID, with permissions to interact with Bedrock\nservices. If you prefer to paste your API key directly, see\n`aws_secret_access_key_plaintext`. You must provide an API key using one\nof the following fields: `aws_secret_access_key` or\n`aws_secret_access_key_plaintext`.", + "launch_stage": "GA" + }, + "aws_secret_access_key_plaintext": { + "description": "An AWS secret access key paired with the access key ID, with permissions\nto interact with Bedrock services provided as a plaintext string. If you\nprefer to reference your key using Databricks Secrets, see\n`aws_secret_access_key`. You must provide an API key using one of the\nfollowing fields: `aws_secret_access_key` or\n`aws_secret_access_key_plaintext`.", + "launch_stage": "GA" + }, + "bedrock_provider": { + "description": "The underlying provider in Amazon Bedrock. Supported values (case\ninsensitive) include: Anthropic, Cohere, AI21Labs, Amazon.", + "ref": "serving.AmazonBedrockConfigBedrockProvider", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "ARN of the instance profile that the external model will use to access AWS resources.\nYou must authenticate using an instance profile or access keys.\nIf you prefer to authenticate using access keys, see `aws_access_key_id`,\n`aws_access_key_id_plaintext`, `aws_secret_access_key` and `aws_secret_access_key_plaintext`.", + "launch_stage": "GA" + } + } + }, + "serving.AmazonBedrockConfigBedrockProvider": { + "enum": [ + "anthropic", + "cohere", + "ai21labs", + "amazon" + ], + "enum_launch_stages": { + "ai21labs": "PUBLIC_PREVIEW", + "amazon": "PUBLIC_PREVIEW", + "anthropic": "PUBLIC_PREVIEW", + "cohere": "PUBLIC_PREVIEW" + } + }, + "serving.AnthropicConfig": { + "fields": { + "anthropic_api_key": { + "description": "The Databricks secret key reference for an Anthropic API key. If you\nprefer to paste your API key directly, see `anthropic_api_key_plaintext`.\nYou must provide an API key using one of the following fields:\n`anthropic_api_key` or `anthropic_api_key_plaintext`.", + "launch_stage": "GA" + }, + "anthropic_api_key_plaintext": { + "description": "The Anthropic API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `anthropic_api_key`. You\nmust provide an API key using one of the following fields:\n`anthropic_api_key` or `anthropic_api_key_plaintext`.", + "launch_stage": "GA" + } + } + }, + "serving.ApiKeyAuth": { + "fields": { + "key": { + "description": "The name of the API key parameter used for authentication.", + "launch_stage": "GA" + }, + "value": { + "description": "The Databricks secret key reference for an API Key.\nIf you prefer to paste your token directly, see `value_plaintext`.", + "launch_stage": "GA" + }, + "value_plaintext": { + "description": "The API Key provided as a plaintext string. If you prefer to reference your\ntoken using Databricks Secrets, see `value`.", + "launch_stage": "GA" + } + } + }, + "serving.AutoCaptureConfigInput": { + "description": "Deprecated: legacy inference table configuration. Please use AI Gateway inference tables instead.\nSee https://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "fields": { + "catalog_name": { + "description": "The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if the inference table is already enabled.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Indicates whether the inference table is enabled.", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if the inference table is already enabled.", + "launch_stage": "GA" + }, + "table_name_prefix": { + "description": "The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if the inference table is already enabled.", + "launch_stage": "GA" + } + } + }, + "serving.AutoCaptureConfigOutput": { + "description": "Deprecated: legacy inference table configuration. Please use AI Gateway inference tables instead.\nSee https://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "fields": { + "catalog_name": { + "description": "The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if the inference table is already enabled.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Indicates whether the inference table is enabled.", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if the inference table is already enabled.", + "launch_stage": "GA" + }, + "state": { + "ref": "serving.AutoCaptureState", + "launch_stage": "GA" + }, + "table_name_prefix": { + "description": "The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if the inference table is already enabled.", + "launch_stage": "GA" + } + } + }, + "serving.AutoCaptureState": { + "fields": { + "payload_table": { + "ref": "serving.PayloadTable", + "launch_stage": "GA" + } + } + }, + "serving.BearerTokenAuth": { + "fields": { + "token": { + "description": "The Databricks secret key reference for a token.\nIf you prefer to paste your token directly, see `token_plaintext`.", + "launch_stage": "GA" + }, + "token_plaintext": { + "description": "The token provided as a plaintext string. If you prefer to reference your\ntoken using Databricks Secrets, see `token`.", + "launch_stage": "GA" + } + } + }, + "serving.BuildLogsResponse": { + "fields": { + "logs": { + "description": "The logs associated with building the served entity's environment.", + "launch_stage": "GA" + } + } + }, + "serving.ChatMessage": { + "fields": { + "content": { + "description": "The content of the message.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "role": { + "description": "The role of the message. One of [system, user, assistant].", + "ref": "serving.ChatMessageRole", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.ChatMessageRole": { + "description": "The role of the message. One of [system, user, assistant].", + "enum": [ + "system", + "user", + "assistant" + ], + "enum_launch_stages": { + "assistant": "PUBLIC_PREVIEW", + "system": "PUBLIC_PREVIEW", + "user": "PUBLIC_PREVIEW" + } + }, + "serving.CohereConfig": { + "fields": { + "cohere_api_base": { + "description": "This is an optional field to provide a customized base URL for the Cohere\nAPI. If left unspecified, the standard Cohere base URL is used.", + "launch_stage": "GA" + }, + "cohere_api_key": { + "description": "The Databricks secret key reference for a Cohere API key. If you prefer\nto paste your API key directly, see `cohere_api_key_plaintext`. You must\nprovide an API key using one of the following fields: `cohere_api_key` or\n`cohere_api_key_plaintext`.", + "launch_stage": "GA" + }, + "cohere_api_key_plaintext": { + "description": "The Cohere API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `cohere_api_key`. You\nmust provide an API key using one of the following fields:\n`cohere_api_key` or `cohere_api_key_plaintext`.", + "launch_stage": "GA" + } + } + }, + "serving.CreatePtEndpointRequest": { + "fields": { + "ai_gateway": { + "description": "The AI Gateway configuration for the serving endpoint.", + "ref": "serving.AiGatewayConfig", + "launch_stage": "PUBLIC_PREVIEW" + }, + "budget_policy_id": { + "description": "The budget policy associated with the endpoint.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "config": { + "description": "The core config of the serving endpoint.", + "ref": "serving.PtEndpointCoreConfig", + "launch_stage": "PUBLIC_PREVIEW" + }, + "email_notifications": { + "description": "Email notification settings.", + "ref": "serving.EmailNotifications", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tags": { + "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.CreateServingEndpoint": { + "fields": { + "ai_gateway": { + "description": "The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", + "ref": "serving.AiGatewayConfig", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "The budget policy to be applied to the serving endpoint.", + "launch_stage": "GA" + }, + "config": { + "description": "The core config of the serving endpoint.", + "ref": "serving.EndpointCoreConfigInput", + "launch_stage": "GA" + }, + "description": { + "launch_stage": "GA" + }, + "email_notifications": { + "description": "Email notification settings.", + "ref": "serving.EmailNotifications", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "launch_stage": "GA" + }, + "rate_limits": { + "description": "Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.", + "deprecated": true, + "launch_stage": "GA" + }, + "route_optimized": { + "description": "Enable route optimization for the serving endpoint.", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.", + "launch_stage": "GA" + } + } + }, + "serving.CustomProviderConfig": { + "description": "Configs needed to create a custom provider model route.", + "fields": { + "api_key_auth": { + "description": "This is a field to provide API key authentication for the custom provider API.\nYou can only specify one authentication method.", + "ref": "serving.ApiKeyAuth", + "launch_stage": "GA" + }, + "bearer_token_auth": { + "description": "This is a field to provide bearer token authentication for the custom provider API.\nYou can only specify one authentication method.", + "ref": "serving.BearerTokenAuth", + "launch_stage": "GA" + }, + "custom_provider_url": { + "description": "This is a field to provide the URL of the custom provider API.", + "launch_stage": "GA" + } + } + }, + "serving.DataPlaneInfo": { + "description": "Details necessary to query this object's API through the DataPlane APIs.", + "fields": { + "authorization_details": { + "description": "Authorization details as a string.", + "launch_stage": "GA" + }, + "endpoint_url": { + "description": "The URL of the endpoint for this operation in the dataplane.", + "launch_stage": "GA" + } + } + }, + "serving.DatabricksModelServingConfig": { + "fields": { + "databricks_api_token": { + "description": "The Databricks secret key reference for a Databricks API token that\ncorresponds to a user or service principal with Can Query access to the\nmodel serving endpoint pointed to by this external model. If you prefer\nto paste your API key directly, see `databricks_api_token_plaintext`. You\nmust provide an API key using one of the following fields:\n`databricks_api_token` or `databricks_api_token_plaintext`.", + "launch_stage": "GA" + }, + "databricks_api_token_plaintext": { + "description": "The Databricks API token that corresponds to a user or service principal\nwith Can Query access to the model serving endpoint pointed to by this\nexternal model provided as a plaintext string. If you prefer to reference\nyour key using Databricks Secrets, see `databricks_api_token`. You must\nprovide an API key using one of the following fields:\n`databricks_api_token` or `databricks_api_token_plaintext`.", + "launch_stage": "GA" + }, + "databricks_workspace_url": { + "description": "The URL of the Databricks workspace containing the model serving endpoint\npointed to by this external model.", + "launch_stage": "GA" + } + } + }, + "serving.DataframeSplitInput": { + "fields": { + "columns": { + "description": "Columns array for the dataframe", + "launch_stage": "GA" + }, + "data": { + "description": "Data array for the dataframe", + "launch_stage": "GA" + }, + "index": { + "description": "Index array for the dataframe", + "launch_stage": "GA" + } + } + }, + "serving.EmailNotifications": { + "fields": { + "on_update_failure": { + "description": "A list of email addresses to be notified when an endpoint fails to update its configuration or state.", + "launch_stage": "GA" + }, + "on_update_success": { + "description": "A list of email addresses to be notified when an endpoint successfully updates its configuration or state.", + "launch_stage": "GA" + } + } + }, + "serving.EmbeddingsV1ResponseEmbeddingElement": { + "fields": { + "embedding": { + "description": "The embedding vector", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "index": { + "description": "The index of the embedding in the response.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "object": { + "description": "This will always be 'embedding'.", + "ref": "serving.EmbeddingsV1ResponseEmbeddingElementObject", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.EmbeddingsV1ResponseEmbeddingElementObject": { + "description": "This will always be 'embedding'.", + "enum": [ + "embedding" + ], + "enum_launch_stages": { + "embedding": "PUBLIC_PREVIEW" + } + }, + "serving.EndpointCoreConfigInput": { + "fields": { + "auto_capture_config": { + "description": "Configuration for legacy Inference Tables which automatically log requests and responses to Unity\nCatalog.\nDeprecated: please use AI Gateway inference tables instead. See\nhttps://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "ref": "serving.AutoCaptureConfigInput", + "deprecated": true, + "launch_stage": "GA" + }, + "served_entities": { + "description": "The list of served entities under the serving endpoint config.", + "launch_stage": "GA" + }, + "served_models": { + "description": "(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.", + "launch_stage": "GA" + }, + "traffic_config": { + "description": "The traffic configuration associated with the serving endpoint config.", + "ref": "serving.TrafficConfig", + "launch_stage": "GA" + } + } + }, + "serving.EndpointCoreConfigOutput": { + "fields": { + "auto_capture_config": { + "description": "Configuration for legacy Inference Tables which automatically log requests and responses to Unity\nCatalog.\nDeprecated: please use AI Gateway inference tables instead. See\nhttps://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "ref": "serving.AutoCaptureConfigOutput", + "deprecated": true, + "launch_stage": "GA" + }, + "config_version": { + "description": "The config version that the serving endpoint is currently serving.", + "launch_stage": "GA" + }, + "served_entities": { + "description": "The list of served entities under the serving endpoint config.", + "launch_stage": "GA" + }, + "served_models": { + "description": "(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.", + "launch_stage": "GA" + }, + "traffic_config": { + "description": "The traffic configuration associated with the serving endpoint config.", + "ref": "serving.TrafficConfig", + "launch_stage": "GA" + } + } + }, + "serving.EndpointCoreConfigSummary": { + "fields": { + "served_entities": { + "description": "The list of served entities under the serving endpoint config.", + "launch_stage": "GA" + }, + "served_models": { + "description": "(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.", + "launch_stage": "GA" + } + } + }, + "serving.EndpointPendingConfig": { + "fields": { + "auto_capture_config": { + "description": "Configuration for legacy Inference Tables which automatically log requests and responses to Unity\nCatalog.\nDeprecated: please use AI Gateway inference tables instead. See\nhttps://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "ref": "serving.AutoCaptureConfigOutput", + "deprecated": true, + "launch_stage": "GA" + }, + "config_version": { + "description": "The config version that the serving endpoint is currently serving.", + "launch_stage": "GA" + }, + "served_entities": { + "description": "The list of served entities belonging to the last issued update to the serving endpoint.", + "launch_stage": "GA" + }, + "served_models": { + "description": "(Deprecated, use served_entities instead) The list of served models belonging to the last issued update to the serving endpoint.", + "launch_stage": "GA" + }, + "start_time": { + "description": "The timestamp when the update to the pending config started.", + "launch_stage": "GA" + }, + "traffic_config": { + "description": "The traffic config defining how invocations to the serving endpoint should be routed.", + "ref": "serving.TrafficConfig", + "launch_stage": "GA" + } + } + }, + "serving.EndpointState": { + "fields": { + "config_update": { + "description": "The state of an endpoint's config update. This informs the user if the pending_config is in progress, if the\nupdate failed, or if there is no update in progress. Note that if the endpoint's config_update state value is\nIN_PROGRESS, another update can not be made until the update completes or fails.", + "ref": "serving.EndpointStateConfigUpdate", + "launch_stage": "GA" + }, + "ready": { + "description": "The state of an endpoint, indicating whether or not the endpoint is queryable. An endpoint is READY if all of\nthe served entities in its active configuration are ready. If any of the actively served entities are in a\nnon-ready state, the endpoint state will be NOT_READY.", + "ref": "serving.EndpointStateReady", + "launch_stage": "GA" + } + } + }, + "serving.EndpointStateConfigUpdate": { + "enum": [ + "NOT_UPDATING", + "IN_PROGRESS", + "UPDATE_FAILED", + "UPDATE_CANCELED" + ], + "enum_launch_stages": { + "IN_PROGRESS": "GA", + "NOT_UPDATING": "GA", + "UPDATE_CANCELED": "GA", + "UPDATE_FAILED": "GA" + } + }, + "serving.EndpointStateReady": { + "enum": [ + "READY", + "NOT_READY" + ], + "enum_launch_stages": { + "NOT_READY": "GA", + "READY": "GA" + } + }, + "serving.EndpointTag": { + "fields": { + "key": { + "description": "Key field for a serving endpoint tag.", + "launch_stage": "GA" + }, + "value": { + "description": "Optional value field for a serving endpoint tag.", + "launch_stage": "GA" + } + } + }, + "serving.EndpointTags": { + "fields": { + "tags": { + "launch_stage": "GA" + } + } + }, + "serving.ExternalFunctionRequest": { + "description": "Simple Proto message for testing", + "fields": { + "connection_name": { + "description": "The connection name to use. This is required to identify the external connection.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "headers": { + "description": "Additional headers for the request. If not provided, only auth headers from connections would be passed.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "json": { + "description": "The JSON payload to send in the request body.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "method": { + "description": "The HTTP method to use (e.g., 'GET', 'POST').", + "ref": "serving.ExternalFunctionRequestHttpMethod", + "launch_stage": "PRIVATE_PREVIEW" + }, + "params": { + "description": "Query parameters for the request.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "path": { + "description": "The relative path for the API endpoint. This is required.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "sub_domain": { + "description": "Optional subdomain to prepend to the connection URL's host. If provided, this will be\nadded as a prefix to the connection URL's host. For example, if the connection URL is\n`https://api.example.com/v1` and `sub_domain` is `\"custom\"`, the resulting URL will be\n`https://custom.api.example.com/v1`.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "serving.ExternalFunctionRequestHttpMethod": { + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "PATCH" + ], + "enum_launch_stages": { + "DELETE": "PRIVATE_PREVIEW", + "GET": "PRIVATE_PREVIEW", + "PATCH": "PRIVATE_PREVIEW", + "POST": "PRIVATE_PREVIEW", + "PUT": "PRIVATE_PREVIEW" + } + }, + "serving.ExternalModel": { + "fields": { + "ai21labs_config": { + "description": "AI21Labs Config. Only required if the provider is 'ai21labs'.", + "ref": "serving.AI21LabsConfig", + "launch_stage": "GA" + }, + "amazon_bedrock_config": { + "description": "Amazon Bedrock Config. Only required if the provider is 'amazon-bedrock'.", + "ref": "serving.AmazonBedrockConfig", + "launch_stage": "GA" + }, + "anthropic_config": { + "description": "Anthropic Config. Only required if the provider is 'anthropic'.", + "ref": "serving.AnthropicConfig", + "launch_stage": "GA" + }, + "cohere_config": { + "description": "Cohere Config. Only required if the provider is 'cohere'.", + "ref": "serving.CohereConfig", + "launch_stage": "GA" + }, + "custom_provider_config": { + "description": "Custom Provider Config. Only required if the provider is 'custom'.", + "ref": "serving.CustomProviderConfig", + "launch_stage": "GA" + }, + "databricks_model_serving_config": { + "description": "Databricks Model Serving Config. Only required if the provider is 'databricks-model-serving'.", + "ref": "serving.DatabricksModelServingConfig", + "launch_stage": "GA" + }, + "google_cloud_vertex_ai_config": { + "description": "Google Cloud Vertex AI Config. Only required if the provider is 'google-cloud-vertex-ai'.", + "ref": "serving.GoogleCloudVertexAIConfig", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the external model.", + "launch_stage": "GA" + }, + "openai_config": { + "description": "OpenAI Config. Only required if the provider is 'openai'.", + "ref": "serving.OpenAIConfig", + "launch_stage": "GA" + }, + "palm_config": { + "description": "PaLM Config. Only required if the provider is 'palm'.", + "ref": "serving.PaLMConfig", + "launch_stage": "GA" + }, + "provider": { + "description": "The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic', 'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', 'palm', and 'custom'.", + "ref": "serving.ExternalModelProvider", + "launch_stage": "GA" + }, + "task": { + "description": "The task type of the external model.", + "launch_stage": "GA" + } + } + }, + "serving.ExternalModelProvider": { + "enum": [ + "ai21labs", + "anthropic", + "amazon-bedrock", + "cohere", + "databricks-model-serving", + "google-cloud-vertex-ai", + "openai", + "palm", + "custom" + ], + "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" + } + }, + "serving.ExternalModelUsageElement": { + "fields": { + "completion_tokens": { + "description": "The number of tokens in the chat/completions response.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "prompt_tokens": { + "description": "The number of tokens in the prompt.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "total_tokens": { + "description": "The total number of tokens in the prompt and response.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.FallbackConfig": { + "fields": { + "enabled": { + "description": "Whether to enable traffic fallback. When a served entity in the serving endpoint returns specific error\ncodes (e.g. 500), the request will automatically be round-robin attempted with other served entities in the same\nendpoint, following the order of served entity list, until a successful response is returned.\nIf all attempts fail, return the last response with the error code.", + "launch_stage": "GA" + } + } + }, + "serving.FoundationModel": { + "description": "All fields are not sensitive as they are hard-coded in the system and made available to customers.", + "fields": { + "description": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "docs": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.GetServingEndpointPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "serving.GoogleCloudVertexAIConfig": { + "fields": { + "private_key": { + "description": "The Databricks secret key reference for a private key for the service\naccount which has access to the Google Cloud Vertex AI Service. See [Best\npractices for managing service account keys]. If you prefer to paste your\nAPI key directly, see `private_key_plaintext`. You must provide an API\nkey using one of the following fields: `private_key` or\n`private_key_plaintext`\n\n[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys", + "launch_stage": "GA" + }, + "private_key_plaintext": { + "description": "The private key for the service account which has access to the Google\nCloud Vertex AI Service provided as a plaintext secret. See [Best\npractices for managing service account keys]. If you prefer to reference\nyour key using Databricks Secrets, see `private_key`. You must provide an\nAPI key using one of the following fields: `private_key` or\n`private_key_plaintext`.\n\n[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys", + "launch_stage": "GA" + }, + "project_id": { + "description": "This is the Google Cloud project id that the service account is\nassociated with.", + "launch_stage": "GA" + }, + "region": { + "description": "This is the region for the Google Cloud Vertex AI Service. See [supported\nregions] for more details. Some models are only available in specific\nregions.\n\n[supported regions]: https://cloud.google.com/vertex-ai/docs/general/locations", + "launch_stage": "GA" + } + } + }, + "serving.ListEndpointsResponse": { + "fields": { + "endpoints": { + "description": "The list of endpoints.", + "launch_stage": "GA" + } + } + }, + "serving.ModelDataPlaneInfo": { + "description": "A representation of all DataPlaneInfo for operations that can be done on a model through Data Plane APIs.", + "fields": { + "query_info": { + "description": "Information required to query DataPlane API 'query' endpoint.", + "ref": "serving.DataPlaneInfo", + "launch_stage": "GA" + } + } + }, + "serving.OpenAIConfig": { + "description": "Configs needed to create an OpenAI model route.", + "fields": { + "microsoft_entra_client_id": { + "description": "This field is only required for Azure AD OpenAI and is the Microsoft\nEntra Client ID.", + "launch_stage": "GA" + }, + "microsoft_entra_client_secret": { + "description": "The Databricks secret key reference for a client secret used for\nMicrosoft Entra ID authentication. If you prefer to paste your client\nsecret directly, see `microsoft_entra_client_secret_plaintext`. You must\nprovide an API key using one of the following fields:\n`microsoft_entra_client_secret` or\n`microsoft_entra_client_secret_plaintext`.", + "launch_stage": "GA" + }, + "microsoft_entra_client_secret_plaintext": { + "description": "The client secret used for Microsoft Entra ID authentication provided as\na plaintext string. If you prefer to reference your key using Databricks\nSecrets, see `microsoft_entra_client_secret`. You must provide an API key\nusing one of the following fields: `microsoft_entra_client_secret` or\n`microsoft_entra_client_secret_plaintext`.", + "launch_stage": "GA" + }, + "microsoft_entra_tenant_id": { + "description": "This field is only required for Azure AD OpenAI and is the Microsoft\nEntra Tenant ID.", + "launch_stage": "GA" + }, + "openai_api_base": { + "description": "This is a field to provide a customized base URl for the OpenAI API. For\nAzure OpenAI, this field is required, and is the base URL for the Azure\nOpenAI API service provided by Azure. For other OpenAI API types, this\nfield is optional, and if left unspecified, the standard OpenAI base URL\nis used.", + "launch_stage": "GA" + }, + "openai_api_key": { + "description": "The Databricks secret key reference for an OpenAI API key using the\nOpenAI or Azure service. If you prefer to paste your API key directly,\nsee `openai_api_key_plaintext`. You must provide an API key using one of\nthe following fields: `openai_api_key` or `openai_api_key_plaintext`.", + "launch_stage": "GA" + }, + "openai_api_key_plaintext": { + "description": "The OpenAI API key using the OpenAI or Azure service provided as a\nplaintext string. If you prefer to reference your key using Databricks\nSecrets, see `openai_api_key`. You must provide an API key using one of\nthe following fields: `openai_api_key` or `openai_api_key_plaintext`.", + "launch_stage": "GA" + }, + "openai_api_type": { + "description": "This is an optional field to specify the type of OpenAI API to use. For\nAzure OpenAI, this field is required, and adjust this parameter to\nrepresent the preferred security access validation protocol. For access\ntoken validation, use azure. For authentication using Azure Active\nDirectory (Azure AD) use, azuread.", + "launch_stage": "GA" + }, + "openai_api_version": { + "description": "This is an optional field to specify the OpenAI API version. For Azure\nOpenAI, this field is required, and is the version of the Azure OpenAI\nservice to utilize, specified by a date.", + "launch_stage": "GA" + }, + "openai_deployment_name": { + "description": "This field is only required for Azure OpenAI and is the name of the\ndeployment resource for the Azure OpenAI service.", + "launch_stage": "GA" + }, + "openai_organization": { + "description": "This is an optional field to specify the organization in OpenAI or Azure\nOpenAI.", + "launch_stage": "GA" + } + } + }, + "serving.PaLMConfig": { + "fields": { + "palm_api_key": { + "description": "The Databricks secret key reference for a PaLM API key. If you prefer to\npaste your API key directly, see `palm_api_key_plaintext`. You must\nprovide an API key using one of the following fields: `palm_api_key` or\n`palm_api_key_plaintext`.", + "launch_stage": "GA" + }, + "palm_api_key_plaintext": { + "description": "The PaLM API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `palm_api_key`. You must\nprovide an API key using one of the following fields: `palm_api_key` or\n`palm_api_key_plaintext`.", + "launch_stage": "GA" + } + } + }, + "serving.PatchServingEndpointTags": { + "fields": { + "add_tags": { + "description": "List of endpoint tags to add", + "launch_stage": "GA" + }, + "delete_tags": { + "description": "List of tag keys to delete", + "launch_stage": "GA" + } + } + }, + "serving.PayloadTable": { + "fields": { + "name": { + "launch_stage": "GA" + }, + "status": { + "launch_stage": "GA" + }, + "status_message": { + "launch_stage": "GA" + } + } + }, + "serving.PtEndpointCoreConfig": { + "fields": { + "served_entities": { + "description": "The list of served entities under the serving endpoint config.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "traffic_config": { + "ref": "serving.TrafficConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.PtServedModel": { + "fields": { + "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.", + "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**.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "entity_version": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "provisioned_model_units": { + "description": "The number of model units to be provisioned.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.PutAiGatewayRequest": { + "fields": { + "fallback_config": { + "description": "Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.", + "ref": "serving.FallbackConfig", + "launch_stage": "GA" + }, + "guardrails": { + "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "ref": "serving.AiGatewayGuardrails", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "inference_table_config": { + "description": "Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.", + "ref": "serving.AiGatewayInferenceTableConfig", + "launch_stage": "GA" + }, + "rate_limits": { + "description": "Configuration for rate limits which can be set to limit endpoint traffic.", + "launch_stage": "GA" + }, + "usage_tracking_config": { + "description": "Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.", + "ref": "serving.AiGatewayUsageTrackingConfig", + "launch_stage": "GA" + } + } + }, + "serving.PutAiGatewayResponse": { + "fields": { + "fallback_config": { + "description": "Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.", + "ref": "serving.FallbackConfig", + "launch_stage": "GA" + }, + "guardrails": { + "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "ref": "serving.AiGatewayGuardrails", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "inference_table_config": { + "description": "Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.", + "ref": "serving.AiGatewayInferenceTableConfig", + "launch_stage": "GA" + }, + "rate_limits": { + "description": "Configuration for rate limits which can be set to limit endpoint traffic.", + "launch_stage": "GA" + }, + "usage_tracking_config": { + "description": "Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.", + "ref": "serving.AiGatewayUsageTrackingConfig", + "launch_stage": "GA" + } + } + }, + "serving.PutRequest": { + "fields": { + "rate_limits": { + "description": "The list of endpoint rate limits.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.PutResponse": { + "fields": { + "rate_limits": { + "description": "The list of endpoint rate limits.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.QueryEndpointInput": { + "fields": { + "client_request_id": { + "description": "Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table.", + "launch_stage": "GA" + }, + "dataframe_records": { + "description": "Pandas Dataframe input in the records orientation.", + "launch_stage": "GA" + }, + "dataframe_split": { + "description": "Pandas Dataframe input in the split orientation.", + "ref": "serving.DataframeSplitInput", + "launch_stage": "GA" + }, + "extra_params": { + "description": "The extra parameters field used ONLY for __completions, chat,__ and __embeddings external \u0026 foundation\nmodel__ serving endpoints. This is a map of strings and should only be used with other external/foundation\nmodel query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "input": { + "description": "The input string (or array of strings) field used ONLY for __embeddings external \u0026 foundation model__\nserving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "inputs": { + "description": "Tensor-based input in columnar format.", + "launch_stage": "GA" + }, + "instances": { + "description": "Tensor-based input in row format.", + "launch_stage": "GA" + }, + "max_tokens": { + "description": "The max tokens field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is an integer and should only be used with other chat/completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "messages": { + "description": "The messages field used ONLY for __chat external \u0026 foundation model__ serving endpoints.\nThis is an array of ChatMessage objects and should only be used with other chat query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "n": { + "description": "The n (number of candidates) field used ONLY for __completions__ and __chat external \u0026 foundation model__\nserving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with\nother chat/completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "prompt": { + "description": "The prompt string (or array of strings) field used ONLY for __completions external \u0026 foundation model__\nserving endpoints and should only be used with other completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "stop": { + "description": "The stop sequences field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a list of strings and should only be used with other chat/completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "stream": { + "description": "The stream field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving endpoints.\nThis is a boolean defaulting to false and should only be used with other chat/completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "temperature": { + "description": "The temperature field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other\nchat/completions query fields.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "usage_context": { + "description": "Optional user-provided context that will be recorded in the usage tracking table.", + "launch_stage": "GA" + } + } + }, + "serving.QueryEndpointResponse": { + "fields": { + "choices": { + "description": "The list of choices returned by the __chat or completions external/foundation model__ serving endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "created": { + "description": "The timestamp in seconds when the query was created in Unix time returned by a __completions or chat external/foundation model__ serving endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "data": { + "description": "The list of the embeddings returned by the __embeddings external/foundation model__ serving endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "The ID of the query that may be returned by a __completions or chat external/foundation model__ serving endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "model": { + "description": "The name of the __external/foundation model__ used for querying. This is the name of the model that was\nspecified in the endpoint config.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "object": { + "description": "The type of object returned by the __external/foundation model__ serving endpoint, one of\n[text_completion, chat.completion, list (of embeddings)].", + "ref": "serving.QueryEndpointResponseObject", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "outputs": { + "description": "The outputs of the feature serving endpoint.", + "launch_stage": "GA" + }, + "predictions": { + "description": "The predictions returned by the serving endpoint.", + "launch_stage": "GA" + }, + "usage": { + "description": "The usage object that may be returned by the __external/foundation model__ serving endpoint. This\ncontains information about the number of tokens used in the prompt and response.", + "ref": "serving.ExternalModelUsageElement", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.QueryEndpointResponseObject": { + "description": "The type of object returned by the __external/foundation model__ serving endpoint, one of\n[text_completion, chat.completion, list (of embeddings)].", + "enum": [ + "text_completion", + "chat.completion", + "list" + ], + "enum_launch_stages": { + "chat.completion": "PUBLIC_PREVIEW", + "list": "PUBLIC_PREVIEW", + "text_completion": "PUBLIC_PREVIEW" + } + }, + "serving.RateLimit": { + "fields": { + "calls": { + "description": "Used to specify how many calls are allowed for a key within the renewal_period.", + "launch_stage": "GA" + }, + "key": { + "description": "Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.", + "ref": "serving.RateLimitKey", + "launch_stage": "GA" + }, + "renewal_period": { + "description": "Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported.", + "ref": "serving.RateLimitRenewalPeriod", + "launch_stage": "GA" + } + } + }, + "serving.RateLimitKey": { + "enum": [ + "user", + "endpoint" + ], + "enum_launch_stages": { + "endpoint": "PUBLIC_PREVIEW", + "user": "PUBLIC_PREVIEW" + } + }, + "serving.RateLimitRenewalPeriod": { + "enum": [ + "minute" + ], + "enum_launch_stages": { + "minute": "PUBLIC_PREVIEW" + } + }, + "serving.Route": { + "fields": { + "served_entity_name": { + "launch_stage": "GA" + }, + "served_model_name": { + "description": "The name of the served model this route configures traffic for.", + "launch_stage": "GA" + }, + "traffic_percentage": { + "description": "The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive.", + "launch_stage": "GA" + } + } + }, + "serving.ServedEntityInput": { + "fields": { + "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.", + "preview": "PUBLIC", + "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**.", + "launch_stage": "GA" + }, + "entity_version": { + "launch_stage": "GA" + }, + "environment_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", + "launch_stage": "GA" + }, + "external_model": { + "description": "The external model to be served. NOTE: Only one of external_model and (entity_name, entity_version, workload_size, workload_type, and scale_to_zero_enabled) can be specified with the latter set being used for custom model serving for a Databricks registered model. For an existing endpoint with external_model, it cannot be updated to an endpoint without external_model. If the endpoint is created without external_model, users cannot update it to add external_model later. The task type of all external models within an endpoint must be the same.", + "ref": "serving.ExternalModel", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "max_provisioned_throughput": { + "description": "The maximum tokens per second that the endpoint can scale up to.", + "launch_stage": "GA" + }, + "min_provisioned_concurrency": { + "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", + "launch_stage": "GA" + }, + "min_provisioned_throughput": { + "description": "The minimum tokens per second that the endpoint can scale down to.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", + "launch_stage": "GA" + }, + "provisioned_model_units": { + "description": "The number of model units provisioned.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "scale_to_zero_enabled": { + "description": "Whether the compute resources for the served entity should scale down to zero.", + "launch_stage": "GA" + }, + "workload_size": { + "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", + "launch_stage": "GA" + }, + "workload_type": { + "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", + "ref": "serving.ServingModelWorkloadType", + "launch_stage": "GA" + } + } + }, + "serving.ServedEntityOutput": { + "fields": { + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "creation_timestamp": { + "launch_stage": "GA" + }, + "creator": { + "launch_stage": "GA" + }, + "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**.", + "launch_stage": "GA" + }, + "entity_version": { + "launch_stage": "GA" + }, + "environment_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", + "launch_stage": "GA" + }, + "external_model": { + "description": "The external model to be served. NOTE: Only one of external_model and (entity_name, entity_version, workload_size, workload_type, and scale_to_zero_enabled) can be specified with the latter set being used for custom model serving for a Databricks registered model. For an existing endpoint with external_model, it cannot be updated to an endpoint without external_model. If the endpoint is created without external_model, users cannot update it to add external_model later. The task type of all external models within an endpoint must be the same.", + "ref": "serving.ExternalModel", + "launch_stage": "GA" + }, + "foundation_model": { + "ref": "serving.FoundationModel", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "instance_profile_arn": { + "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "max_provisioned_throughput": { + "description": "The maximum tokens per second that the endpoint can scale up to.", + "launch_stage": "GA" + }, + "min_provisioned_concurrency": { + "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", + "launch_stage": "GA" + }, + "min_provisioned_throughput": { + "description": "The minimum tokens per second that the endpoint can scale down to.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", + "launch_stage": "GA" + }, + "provisioned_model_units": { + "description": "The number of model units provisioned.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "scale_to_zero_enabled": { + "description": "Whether the compute resources for the served entity should scale down to zero.", + "launch_stage": "GA" + }, + "state": { + "ref": "serving.ServedModelState", + "launch_stage": "GA" + }, + "workload_size": { + "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", + "launch_stage": "GA" + }, + "workload_type": { + "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", + "ref": "serving.ServingModelWorkloadType", + "launch_stage": "GA" + } + } + }, + "serving.ServedEntitySpec": { + "fields": { + "entity_name": { + "launch_stage": "GA" + }, + "entity_version": { + "launch_stage": "GA" + }, + "external_model": { + "ref": "serving.ExternalModel", + "launch_stage": "GA" + }, + "foundation_model": { + "ref": "serving.FoundationModel", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "launch_stage": "GA" + } + } + }, + "serving.ServedModelInput": { + "fields": { + "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.", + "preview": "PUBLIC", + "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}}\"}`", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "max_provisioned_throughput": { + "description": "The maximum tokens per second that the endpoint can scale up to.", + "launch_stage": "GA" + }, + "min_provisioned_concurrency": { + "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", + "launch_stage": "GA" + }, + "min_provisioned_throughput": { + "description": "The minimum tokens per second that the endpoint can scale down to.", + "launch_stage": "GA" + }, + "model_name": { + "launch_stage": "GA" + }, + "model_version": { + "launch_stage": "GA" + }, + "name": { + "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", + "launch_stage": "GA" + }, + "provisioned_model_units": { + "description": "The number of model units provisioned.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "scale_to_zero_enabled": { + "description": "Whether the compute resources for the served entity should scale down to zero.", + "launch_stage": "GA" + }, + "workload_size": { + "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", + "launch_stage": "GA" + }, + "workload_type": { + "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", + "ref": "serving.ServedModelInputWorkloadType", + "launch_stage": "GA" + } + } + }, + "serving.ServedModelInputWorkloadType": { + "description": "Please keep this in sync with with workload types in InferenceEndpointEntities.scala", + "enum": [ + "CPU", + "GPU_MEDIUM", + "GPU_SMALL", + "GPU_LARGE", + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enum_launch_stages": { + "CPU": "GA", + "GPU_LARGE": "GA", + "GPU_MEDIUM": "GA", + "GPU_SMALL": "GA", + "GPU_XLARGE": "PUBLIC_BETA", + "MULTIGPU_MEDIUM": "GA" + } + }, + "serving.ServedModelOutput": { + "fields": { + "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.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "creation_timestamp": { + "launch_stage": "GA" + }, + "creator": { + "launch_stage": "GA" + }, + "environment_vars": { + "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "preview": "PUBLIC", + "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.", + "launch_stage": "GA" + }, + "min_provisioned_concurrency": { + "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", + "launch_stage": "GA" + }, + "model_name": { + "launch_stage": "GA" + }, + "model_version": { + "launch_stage": "GA" + }, + "name": { + "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", + "launch_stage": "GA" + }, + "provisioned_model_units": { + "description": "The number of model units provisioned.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "scale_to_zero_enabled": { + "description": "Whether the compute resources for the served entity should scale down to zero.", + "launch_stage": "GA" + }, + "state": { + "ref": "serving.ServedModelState", + "launch_stage": "GA" + }, + "workload_size": { + "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", + "launch_stage": "GA" + }, + "workload_type": { + "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", + "ref": "serving.ServingModelWorkloadType", + "launch_stage": "GA" + } + } + }, + "serving.ServedModelSpec": { + "fields": { + "model_name": { + "description": "Only one of model_name and entity_name should be populated", + "launch_stage": "GA" + }, + "model_version": { + "description": "Only one of model_version and entity_version should be populated", + "launch_stage": "GA" + }, + "name": { + "launch_stage": "GA" + } + } + }, + "serving.ServedModelState": { + "fields": { + "deployment": { + "ref": "serving.ServedModelStateDeployment", + "launch_stage": "GA" + }, + "deployment_state_message": { + "launch_stage": "GA" + } + } + }, + "serving.ServedModelStateDeployment": { + "enum": [ + "DEPLOYMENT_CREATING", + "DEPLOYMENT_RECOVERING", + "DEPLOYMENT_READY", + "DEPLOYMENT_FAILED", + "DEPLOYMENT_ABORTED" + ], + "enum_launch_stages": { + "DEPLOYMENT_ABORTED": "PUBLIC_PREVIEW", + "DEPLOYMENT_CREATING": "PUBLIC_PREVIEW", + "DEPLOYMENT_FAILED": "PUBLIC_PREVIEW", + "DEPLOYMENT_READY": "PUBLIC_PREVIEW", + "DEPLOYMENT_RECOVERING": "PUBLIC_PREVIEW" + } + }, + "serving.ServerLogsResponse": { + "fields": { + "logs": { + "description": "The most recent log lines of the model server processing invocation requests.", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpoint": { + "fields": { + "ai_gateway": { + "description": "The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", + "ref": "serving.AiGatewayConfig", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "The budget policy associated with the endpoint.", + "launch_stage": "GA" + }, + "config": { + "description": "The config that is currently being served by the endpoint.", + "ref": "serving.EndpointCoreConfigSummary", + "launch_stage": "GA" + }, + "creation_timestamp": { + "description": "The timestamp when the endpoint was created in Unix time.", + "launch_stage": "GA" + }, + "creator": { + "description": "The email of the user who created the serving endpoint.", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the endpoint", + "launch_stage": "GA" + }, + "id": { + "description": "System-generated ID of the endpoint, included to be used by the Permissions API.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "The timestamp when the endpoint was last updated by a user in Unix time.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the serving endpoint.", + "launch_stage": "GA" + }, + "state": { + "description": "Information corresponding to the state of the serving endpoint.", + "ref": "serving.EndpointState", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags attached to the serving endpoint.", + "launch_stage": "GA" + }, + "task": { + "description": "The task type of the serving endpoint.", + "launch_stage": "GA" + }, + "usage_policy_id": { + "description": "The usage policy associated with serving endpoint.", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "serving.ServingEndpointPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointDetailed": { + "fields": { + "ai_gateway": { + "description": "The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", + "ref": "serving.AiGatewayConfig", + "launch_stage": "GA" + }, + "budget_policy_id": { + "description": "The budget policy associated with the endpoint.", + "launch_stage": "GA" + }, + "config": { + "description": "The config that is currently being served by the endpoint.", + "ref": "serving.EndpointCoreConfigOutput", + "launch_stage": "GA" + }, + "creation_timestamp": { + "description": "The timestamp when the endpoint was created in Unix time.", + "launch_stage": "GA" + }, + "creator": { + "description": "The email of the user who created the serving endpoint.", + "launch_stage": "GA" + }, + "data_plane_info": { + "description": "Information required to query DataPlane APIs.", + "ref": "serving.ModelDataPlaneInfo", + "launch_stage": "GA" + }, + "description": { + "description": "Description of the serving model", + "launch_stage": "GA" + }, + "email_notifications": { + "description": "Email notification settings.", + "ref": "serving.EmailNotifications", + "launch_stage": "GA" + }, + "endpoint_url": { + "description": "Endpoint invocation url if route optimization is enabled for endpoint", + "launch_stage": "GA" + }, + "id": { + "description": "System-generated ID of the endpoint. This is used to refer to the endpoint in the Permissions API", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "The timestamp when the endpoint was last updated by a user in Unix time.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the serving endpoint.", + "launch_stage": "GA" + }, + "pending_config": { + "description": "The config that the endpoint is attempting to update to.", + "ref": "serving.EndpointPendingConfig", + "launch_stage": "GA" + }, + "permission_level": { + "description": "The permission level of the principal making the request.", + "ref": "serving.ServingEndpointDetailedPermissionLevel", + "launch_stage": "GA" + }, + "route_optimized": { + "description": "Boolean representing if route optimization has been enabled for the endpoint", + "launch_stage": "GA" + }, + "state": { + "description": "Information corresponding to the state of the serving endpoint.", + "ref": "serving.EndpointState", + "launch_stage": "GA" + }, + "tags": { + "description": "Tags attached to the serving endpoint.", + "launch_stage": "GA" + }, + "task": { + "description": "The task type of the serving endpoint.", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointDetailedPermissionLevel": { + "enum": [ + "CAN_MANAGE", + "CAN_QUERY", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_MANAGE": "GA", + "CAN_QUERY": "GA", + "CAN_VIEW": "GA" + } + }, + "serving.ServingEndpointPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "serving.ServingEndpointPermissionLevel", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_QUERY", + "CAN_VIEW" + ] + }, + "serving.ServingEndpointPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "serving.ServingEndpointPermissionLevel", + "launch_stage": "GA" + } + } + }, + "serving.ServingEndpointPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "serving.ServingModelWorkloadType": { + "description": "Please keep this in sync with with workload types in InferenceEndpointEntities.scala", + "enum": [ + "CPU", + "GPU_MEDIUM", + "GPU_SMALL", + "GPU_LARGE", + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enum_launch_stages": { + "CPU": "GA", + "GPU_LARGE": "GA", + "GPU_MEDIUM": "GA", + "GPU_SMALL": "GA", + "GPU_XLARGE": "PUBLIC_BETA", + "MULTIGPU_MEDIUM": "GA" + } + }, + "serving.TrafficConfig": { + "fields": { + "routes": { + "description": "The list of routes that define traffic to each served entity.", + "launch_stage": "GA" + } + } + }, + "serving.UpdateInferenceEndpointNotifications": { + "fields": { + "email_notifications": { + "description": "The email notification settings to update. Specify email addresses to notify when endpoint state changes occur.", + "ref": "serving.EmailNotifications", + "launch_stage": "GA" + } + } + }, + "serving.UpdateInferenceEndpointNotificationsResponse": { + "fields": { + "email_notifications": { + "ref": "serving.EmailNotifications", + "launch_stage": "GA" + }, + "name": { + "launch_stage": "GA" + } + } + }, + "serving.UpdateProvisionedThroughputEndpointConfigRequest": { + "fields": { + "config": { + "ref": "serving.PtEndpointCoreConfig", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.V1ResponseChoiceElement": { + "fields": { + "finishReason": { + "description": "The finish reason returned by the endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "index": { + "description": "The index of the choice in the __chat or completions__ response.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "logprobs": { + "description": "The logprobs returned only by the __completions__ endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "message": { + "description": "The message response from the __chat__ endpoint.", + "ref": "serving.ChatMessage", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "text": { + "description": "The text response from the __completions__ endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.AccountIpAccessEnable": { + "fields": { + "acct_ip_acl_enable": { + "ref": "settings.BooleanMessage", + "launch_stage": "PRIVATE_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.AccountNetworkPolicy": { + "fields": { + "account_id": { + "description": "The associated account ID for this Network Policy object.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "egress": { + "description": "The network policies applying for egress traffic.", + "ref": "settings.NetworkPolicyEgress", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "ingress": { + "description": "The network policies applying for ingress traffic.", + "ref": "settings.CustomerFacingIngressNetworkPolicy", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "ingress_dry_run": { + "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests.", + "ref": "settings.CustomerFacingIngressNetworkPolicy", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "network_policy_id": { + "description": "The unique identifier for the network policy.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.AibiDashboardEmbeddingAccessPolicy": { + "fields": { + "access_policy_type": { + "ref": "settings.AibiDashboardEmbeddingAccessPolicyAccessPolicyType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.AibiDashboardEmbeddingAccessPolicyAccessPolicyType": { + "enum": [ + "ALLOW_ALL_DOMAINS", + "ALLOW_APPROVED_DOMAINS", + "DENY_ALL_DOMAINS" + ], + "enum_launch_stages": { + "ALLOW_ALL_DOMAINS": "PUBLIC_PREVIEW", + "ALLOW_APPROVED_DOMAINS": "PUBLIC_PREVIEW", + "DENY_ALL_DOMAINS": "PUBLIC_PREVIEW" + } + }, + "settings.AibiDashboardEmbeddingAccessPolicySetting": { + "fields": { + "aibi_dashboard_embedding_access_policy": { + "ref": "settings.AibiDashboardEmbeddingAccessPolicy", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.AibiDashboardEmbeddingApprovedDomains": { + "fields": { + "approved_domains": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.AibiDashboardEmbeddingApprovedDomainsSetting": { + "fields": { + "aibi_dashboard_embedding_approved_domains": { + "ref": "settings.AibiDashboardEmbeddingApprovedDomains", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.AutomaticClusterUpdateSetting": { + "fields": { + "automatic_cluster_update_workspace": { + "ref": "settings.ClusterAutoRestartMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.BooleanMessage": { + "fields": { + "value": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ClusterAutoRestartMessage": { + "fields": { + "can_toggle": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "enabled": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "enablement_details": { + "ref": "settings.ClusterAutoRestartMessageEnablementDetails", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "maintenance_window": { + "ref": "settings.ClusterAutoRestartMessageMaintenanceWindow", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "restart_even_if_no_updates_available": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ClusterAutoRestartMessageEnablementDetails": { + "description": "Contains an information about the enablement status judging (e.g. whether the enterprise tier\nis enabled)\nThis is only additional information that MUST NOT be used to decide whether the setting is\nenabled or not. This is intended to use only for purposes like showing an error message to\nthe customer with the additional details. For example, using these details we can check\nwhy exactly the feature is disabled for this customer.", + "fields": { + "forced_for_compliance_mode": { + "description": "The feature is force enabled if compliance mode is active", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "unavailable_for_disabled_entitlement": { + "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "unavailable_for_non_enterprise_tier": { + "description": "The feature is unavailable if the customer doesn't have enterprise tier", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ClusterAutoRestartMessageMaintenanceWindow": { + "fields": { + "week_day_based_schedule": { + "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek": { + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enum_launch_stages": { + "FRIDAY": "PUBLIC_PREVIEW", + "MONDAY": "PUBLIC_PREVIEW", + "SATURDAY": "PUBLIC_PREVIEW", + "SUNDAY": "PUBLIC_PREVIEW", + "THURSDAY": "PUBLIC_PREVIEW", + "TUESDAY": "PUBLIC_PREVIEW", + "WEDNESDAY": "PUBLIC_PREVIEW" + } + }, + "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule": { + "fields": { + "day_of_week": { + "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "frequency": { + "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "window_start_time": { + "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency": { + "enum": [ + "FIRST_OF_MONTH", + "SECOND_OF_MONTH", + "THIRD_OF_MONTH", + "FOURTH_OF_MONTH", + "FIRST_AND_THIRD_OF_MONTH", + "SECOND_AND_FOURTH_OF_MONTH", + "EVERY_WEEK" + ], + "enum_launch_stages": { + "EVERY_WEEK": "PUBLIC_PREVIEW", + "FIRST_AND_THIRD_OF_MONTH": "PUBLIC_PREVIEW", + "FIRST_OF_MONTH": "PUBLIC_PREVIEW", + "FOURTH_OF_MONTH": "PUBLIC_PREVIEW", + "SECOND_AND_FOURTH_OF_MONTH": "PUBLIC_PREVIEW", + "SECOND_OF_MONTH": "PUBLIC_PREVIEW", + "THIRD_OF_MONTH": "PUBLIC_PREVIEW" + } + }, + "settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime": { + "fields": { + "hours": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "minutes": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.ComplianceSecurityProfile": { + "description": "SHIELD feature: CSP\nCompliance Security Profile (CSP) enables enhanced compliance controls on the workspace.", + "fields": { + "compliance_standards": { + "description": "Compliance standards selected by the customer for this Compliance Security Profile.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_enabled": { + "description": "Whether Compliance Security Profile (CSP) is enabled on the workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.ComplianceSecurityProfileSetting": { + "fields": { + "compliance_security_profile_workspace": { + "ref": "settings.ComplianceSecurityProfile", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.ComplianceStandard": { + "description": "Compliance standard for SHIELD customers. See README.md for how instructions of how to add new standards.", + "enum": [ + "NONE", + "HIPAA", + "PCI_DSS", + "FEDRAMP_MODERATE", + "IRAP_PROTECTED", + "FEDRAMP_HIGH", + "FEDRAMP_IL5", + "ITAR_EAR", + "CYBER_ESSENTIAL_PLUS", + "CANADA_PROTECTED_B", + "ISMAP", + "HITRUST", + "K_FSI", + "GERMANY_C5", + "GERMANY_TISAX" + ], + "enum_launch_stages": { + "CANADA_PROTECTED_B": "GA", + "CYBER_ESSENTIAL_PLUS": "GA", + "FEDRAMP_HIGH": "GA", + "FEDRAMP_IL5": "GA", + "FEDRAMP_MODERATE": "GA", + "GERMANY_C5": "GA", + "GERMANY_TISAX": "GA", + "HIPAA": "GA", + "HITRUST": "GA", + "IRAP_PROTECTED": "GA", + "ISMAP": "GA", + "ITAR_EAR": "GA", + "K_FSI": "GA", + "NONE": "GA", + "PCI_DSS": "GA" + } + }, + "settings.Config": { + "fields": { + "email": { + "ref": "settings.EmailConfig", + "launch_stage": "GA" + }, + "generic_webhook": { + "ref": "settings.GenericWebhookConfig", + "launch_stage": "GA" + }, + "microsoft_teams": { + "ref": "settings.MicrosoftTeamsConfig", + "launch_stage": "GA" + }, + "pagerduty": { + "ref": "settings.PagerdutyConfig", + "launch_stage": "GA" + }, + "slack": { + "ref": "settings.SlackConfig", + "launch_stage": "GA" + } + } + }, + "settings.CreateIPAccessList": { + "description": "Details required to configure a block list or allow list.", + "fields": { + "ip_addresses": { + "launch_stage": "GA" + }, + "label": { + "description": "Label for the IP access list. This **cannot** be empty.", + "launch_stage": "GA" + }, + "list_type": { + "ref": "settings.list_type", + "launch_stage": "GA" + } + } + }, + "settings.CreateIPAccessListResponse": { + "description": "An IP access list was successfully created.", + "fields": { + "ip_access_list": { + "ref": "settings.IpAccessListInfo", + "launch_stage": "GA" + } + } + }, + "settings.CreateNetworkConnectivityConfiguration": { + "description": "Properties of the new network connectivity configuration.", + "fields": { + "name": { + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "launch_stage": "GA" + }, + "region": { + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "launch_stage": "GA" + } + } + }, + "settings.CreateNotificationDestinationRequest": { + "fields": { + "config": { + "description": "The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.", + "ref": "settings.Config", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name for the notification destination.", + "launch_stage": "GA" + } + } + }, + "settings.CreateOboTokenRequest": { + "description": "Configuration details for creating on-behalf tokens.", + "fields": { + "application_id": { + "description": "Application ID of the service principal.", + "launch_stage": "GA" + }, + "autoscope_enabled": { + "description": "Whether to enable autoscoping for this token.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment that describes the purpose of the token.", + "launch_stage": "GA" + }, + "lifetime_seconds": { + "description": "The number of seconds before the token expires.", + "launch_stage": "GA" + }, + "scopes": { + "launch_stage": "GA" + } + } + }, + "settings.CreateOboTokenResponse": { + "description": "An on-behalf token was successfully created for the service principal.", + "fields": { + "token_info": { + "ref": "settings.TokenInfo", + "launch_stage": "GA" + }, + "token_value": { + "description": "Value of the token.", + "launch_stage": "GA" + } + } + }, + "settings.CreatePrivateEndpointRule": { + "description": "Properties of the new private endpoint rule.\nNote that you must approve the endpoint in Azure portal after initialization.", + "fields": { + "domain_names": { + "description": "Only used by private endpoints to customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "launch_stage": "GA" + }, + "endpoint_service": { + "description": "The full target AWS endpoint service name that connects to the destination resources of the private endpoint.", + "launch_stage": "GA" + }, + "error_message": { + "launch_stage": "GA" + }, + "gcp_endpoint": { + "ref": "settings.GcpEndpoint", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "group_id": { + "description": "Not used by customer-managed private endpoint services.\n\nThe sub-resource type (group ID) of the target resource.\nNote that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.", + "launch_stage": "GA" + }, + "resource_id": { + "description": "The Azure resource ID of the target resource.", + "launch_stage": "GA" + }, + "resource_names": { + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.CreateTokenRequest": { + "fields": { + "autoscope_enabled": { + "description": "Whether to enable autoscoping for this token. When true, the token will\nautomatically collect inferred API path scopes as it is used.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Optional description to attach to the token.", + "launch_stage": "GA" + }, + "lifetime_seconds": { + "description": "The lifetime of the token, in seconds.\n\nIf the lifetime is not specified, this token remains valid for 2 years.", + "launch_stage": "GA" + }, + "scopes": { + "description": "Optional scopes of the token.", + "launch_stage": "GA" + } + } + }, + "settings.CreateTokenResponse": { + "fields": { + "token_info": { + "description": "The information for the new token.", + "ref": "settings.PublicTokenInfo", + "launch_stage": "GA" + }, + "token_value": { + "description": "The value of the new token.", + "launch_stage": "GA" + } + } + }, + "settings.CspEnablementAccount": { + "description": "Account level policy for CSP", + "fields": { + "compliance_standards": { + "description": "Set by customers when they request Compliance Security Profile (CSP)\nInvariants are enforced in Settings policy.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_enforced": { + "description": "Enforced = it cannot be overriden at workspace level.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.CspEnablementAccountSetting": { + "fields": { + "csp_enablement_account": { + "ref": "settings.CspEnablementAccount", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicy": { + "description": "This proto is under development.\nThe network policies applying for ingress traffic.\nAny changes here should also be synced to estore/namespaces/lakehousenetworkmanager/latest.proto.", + "fields": { + "cross_workspace_access": { + "ref": "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "private_access": { + "description": "The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access.", + "ref": "settings.CustomerFacingIngressNetworkPolicyPrivateAccess", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "public_access": { + "description": "The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access.", + "ref": "settings.CustomerFacingIngressNetworkPolicyPublicAccess", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAccountApiDestination": { + "fields": { + "scope_qualifier": { + "description": "Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier.", + "ref": "settings.CustomerFacingIngressNetworkPolicyApiScopeQualifier", + "launch_stage": "PRIVATE_PREVIEW" + }, + "scopes": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination": { + "fields": { + "all_destinations": { + "description": "Must be set to true.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAccountUiDestination": { + "fields": { + "all_destinations": { + "description": "Must be set to true.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyApiScopeQualifier": { + "description": "Qualifies the breadth of API access permitted by an ingress network policy rule.\nAPI_SCOPE_QUALIFIER_READ narrows matching to read-only variants of the listed scopes;\nAPI_SCOPE_QUALIFIER_ALL matches any scope. When unset, scopes match exactly as listed.", + "enum": [ + "API_SCOPE_QUALIFIER_READ", + "API_SCOPE_QUALIFIER_ALL" + ], + "enum_launch_stages": { + "API_SCOPE_QUALIFIER_ALL": "PUBLIC_BETA", + "API_SCOPE_QUALIFIER_READ": "PUBLIC_BETA" + } + }, + "settings.CustomerFacingIngressNetworkPolicyAppsRuntimeDestination": { + "fields": { + "all_destinations": { + "description": "Must be set to true.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAuthentication": { + "fields": { + "identities": { + "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES.", + "launch_stage": "PUBLIC_BETA" + }, + "identity_type": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityType", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentity": { + "fields": { + "principal_id": { + "launch_stage": "PUBLIC_BETA" + }, + "principal_type": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType": { + "enum": [ + "PRINCIPAL_TYPE_USER", + "PRINCIPAL_TYPE_SERVICE_PRINCIPAL" + ], + "enum_launch_stages": { + "PRINCIPAL_TYPE_SERVICE_PRINCIPAL": "PUBLIC_BETA", + "PRINCIPAL_TYPE_USER": "PUBLIC_BETA" + } + }, + "settings.CustomerFacingIngressNetworkPolicyAuthenticationIdentityType": { + "enum": [ + "IDENTITY_TYPE_ALL_USERS", + "IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS", + "IDENTITY_TYPE_SELECTED_IDENTITIES" + ], + "enum_launch_stages": { + "IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS": "PUBLIC_BETA", + "IDENTITY_TYPE_ALL_USERS": "PUBLIC_BETA", + "IDENTITY_TYPE_SELECTED_IDENTITIES": "PUBLIC_BETA" + } + }, + "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess": { + "fields": { + "allow_rules": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "deny_rules": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "restriction_mode": { + "ref": "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode": { + "enum": [ + "FULL_ACCESS", + "RESTRICTED_ACCESS" + ], + "enum_launch_stages": { + "FULL_ACCESS": "PRIVATE_PREVIEW", + "RESTRICTED_ACCESS": "PRIVATE_PREVIEW" + } + }, + "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule": { + "fields": { + "authentication": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAuthentication", + "launch_stage": "PRIVATE_PREVIEW" + }, + "destination": { + "ref": "settings.CustomerFacingIngressNetworkPolicyRequestDestination", + "launch_stage": "PRIVATE_PREVIEW" + }, + "label": { + "description": "The label for this ingress rule.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "origin": { + "ref": "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin": { + "fields": { + "all_source_workspaces": { + "description": "Matches all source workspaces.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "selected_workspaces": { + "description": "Specific source workspace IDs to match.", + "ref": "settings.CustomerFacingIngressNetworkPolicyWorkspaceIdList", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyEndpoints": { + "fields": { + "endpoint_ids": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyIpRanges": { + "fields": { + "ip_ranges": { + "description": "We only support IPv4 and IPv4 CIDR notation for now.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination": { + "fields": { + "all_destinations": { + "description": "Must be set to true.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPrivateAccess": { + "fields": { + "allow_rules": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "deny_rules": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "restriction_mode": { + "ref": "settings.CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode": { + "enum": [ + "ALLOW_ALL_REGISTERED_ENDPOINTS", + "RESTRICTED_ACCESS" + ], + "enum_launch_stages": { + "ALLOW_ALL_REGISTERED_ENDPOINTS": "PRIVATE_PREVIEW", + "RESTRICTED_ACCESS": "PRIVATE_PREVIEW" + } + }, + "settings.CustomerFacingIngressNetworkPolicyPrivateIngressRule": { + "fields": { + "authentication": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAuthentication", + "launch_stage": "PRIVATE_PREVIEW" + }, + "destination": { + "ref": "settings.CustomerFacingIngressNetworkPolicyRequestDestination", + "launch_stage": "PRIVATE_PREVIEW" + }, + "label": { + "description": "The label for this ingress rule.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "origin": { + "ref": "settings.CustomerFacingIngressNetworkPolicyPrivateRequestOrigin", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPrivateRequestOrigin": { + "fields": { + "all_private_access": { + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "all_registered_endpoints": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "azure_workspace_private_link": { + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "endpoints": { + "ref": "settings.CustomerFacingIngressNetworkPolicyEndpoints", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPublicAccess": { + "fields": { + "allow_rules": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "deny_rules": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "restriction_mode": { + "ref": "settings.CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode": { + "enum": [ + "FULL_ACCESS", + "RESTRICTED_ACCESS" + ], + "enum_launch_stages": { + "FULL_ACCESS": "PUBLIC_BETA", + "RESTRICTED_ACCESS": "PUBLIC_BETA" + } + }, + "settings.CustomerFacingIngressNetworkPolicyPublicIngressRule": { + "description": "An ingress rule is enforced when a request satisfies all\nspecified attributes — including request origin, destination, and authentication.", + "fields": { + "authentication": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAuthentication", + "launch_stage": "PUBLIC_BETA" + }, + "destination": { + "ref": "settings.CustomerFacingIngressNetworkPolicyRequestDestination", + "launch_stage": "PUBLIC_BETA" + }, + "label": { + "description": "The label for this ingress rule.", + "launch_stage": "PUBLIC_BETA" + }, + "origin": { + "ref": "settings.CustomerFacingIngressNetworkPolicyPublicRequestOrigin", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyPublicRequestOrigin": { + "fields": { + "all_ip_ranges": { + "description": "Matches all IPv4 and IPv6 ranges (both public and private).", + "launch_stage": "PUBLIC_BETA" + }, + "excluded_ip_ranges": { + "description": "Excluded means: all public IP ranges except this one.", + "ref": "settings.CustomerFacingIngressNetworkPolicyIpRanges", + "launch_stage": "PUBLIC_BETA" + }, + "included_ip_ranges": { + "description": "Will not allow IP ranges with private IPs.", + "ref": "settings.CustomerFacingIngressNetworkPolicyIpRanges", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyRequestDestination": { + "fields": { + "account_api": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAccountApiDestination", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "account_databricks_one": { + "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW.", + "ref": "settings.CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "account_ui": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAccountUiDestination", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "all_destinations": { + "description": "When true, match all destinations, no other destination fields can be set.\nWhen not set or false, at least one specific destination must be provided.", + "launch_stage": "PUBLIC_BETA" + }, + "apps_runtime": { + "ref": "settings.CustomerFacingIngressNetworkPolicyAppsRuntimeDestination", + "launch_stage": "PUBLIC_BETA" + }, + "lakebase_runtime": { + "ref": "settings.CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination", + "launch_stage": "PUBLIC_BETA" + }, + "workspace_api": { + "ref": "settings.CustomerFacingIngressNetworkPolicyWorkspaceApiDestination", + "launch_stage": "PUBLIC_BETA" + }, + "workspace_ui": { + "ref": "settings.CustomerFacingIngressNetworkPolicyWorkspaceUiDestination", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyWorkspaceApiDestination": { + "fields": { + "scope_qualifier": { + "description": "Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier.", + "ref": "settings.CustomerFacingIngressNetworkPolicyApiScopeQualifier", + "launch_stage": "PUBLIC_BETA" + }, + "scopes": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyWorkspaceIdList": { + "fields": { + "workspace_ids": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.CustomerFacingIngressNetworkPolicyWorkspaceUiDestination": { + "fields": { + "all_destinations": { + "description": "Must be set to true.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule": { + "description": "Properties of the new private endpoint rule.\nNote that for private endpoints towards a VPC endpoint service behind a customer-managed NLB,\nyou must approve the endpoint in AWS console after initialization.", + "fields": { + "account_id": { + "description": "Databricks account ID. You can find your account ID from the Accounts Console.", + "launch_stage": "GA" + }, + "connection_state": { + "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state\nis ESTABLISHED. Remember that you must approve new endpoints on your resources in the AWS console\nbefore they take effect.\nThe possible values are:\n- PENDING: The endpoint has been created and pending approval.\n- ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources.\n- REJECTED: Connection was rejected by the private link resource owner.\n- DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n- EXPIRED: If the endpoint is created but not approved in 14 days, it is EXPIRED.", + "ref": "settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when this object was created.", + "launch_stage": "GA" + }, + "deactivated": { + "description": "Whether this private endpoint is deactivated.", + "launch_stage": "GA" + }, + "deactivated_at": { + "description": "Time in epoch milliseconds when this object was deactivated.", + "launch_stage": "GA" + }, + "domain_names": { + "description": "Only used by private endpoints towards a VPC endpoint service for customer-managed VPC endpoint service.\n\nThe target AWS resource FQDNs accessible via the VPC endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired domain_names is provided.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Only used by private endpoints towards an AWS S3 service.\n\nUpdate this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources.", + "launch_stage": "GA" + }, + "endpoint_service": { + "description": "The full target AWS endpoint service name that connects to the destination resources of the private endpoint.", + "launch_stage": "GA" + }, + "error_message": { + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "launch_stage": "GA" + }, + "resource_names": { + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field.\nPlease ensure a full list of desired resource_names is provided.", + "launch_stage": "GA" + }, + "rule_id": { + "description": "The ID of a private endpoint rule.", + "launch_stage": "GA" + }, + "updated_time": { + "description": "Time in epoch milliseconds when this object was updated.", + "launch_stage": "GA" + }, + "vpc_endpoint_id": { + "description": "The AWS VPC endpoint ID. You can use this ID to identify VPC endpoint created by Databricks.", + "launch_stage": "GA" + } + } + }, + "settings.CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState": { + "enum": [ + "ESTABLISHED", + "REJECTED", + "DISCONNECTED", + "EXPIRED", + "PENDING", + "CREATING", + "CREATE_FAILED" + ], + "enum_launch_stages": { + "CREATE_FAILED": "GA", + "CREATING": "GA", + "DISCONNECTED": "GA", + "ESTABLISHED": "GA", + "EXPIRED": "GA", + "PENDING": "GA", + "REJECTED": "GA" + } + }, + "settings.DashboardEmailSubscriptions": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DefaultNamespaceSetting": { + "description": "This represents the setting configuration for the default namespace in the Databricks workspace.\nSetting the default catalog for the workspace determines the catalog that is used when queries do not reference\na fully qualified 3 level name. For example, if the default catalog is set to 'retail_prod' then a query\n'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema\n'default' is always assumed). This setting requires a restart of clusters and SQL warehouses to take effect.\nAdditionally, the default namespace only applies when using Unity Catalog-enabled compute.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "namespace": { + "ref": "settings.StringMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DefaultWarehouseId": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "string_val": { + "ref": "settings.StringMessage", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.DeleteAccountIpAccessEnableResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.DeleteAibiDashboardEmbeddingAccessPolicySettingResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DeleteDashboardEmailSubscriptionsResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DeleteDefaultNamespaceSettingResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DeleteDefaultWarehouseIdResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.DeleteDisableLegacyAccessResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.DeleteDisableLegacyDbfsResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.DeleteDisableLegacyFeaturesResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.DeleteLlmProxyPartnerPoweredWorkspaceResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.DeletePersonalComputeSettingResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.DeleteRestrictWorkspaceAdminsSettingResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DeleteSqlResultsDownloadResponse": { + "description": "The etag is returned.", + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.DestinationType": { + "enum": [ + "SLACK", + "EMAIL", + "WEBHOOK", + "PAGERDUTY", + "MICROSOFT_TEAMS" + ], + "enum_launch_stages": { + "EMAIL": "GA", + "MICROSOFT_TEAMS": "GA", + "PAGERDUTY": "GA", + "SLACK": "GA", + "WEBHOOK": "GA" + } + }, + "settings.DisableLegacyAccess": { + "fields": { + "disable_legacy_access": { + "ref": "settings.BooleanMessage", + "launch_stage": "GA" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "GA" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "GA" + } + } + }, + "settings.DisableLegacyDbfs": { + "fields": { + "disable_legacy_dbfs": { + "ref": "settings.BooleanMessage", + "launch_stage": "GA" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "GA" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "GA" + } + } + }, + "settings.DisableLegacyFeatures": { + "fields": { + "disable_legacy_features": { + "ref": "settings.BooleanMessage", + "launch_stage": "GA" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "GA" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicy": { + "description": "The network policies applying for egress traffic.\nThis message is used by the UI/REST API. We translate this message to the format expected by the\ndataplane in Lakehouse Network Manager (for the format expected by the dataplane,\nsee networkconfig.textproto).", + "fields": { + "internet_access": { + "description": "The access policy enforced for egress traffic to the internet.", + "ref": "settings.EgressNetworkPolicyInternetAccessPolicy", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicy": { + "fields": { + "allowed_internet_destinations": { + "launch_stage": "GA" + }, + "allowed_storage_destinations": { + "launch_stage": "GA" + }, + "log_only_mode": { + "description": "Optional. If not specified, assume the policy is enforced for all workloads.", + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyMode", + "launch_stage": "GA" + }, + "restriction_mode": { + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyRestrictionMode", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyInternetDestination": { + "description": "Users can specify accessible internet destinations when outbound access is restricted.\nWe only support domain name (FQDN) destinations for the time being,\nthough going forwards we want to support host names and IP addresses.", + "fields": { + "destination": { + "launch_stage": "GA" + }, + "protocol": { + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol", + "launch_stage": "GA" + }, + "type": { + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol": { + "description": "The filtering protocol used by the DP. For private and public preview, SEG will only\nsupport TCP filtering (i.e. DNS based filtering, filtering by destination IP address),\nso protocol will be set to TCP by default and hidden from the user. In the future, users\nmay be able to select HTTP filtering (i.e. SNI based filtering, filtering by FQDN).", + "enum": [ + "TCP" + ], + "enum_launch_stages": { + "TCP": "GA" + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType": { + "enum": [ + "FQDN" + ], + "enum_launch_stages": { + "FQDN": "GA" + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyMode": { + "fields": { + "log_only_mode_type": { + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType", + "launch_stage": "GA" + }, + "workloads": { + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType": { + "enum": [ + "ALL_SERVICES", + "SELECTED_SERVICES" + ], + "enum_launch_stages": { + "ALL_SERVICES": "GA", + "SELECTED_SERVICES": "GA" + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType": { + "description": "The values should match the list of workloads used in networkconfig.proto", + "enum": [ + "DBSQL", + "ML_SERVING" + ], + "enum_launch_stages": { + "DBSQL": "GA", + "ML_SERVING": "GA" + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyRestrictionMode": { + "description": "At which level can Databricks and Databricks managed compute access Internet.\nFULL_ACCESS: Databricks can access Internet. No blocking rules will apply.\nRESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations,\nas well as UC connections and external locations.\nPRIVATE_ACCESS_ONLY (not used): Databricks can only access destinations via private link.", + "enum": [ + "FULL_ACCESS", + "PRIVATE_ACCESS_ONLY", + "RESTRICTED_ACCESS" + ], + "enum_launch_stages": { + "FULL_ACCESS": "GA", + "PRIVATE_ACCESS_ONLY": "GA", + "RESTRICTED_ACCESS": "GA" + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyStorageDestination": { + "description": "Users can specify accessible storage destinations.", + "fields": { + "allowed_paths": { + "launch_stage": "GA" + }, + "azure_container": { + "launch_stage": "GA" + }, + "azure_dns_zone": { + "launch_stage": "GA" + }, + "azure_storage_account": { + "launch_stage": "GA" + }, + "azure_storage_service": { + "launch_stage": "GA" + }, + "bucket_name": { + "launch_stage": "GA" + }, + "region": { + "launch_stage": "GA" + }, + "type": { + "ref": "settings.EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType": { + "enum": [ + "AWS_S3", + "CLOUDFLARE_R2", + "AZURE_STORAGE", + "GOOGLE_CLOUD_STORAGE" + ], + "enum_launch_stages": { + "AWS_S3": "GA", + "AZURE_STORAGE": "GA", + "CLOUDFLARE_R2": "GA", + "GOOGLE_CLOUD_STORAGE": "GA" + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicy": { + "fields": { + "allowed_internet_destinations": { + "description": "List of internet destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "allowed_storage_destinations": { + "description": "List of storage destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "blocked_internet_destinations": { + "description": "List of internet destinations that serverless workloads are blocked from accessing.\nThese destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN.\nCurrently supports DNS_NAME type only; IP_RANGE support is planned.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy_enforcement": { + "description": "Optional. When policy_enforcement is not provided, we default to ENFORCE_MODE_ALL_SERVICES", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "restriction_mode": { + "description": "The restriction mode that controls how serverless workloads can access the internet.", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicyRestrictionMode", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyInternetDestination": { + "description": "Users can specify accessible internet destinations when outbound access is restricted.\nWe only support DNS_NAME (FQDN format) destinations for the time being.\nGoing forward we may extend support to host names and IP addresses.", + "fields": { + "destination": { + "description": "The internet destination to which access will be allowed. Format dependent on the destination type.", + "launch_stage": "GA" + }, + "internet_destination_type": { + "description": "The type of internet destination. Currently only DNS_NAME is supported.", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType": { + "enum": [ + "DNS_NAME" + ], + "enum_launch_stages": { + "DNS_NAME": "GA" + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement": { + "fields": { + "dry_run_mode_product_filter": { + "description": "When empty, it means dry run for all products.\nWhen non-empty, it means dry run for specific products and for the other products, they will run in enforced mode.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "enforcement_mode": { + "description": "The mode of policy enforcement. ENFORCED blocks traffic that violates policy,\nwhile DRY_RUN only logs violations without blocking. When not specified,\ndefaults to ENFORCED.", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter": { + "description": "The values should match the list of workloads used in networkconfig.proto", + "enum": [ + "DBSQL", + "ML_SERVING" + ], + "enum_launch_stages": { + "DBSQL": "GA", + "ML_SERVING": "GA" + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode": { + "enum": [ + "ENFORCED", + "DRY_RUN" + ], + "enum_launch_stages": { + "DRY_RUN": "GA", + "ENFORCED": "GA" + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyRestrictionMode": { + "description": "At which level can Databricks and Databricks managed compute access Internet.\nFULL_ACCESS: Databricks can access Internet. No blocking rules will apply.\nRESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations,\nas well as UC connections and external locations.", + "enum": [ + "FULL_ACCESS", + "RESTRICTED_ACCESS" + ], + "enum_launch_stages": { + "FULL_ACCESS": "GA", + "RESTRICTED_ACCESS": "GA" + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyStorageDestination": { + "description": "Users can specify accessible storage destinations.", + "fields": { + "azure_storage_account": { + "description": "The Azure storage account name.", + "launch_stage": "GA" + }, + "azure_storage_service": { + "description": "The Azure storage service type (blob, dfs, etc.).", + "launch_stage": "GA" + }, + "bucket_name": { + "launch_stage": "GA" + }, + "region": { + "launch_stage": "GA" + }, + "storage_destination_type": { + "description": "The type of storage destination.", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType", + "launch_stage": "GA" + } + } + }, + "settings.EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType": { + "enum": [ + "AWS_S3", + "AZURE_STORAGE", + "GOOGLE_CLOUD_STORAGE" + ], + "enum_launch_stages": { + "AWS_S3": "GA", + "AZURE_STORAGE": "GA", + "GOOGLE_CLOUD_STORAGE": "GA" + } + }, + "settings.EgressResourceType": { + "description": "The target resources that are supported by Network Connectivity Config.\nNote: some egress types can support general types that are not defined in EgressResourceType.\nE.g.: Azure private endpoint supports private link enabled Azure services.", + "enum": [ + "AZURE_BLOB_STORAGE" + ], + "enum_launch_stages": { + "AZURE_BLOB_STORAGE": "GA" + } + }, + "settings.EmailConfig": { + "fields": { + "addresses": { + "description": "Email addresses to notify.", + "launch_stage": "GA" + } + } + }, + "settings.Empty": {}, + "settings.EnableExportNotebook": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EnableNotebookTableClipboard": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EnableResultsDownloading": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EnhancedSecurityMonitoring": { + "description": "SHIELD feature: ESM\nEnhanced Security Monitoring (ESM) enables additional security monitoring on the workspace.", + "fields": { + "is_enabled": { + "description": "Whether Enhanced Security Monitoring (ESM) is enabled on the workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EnhancedSecurityMonitoringSetting": { + "fields": { + "enhanced_security_monitoring_workspace": { + "ref": "settings.EnhancedSecurityMonitoring", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EsmEnablementAccount": { + "description": "Account level policy for ESM", + "fields": { + "is_enforced": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.EsmEnablementAccountSetting": { + "fields": { + "esm_enablement_account": { + "ref": "settings.EsmEnablementAccount", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.ExchangeToken": { + "description": "The exchange token is the result of the token exchange with the IdP", + "fields": { + "credential": { + "description": "The requested token.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "credentialEolTime": { + "description": "The end-of-life timestamp of the token. The value is in milliseconds since the Unix epoch.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "ownerId": { + "description": "User ID of the user that owns this token.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "scopes": { + "description": "The scopes of access granted in the token.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "tokenType": { + "description": "The type of this exchange token", + "ref": "settings.TokenType", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.ExchangeTokenRequest": { + "description": "Exchange a token with the IdP", + "fields": { + "partitionId": { + "description": "The partition of Credentials store", + "ref": "settings.PartitionId", + "launch_stage": "PRIVATE_PREVIEW" + }, + "scopes": { + "description": "Array of scopes for the token request.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "tokenType": { + "description": "A list of token types being requested", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.ExchangeTokenResponse": { + "description": "Exhanged tokens were successfully returned.", + "fields": { + "values": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.FetchIpAccessListResponse": { + "description": "An IP access list was successfully returned.", + "fields": { + "ip_access_list": { + "ref": "settings.IpAccessListInfo", + "launch_stage": "GA" + } + } + }, + "settings.GcpEndpoint": { + "fields": { + "psc_endpoint_uri": { + "description": "Output only. The URI of the created PSC endpoint.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "service_attachment": { + "description": "The full url of the target service attachment.\nExample:\nprojects/my-gcp-project/regions/us-east4/serviceAttachments/my-service-attachment", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GenericWebhookConfig": { + "fields": { + "password": { + "description": "[Input-Only][Optional] Password for webhook.", + "launch_stage": "GA" + }, + "password_set": { + "description": "[Output-Only] Whether password is set.", + "launch_stage": "GA" + }, + "url": { + "description": "[Input-Only] URL for webhook.", + "launch_stage": "GA" + }, + "url_set": { + "description": "[Output-Only] Whether URL is set.", + "launch_stage": "GA" + }, + "username": { + "description": "[Input-Only][Optional] Username for webhook.", + "launch_stage": "GA" + }, + "username_set": { + "description": "[Output-Only] Whether username is set.", + "launch_stage": "GA" + } + } + }, + "settings.GetIPAccessListResponse": { + "fields": { + "ip_access_list": { + "ref": "settings.IpAccessListInfo", + "launch_stage": "GA" + } + } + }, + "settings.GetIPAccessListsResponse": { + "description": "IP access lists were successfully returned.", + "fields": { + "ip_access_lists": { + "launch_stage": "GA" + } + } + }, + "settings.GetTokenPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "settings.GetTokenResponse": { + "description": "Token with specified Token ID was successfully returned.", + "fields": { + "token_info": { + "ref": "settings.TokenInfo", + "launch_stage": "GA" + } + } + }, + "settings.IpAccessListInfo": { + "description": "Definition of an IP Access list", + "fields": { + "address_count": { + "description": "Total number of IP or CIDR values.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Creation timestamp in milliseconds.", + "launch_stage": "GA" + }, + "created_by": { + "description": "User ID of the user who created this list.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Specifies whether this IP access list is enabled.", + "launch_stage": "GA" + }, + "ip_addresses": { + "launch_stage": "GA" + }, + "label": { + "description": "Label for the IP access list. This **cannot** be empty.", + "launch_stage": "GA" + }, + "list_id": { + "description": "Universally unique identifier (UUID) of the IP access list.", + "launch_stage": "GA" + }, + "list_type": { + "ref": "settings.list_type", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Update timestamp in milliseconds.", + "launch_stage": "GA" + }, + "updated_by": { + "description": "User ID of the user who updated this list.", + "launch_stage": "GA" + } + } + }, + "settings.ListIPAccessListResponse": { + "description": "IP access lists were successfully returned.", + "fields": { + "ip_access_lists": { + "launch_stage": "GA" + } + } + }, + "settings.ListNetworkConnectivityConfigurationsResponse": { + "description": "The network connectivity configuration list was successfully retrieved.", + "fields": { + "items": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If null, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "settings.ListNetworkPoliciesResponse": { + "fields": { + "items": { + "description": "List of network policies.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If null, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "settings.ListNotificationDestinationsResponse": { + "fields": { + "next_page_token": { + "description": "Page token for next of results.", + "launch_stage": "GA" + }, + "results": { + "launch_stage": "GA" + } + } + }, + "settings.ListNotificationDestinationsResult": { + "fields": { + "destination_type": { + "description": "[Output-only] The type of the notification destination. The type can not be changed once set.", + "ref": "settings.DestinationType", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name for the notification destination.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying notification destination.", + "launch_stage": "GA" + } + } + }, + "settings.ListPrivateEndpointRulesResponse": { + "description": "The private endpoint rule list was successfully retrieved.", + "fields": { + "items": { + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If null, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "settings.ListPublicTokensResponse": { + "fields": { + "token_infos": { + "description": "The information for each token.", + "launch_stage": "GA" + } + } + }, + "settings.ListTokensResponse": { + "description": "Tokens were successfully returned.", + "fields": { + "token_infos": { + "description": "Token metadata of each user-created token in the workspace", + "launch_stage": "GA" + } + } + }, + "settings.LlmProxyPartnerPoweredAccount": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PRIVATE_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.LlmProxyPartnerPoweredEnforce": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PRIVATE_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.LlmProxyPartnerPoweredWorkspace": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PRIVATE_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.MicrosoftTeamsConfig": { + "fields": { + "app_id": { + "description": "[Input-Only] App ID for Microsoft Teams App.", + "launch_stage": "GA" + }, + "app_id_set": { + "description": "[Output-Only] Whether App ID is set.", + "launch_stage": "GA" + }, + "auth_secret": { + "description": "[Input-Only] Secret for Microsoft Teams App authentication.", + "launch_stage": "GA" + }, + "auth_secret_set": { + "description": "[Output-Only] Whether secret is set.", + "launch_stage": "GA" + }, + "channel_url": { + "description": "[Input-Only] Channel URL for Microsoft Teams App.", + "launch_stage": "GA" + }, + "channel_url_set": { + "description": "[Output-Only] Whether Channel URL is set.", + "launch_stage": "GA" + }, + "tenant_id": { + "description": "[Input-Only] Tenant ID for Microsoft Teams App.", + "launch_stage": "GA" + }, + "tenant_id_set": { + "description": "[Output-Only] Whether Tenant ID is set.", + "launch_stage": "GA" + }, + "url": { + "description": "[Input-Only] URL for Microsoft Teams webhook.", + "launch_stage": "GA" + }, + "url_set": { + "description": "[Output-Only] Whether URL is set.", + "launch_stage": "GA" + } + } + }, + "settings.NccAwsStableIpRule": { + "description": "The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace.", + "fields": { + "cidr_blocks": { + "description": "The list of stable IP CIDR blocks from which Databricks network traffic originates when accessing your resources.", + "launch_stage": "GA" + } + } + }, + "settings.NccAzurePrivateEndpointRule": { + "description": "Properties of the new private endpoint rule.\nNote that you must approve the endpoint in Azure portal after initialization.", + "fields": { + "connection_state": { + "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state\nis ESTABLISHED. Remember that you must approve new endpoints on your resources in the Azure portal\nbefore they take effect.\nThe possible values are:\n- INIT: (deprecated) The endpoint has been created and pending approval.\n- PENDING: The endpoint has been created and pending approval.\n- ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources.\n- REJECTED: Connection was rejected by the private link resource owner.\n- DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n- EXPIRED: If the endpoint was created but not approved in 14 days, it will be EXPIRED.", + "ref": "settings.NccAzurePrivateEndpointRuleConnectionState", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when this object was created.", + "launch_stage": "GA" + }, + "deactivated": { + "description": "Whether this private endpoint is deactivated.", + "launch_stage": "GA" + }, + "deactivated_at": { + "description": "Time in epoch milliseconds when this object was deactivated.", + "launch_stage": "GA" + }, + "domain_names": { + "description": "Not used by customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "launch_stage": "GA" + }, + "endpoint_name": { + "description": "The name of the Azure private endpoint resource.", + "launch_stage": "GA" + }, + "error_message": { + "launch_stage": "GA" + }, + "group_id": { + "description": "Only used by private endpoints to Azure first-party services.\n\nThe sub-resource type (group ID) of the target resource.\nNote that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.", + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "launch_stage": "GA" + }, + "resource_id": { + "description": "The Azure resource ID of the target resource.", + "launch_stage": "GA" + }, + "rule_id": { + "description": "The ID of a private endpoint rule.", + "launch_stage": "GA" + }, + "updated_time": { + "description": "Time in epoch milliseconds when this object was updated.", + "launch_stage": "GA" + } + } + }, + "settings.NccAzurePrivateEndpointRuleConnectionState": { + "enum": [ + "INIT", + "ESTABLISHED", + "REJECTED", + "DISCONNECTED", + "EXPIRED", + "PENDING", + "CREATING", + "CREATE_FAILED" + ], + "enum_launch_stages": { + "CREATE_FAILED": "GA", + "CREATING": "GA", + "DISCONNECTED": "GA", + "ESTABLISHED": "GA", + "EXPIRED": "GA", + "INIT": "GA", + "PENDING": "GA", + "REJECTED": "GA" + } + }, + "settings.NccAzureServiceEndpointRule": { + "description": "The stable Azure service endpoints. You can configure the firewall of your Azure resources\nto allow traffic from your Databricks serverless compute resources.", + "fields": { + "subnets": { + "description": "The list of subnets from which Databricks network traffic originates when accessing your Azure resources.", + "launch_stage": "GA" + }, + "target_region": { + "description": "The Azure region in which this service endpoint rule applies..", + "launch_stage": "GA" + }, + "target_services": { + "description": "The Azure services to which this service endpoint rule applies to.", + "launch_stage": "GA" + } + } + }, + "settings.NccEgressConfig": { + "fields": { + "default_rules": { + "description": "The network connectivity rules that are applied by default without resource specific configurations.\nYou can find the stable network information of your serverless compute resources here.", + "ref": "settings.NccEgressDefaultRules", + "launch_stage": "GA" + }, + "target_rules": { + "description": "The network connectivity rules that configured for each destinations. These rules override default rules.", + "ref": "settings.NccEgressTargetRules", + "launch_stage": "GA" + } + } + }, + "settings.NccEgressDefaultRules": { + "description": "Default rules don't have specific targets.", + "fields": { + "aws_stable_ip_rule": { + "ref": "settings.NccAwsStableIpRule", + "launch_stage": "GA" + }, + "azure_service_endpoint_rule": { + "ref": "settings.NccAzureServiceEndpointRule", + "launch_stage": "GA" + } + } + }, + "settings.NccEgressTargetRules": { + "description": "Target rule controls the egress rules that are dedicated to specific resources.", + "fields": { + "aws_private_endpoint_rules": { + "description": "AWS private endpoint rule controls the AWS private endpoint based egress rules.", + "launch_stage": "GA" + }, + "azure_private_endpoint_rules": { + "launch_stage": "GA" + } + } + }, + "settings.NccPrivateEndpointRule": { + "description": "Properties of the new private endpoint rule.\nNote that you must approve the endpoint in Azure portal after initialization.", + "fields": { + "account_id": { + "description": "Databricks account ID. You can find your account ID from the Accounts Console.", + "launch_stage": "GA" + }, + "connection_state": { + "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state\nis ESTABLISHED. Remember that you must approve new endpoints on your resources in the Cloud console\nbefore they take effect.\nThe possible values are:\n- PENDING: The endpoint has been created and pending approval.\n- ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources.\n- REJECTED: Connection was rejected by the private link resource owner.\n- DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n- EXPIRED: If the endpoint was created but not approved in 14 days, it will be EXPIRED.\n- CREATING: The endpoint creation is in progress. Once successfully created, the state will transition to PENDING.\n- CREATE_FAILED: The endpoint creation failed. You can check the error_message field for more details.", + "ref": "settings.NccPrivateEndpointRulePrivateLinkConnectionState", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when this object was created.", + "launch_stage": "GA" + }, + "deactivated": { + "description": "Whether this private endpoint is deactivated.", + "launch_stage": "GA" + }, + "deactivated_at": { + "description": "Time in epoch milliseconds when this object was deactivated.", + "launch_stage": "GA" + }, + "domain_names": { + "description": "Only used by private endpoints to customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Update this field to activate/deactivate this private endpoint to allow egress access from\nserverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "endpoint_name": { + "description": "The name of the Azure private endpoint resource.", + "launch_stage": "GA" + }, + "endpoint_service": { + "description": "The full target AWS endpoint service name that connects to the destination resources of the private endpoint.", + "launch_stage": "GA" + }, + "error_message": { + "launch_stage": "GA" + }, + "gcp_endpoint": { + "ref": "settings.GcpEndpoint", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "group_id": { + "description": "Not used by customer-managed private endpoint services.\n\nThe sub-resource type (group ID) of the target resource.\nNote that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.", + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "launch_stage": "GA" + }, + "resource_id": { + "description": "The Azure resource ID of the target resource.", + "launch_stage": "GA" + }, + "resource_names": { + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rule_id": { + "description": "The ID of a private endpoint rule.", + "launch_stage": "GA" + }, + "updated_time": { + "description": "Time in epoch milliseconds when this object was updated.", + "launch_stage": "GA" + }, + "vpc_endpoint_id": { + "description": "The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by Databricks.", + "launch_stage": "GA" + } + } + }, + "settings.NccPrivateEndpointRulePrivateLinkConnectionState": { + "enum": [ + "ESTABLISHED", + "REJECTED", + "DISCONNECTED", + "EXPIRED", + "PENDING", + "CREATING", + "CREATE_FAILED" + ], + "enum_launch_stages": { + "CREATE_FAILED": "GA", + "CREATING": "GA", + "DISCONNECTED": "GA", + "ESTABLISHED": "GA", + "EXPIRED": "GA", + "PENDING": "GA", + "REJECTED": "GA" + } + }, + "settings.NetworkConnectivityConfiguration": { + "description": "Properties of the new network connectivity configuration.", + "fields": { + "account_id": { + "description": "Your Databricks account ID. You can find your account ID in your Databricks accounts console.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Time in epoch milliseconds when this object was created.", + "launch_stage": "GA" + }, + "egress_config": { + "description": "The network connectivity rules that apply to network traffic from your serverless compute resources.", + "ref": "settings.NccEgressConfig", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "launch_stage": "GA" + }, + "network_connectivity_config_id": { + "description": "Databricks network connectivity configuration ID.", + "launch_stage": "GA" + }, + "region": { + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "launch_stage": "GA" + }, + "updated_time": { + "description": "Time in epoch milliseconds when this object was updated.", + "launch_stage": "GA" + } + } + }, + "settings.NetworkPolicyEgress": { + "description": "The network policies applying for egress traffic.\nThis message is used by the UI/REST API. We translate this message to the format expected by the\ndataplane in Lakehouse Network Manager (for the format expected by the dataplane, see networkconfig.textproto).\nThis policy should be consistent with [[com.databricks.api.proto.settingspolicy.EgressNetworkPolicy]].\nDetails see API-design: https://docs.google.com/document/d/1DKWO_FpZMCY4cF2O62LpwII1lx8gsnDGG-qgE3t3TOA/", + "fields": { + "network_access": { + "description": "The access policy enforced for egress traffic to the internet.", + "ref": "settings.EgressNetworkPolicyNetworkAccessPolicy", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.NotificationDestination": { + "fields": { + "config": { + "description": "The configuration for the notification destination. Will be exactly one of the nested configs. Only returns for users with workspace admin permissions.", + "ref": "settings.Config", + "launch_stage": "GA" + }, + "destination_type": { + "description": "[Output-only] The type of the notification destination. The type can not be changed once set.", + "ref": "settings.DestinationType", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name for the notification destination.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying notification destination.", + "launch_stage": "GA" + } + } + }, + "settings.PagerdutyConfig": { + "fields": { + "integration_key": { + "description": "[Input-Only] Integration key for PagerDuty.", + "launch_stage": "GA" + }, + "integration_key_set": { + "description": "[Output-Only] Whether integration key is set.", + "launch_stage": "GA" + } + } + }, + "settings.PartitionId": { + "description": "Partition by workspace or account", + "fields": { + "workspaceId": { + "description": "The ID of the workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.PersonalComputeMessage": { + "fields": { + "value": { + "ref": "settings.PersonalComputeMessageEnum", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.PersonalComputeMessageEnum": { + "description": "ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources.\nDELEGATE: Moves access control for the Personal Compute default policy to individual workspaces and requires a workspace’s users or groups to be added to the ACLs of that workspace’s Personal Compute default policy before they will be able to create compute resources through that policy.", + "enum": [ + "ON", + "DELEGATE" + ], + "enum_launch_stages": { + "DELEGATE": "PRIVATE_PREVIEW", + "ON": "PRIVATE_PREVIEW" + } + }, + "settings.PersonalComputeSetting": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "personal_compute": { + "ref": "settings.PersonalComputeMessage", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.PublicTokenInfo": { + "fields": { + "autoscope_state": { + "description": "Output only. The autoscope state of this token.", + "ref": "iam.AutoscopeState", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "backfill_scopes": { + "description": "Output only. Scopes inferred from offline backfill processing.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment the token was created with, if applicable.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Server time (in epoch milliseconds) when the token was created.", + "launch_stage": "GA" + }, + "expiry_time": { + "description": "Server time (in epoch milliseconds) when the token will expire, or -1 if not applicable.", + "launch_stage": "GA" + }, + "inferred_scopes": { + "description": "Output only. Inferred API path scopes collected for this token when autoscope is enabled.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "scopes": { + "description": "Scope of the token was created with, if applicable.", + "launch_stage": "GA" + }, + "token_id": { + "description": "The ID of this token.", + "launch_stage": "GA" + } + } + }, + "settings.ReplaceIPAccessList": { + "description": "Details required to replace an IP access list.", + "fields": { + "enabled": { + "description": "Specifies whether this IP access list is enabled.", + "launch_stage": "GA" + }, + "ip_addresses": { + "launch_stage": "GA" + }, + "label": { + "description": "Label for the IP access list. This **cannot** be empty.", + "launch_stage": "GA" + }, + "list_type": { + "ref": "settings.list_type", + "launch_stage": "GA" + } + } + }, + "settings.RestrictWorkspaceAdminsMessage": { + "fields": { + "disable_gov_tag_creation": { + "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "status": { + "ref": "settings.RestrictWorkspaceAdminsMessageStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.RestrictWorkspaceAdminsMessageStatus": { + "enum": [ + "ALLOW_ALL", + "RESTRICT_TOKENS_AND_JOB_RUN_AS" + ], + "enum_launch_stages": { + "ALLOW_ALL": "PUBLIC_PREVIEW", + "RESTRICT_TOKENS_AND_JOB_RUN_AS": "PUBLIC_PREVIEW" + } + }, + "settings.RestrictWorkspaceAdminsSetting": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "restrict_workspace_admins": { + "ref": "settings.RestrictWorkspaceAdminsMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.RevokeTokenRequest": { + "fields": { + "token_id": { + "description": "The ID of the token to be revoked.", + "launch_stage": "GA" + } + } + }, + "settings.RevokeTokenResponse": {}, + "settings.SlackConfig": { + "fields": { + "channel_id": { + "description": "[Input-Only] Slack channel ID for notifications.", + "launch_stage": "GA" + }, + "channel_id_set": { + "description": "[Output-Only] Whether channel ID is set.", + "launch_stage": "GA" + }, + "oauth_token": { + "description": "[Input-Only] OAuth token for Slack authentication.", + "launch_stage": "GA" + }, + "oauth_token_set": { + "description": "[Output-Only] Whether OAuth token is set.", + "launch_stage": "GA" + }, + "url": { + "description": "[Input-Only] URL for Slack destination.", + "launch_stage": "GA" + }, + "url_set": { + "description": "[Output-Only] Whether URL is set.", + "launch_stage": "GA" + } + } + }, + "settings.SqlResultsDownload": { + "fields": { + "boolean_val": { + "ref": "settings.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag provided.\nThis is used for optimistic concurrency control as a way to help prevent simultaneous\nwrites of a setting overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e update pattern to perform setting updates in\norder to avoid race conditions. That is, get an etag from a GET request, and pass it\nwith the PATCH request to identify the setting version you are updating.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting_name": { + "description": "Name of the corresponding setting. This field is populated in the response, but it will not be respected\neven if it's set in the request body. The setting name in the path parameter will be\nrespected instead. Setting name is required to be 'default' if the setting only has one instance per workspace.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.StringMessage": { + "fields": { + "value": { + "description": "Represents a generic string value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.TokenAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "settings.TokenPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "settings.TokenAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "settings.TokenInfo": { + "fields": { + "autoscope_state": { + "description": "Output only. The autoscope state of this token.", + "ref": "iam.AutoscopeState", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "backfill_scopes": { + "description": "Output only. Scopes inferred from offline backfill processing.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "comment": { + "description": "Comment that describes the purpose of the token, specified by the token creator.", + "launch_stage": "GA" + }, + "created_by_id": { + "description": "User ID of the user that created the token.", + "launch_stage": "GA" + }, + "created_by_username": { + "description": "Username of the user that created the token.", + "launch_stage": "GA" + }, + "creation_time": { + "description": "Timestamp when the token was created.", + "launch_stage": "GA" + }, + "expiry_time": { + "description": "Timestamp when the token expires.", + "launch_stage": "GA" + }, + "inferred_scopes": { + "description": "Output only. Inferred API path scopes collected for this token when autoscope is enabled.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "last_used_day": { + "description": "Approximate timestamp for the day the token was last used. Accurate up to 1 day.", + "launch_stage": "GA" + }, + "owner_id": { + "description": "User ID of the user that owns the token.", + "launch_stage": "GA" + }, + "scopes": { + "description": "Scope of the token was created with, if applicable.", + "launch_stage": "GA" + }, + "token_id": { + "description": "ID of the token.", + "launch_stage": "GA" + }, + "workspace_id": { + "description": "If applicable, the ID of the workspace that the token was created in.", + "launch_stage": "GA" + } + } + }, + "settings.TokenPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "settings.TokenPermissionLevel", + "launch_stage": "GA" + } + } + }, + "settings.TokenPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_USE" + ] + }, + "settings.TokenPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "settings.TokenPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "settings.TokenPermissionLevel", + "launch_stage": "GA" + } + } + }, + "settings.TokenPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "settings.TokenType": { + "description": "The type of token request. As of now, only `AZURE_ACTIVE_DIRECTORY_TOKEN` is supported.", + "enum": [ + "AZURE_ACTIVE_DIRECTORY_TOKEN", + "ARCLIGHT_AZURE_EXCHANGE_TOKEN", + "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY", + "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN", + "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + ], + "enum_launch_stages": { + "ARCLIGHT_AZURE_EXCHANGE_TOKEN": "PRIVATE_PREVIEW", + "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY": "PRIVATE_PREVIEW", + "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN": "PRIVATE_PREVIEW", + "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY": "PRIVATE_PREVIEW", + "AZURE_ACTIVE_DIRECTORY_TOKEN": "PRIVATE_PREVIEW" + } + }, + "settings.UpdateAccountIpAccessEnableRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.AccountIpAccessEnable", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdateAibiDashboardEmbeddingAccessPolicySettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.AibiDashboardEmbeddingAccessPolicySetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.AibiDashboardEmbeddingApprovedDomainsSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateAutomaticClusterUpdateSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.AutomaticClusterUpdateSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateComplianceSecurityProfileSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.ComplianceSecurityProfileSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateCspEnablementAccountSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.CspEnablementAccountSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateDashboardEmailSubscriptionsRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.DashboardEmailSubscriptions", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateDefaultNamespaceSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.DefaultNamespaceSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateDefaultWarehouseIdRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.DefaultWarehouseId", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdateDisableLegacyAccessRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "GA" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + }, + "setting": { + "ref": "settings.DisableLegacyAccess", + "launch_stage": "GA" + } + } + }, + "settings.UpdateDisableLegacyDbfsRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "GA" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + }, + "setting": { + "ref": "settings.DisableLegacyDbfs", + "launch_stage": "GA" + } + } + }, + "settings.UpdateDisableLegacyFeaturesRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "GA" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + }, + "setting": { + "ref": "settings.DisableLegacyFeatures", + "launch_stage": "GA" + } + } + }, + "settings.UpdateEnableExportNotebookRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.EnableExportNotebook", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateEnableNotebookTableClipboardRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.EnableNotebookTableClipboard", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateEnableResultsDownloadingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.EnableResultsDownloading", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateEnhancedSecurityMonitoringSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.EnhancedSecurityMonitoringSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateEsmEnablementAccountSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.EsmEnablementAccountSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateIPAccessList": { + "description": "Details required to update an IP access list.", + "fields": { + "enabled": { + "description": "Specifies whether this IP access list is enabled.", + "launch_stage": "GA" + }, + "ip_addresses": { + "launch_stage": "GA" + }, + "label": { + "description": "Label for the IP access list. This **cannot** be empty.", + "launch_stage": "GA" + }, + "list_type": { + "ref": "settings.list_type", + "launch_stage": "GA" + } + } + }, + "settings.UpdateLlmProxyPartnerPoweredAccountRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.LlmProxyPartnerPoweredAccount", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdateLlmProxyPartnerPoweredEnforceRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.LlmProxyPartnerPoweredEnforce", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdateLlmProxyPartnerPoweredWorkspaceRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.LlmProxyPartnerPoweredWorkspace", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdateNotificationDestinationRequest": { + "fields": { + "config": { + "description": "The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.", + "ref": "settings.Config", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name for the notification destination.", + "launch_stage": "GA" + } + } + }, + "settings.UpdatePersonalComputeSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "setting": { + "ref": "settings.PersonalComputeSetting", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.UpdatePrivateEndpointRule": { + "description": "Properties of the new private endpoint rule.\nNote that you must approve the endpoint in Azure portal after initialization.", + "fields": { + "domain_names": { + "description": "Only used by private endpoints to customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "launch_stage": "GA" + }, + "enabled": { + "description": "Update this field to activate/deactivate this private endpoint to allow egress access from\nserverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "error_message": { + "launch_stage": "GA" + }, + "gcp_endpoint": { + "ref": "settings.GcpEndpoint", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "resource_names": { + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateRestrictWorkspaceAdminsSettingRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.RestrictWorkspaceAdminsSetting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateSqlResultsDownloadRequest": { + "description": "Details required to update a setting.", + "fields": { + "allow_missing": { + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "field_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "setting": { + "ref": "settings.SqlResultsDownload", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.UpdateTokenManagementRequest": { + "description": "For the list of supported token scopes, see\nhttps://docs.databricks.com/api/workspace/api/scopes.", + "fields": { + "token": { + "ref": "settings.TokenInfo", + "launch_stage": "GA" + }, + "update_mask": { + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "settings.UpdateTokenRequest": { + "description": "For the list of supported token scopes, see\nhttps://docs.databricks.com/api/workspace/api/scopes.", + "fields": { + "token": { + "ref": "settings.PublicTokenInfo", + "launch_stage": "GA" + }, + "update_mask": { + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "settings.UpdateTokenResponse": {}, + "settings.WorkspaceConf": { + "launch_stage": "GA" + }, + "settings.WorkspaceNetworkOption": { + "fields": { + "network_policy_id": { + "description": "The network policy ID to apply to the workspace. This controls the network access rules\nfor all serverless compute resources in the workspace. Each workspace can only be\nlinked to one policy at a time. If no policy is explicitly assigned,\nthe workspace will use 'default-policy'.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "workspace_id": { + "description": "The workspace ID.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settings.list_type": { + "description": "Type of IP access list. Valid values are as follows and are case-sensitive:\n\n* `ALLOW`: An allow list. Include this IP or range.\n* `BLOCK`: A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list.", + "enum": [ + "ALLOW", + "BLOCK" + ], + "enum_launch_stages": { + "ALLOW": "GA", + "BLOCK": "GA" + }, + "enum_descriptions": { + "ALLOW": "An allow list. Include this IP or range.", + "BLOCK": "A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list." + } + }, + "settingsv2.AibiDashboardEmbeddingAccessPolicy": { + "fields": { + "access_policy_type": { + "ref": "settingsv2.AibiDashboardEmbeddingAccessPolicyAccessPolicyType", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.AibiDashboardEmbeddingAccessPolicyAccessPolicyType": { + "enum": [ + "ALLOW_ALL_DOMAINS", + "ALLOW_APPROVED_DOMAINS", + "DENY_ALL_DOMAINS" + ], + "enum_launch_stages": { + "ALLOW_ALL_DOMAINS": "PUBLIC_PREVIEW", + "ALLOW_APPROVED_DOMAINS": "PUBLIC_PREVIEW", + "DENY_ALL_DOMAINS": "PUBLIC_PREVIEW" + } + }, + "settingsv2.AibiDashboardEmbeddingApprovedDomains": { + "fields": { + "approved_domains": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.AllowedAppsUserApiScopesMessage": { + "fields": { + "allowed_scopes": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.BooleanMessage": { + "fields": { + "value": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ClusterAutoRestartMessage": { + "fields": { + "can_toggle": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "enabled": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "enablement_details": { + "ref": "settingsv2.ClusterAutoRestartMessageEnablementDetails", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "maintenance_window": { + "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindow", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "restart_even_if_no_updates_available": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ClusterAutoRestartMessageEnablementDetails": { + "description": "Contains an information about the enablement status judging (e.g. whether the enterprise tier\nis enabled)\nThis is only additional information that MUST NOT be used to decide whether the setting is\nenabled or not. This is intended to use only for purposes like showing an error message to\nthe customer with the additional details. For example, using these details we can check\nwhy exactly the feature is disabled for this customer.", + "fields": { + "forced_for_compliance_mode": { + "description": "The feature is force enabled if compliance mode is active", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "unavailable_for_disabled_entitlement": { + "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "unavailable_for_non_enterprise_tier": { + "description": "The feature is unavailable if the customer doesn't have enterprise tier", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ClusterAutoRestartMessageMaintenanceWindow": { + "fields": { + "week_day_based_schedule": { + "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek": { + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enum_launch_stages": { + "FRIDAY": "PUBLIC_PREVIEW", + "MONDAY": "PUBLIC_PREVIEW", + "SATURDAY": "PUBLIC_PREVIEW", + "SUNDAY": "PUBLIC_PREVIEW", + "THURSDAY": "PUBLIC_PREVIEW", + "TUESDAY": "PUBLIC_PREVIEW", + "WEDNESDAY": "PUBLIC_PREVIEW" + } + }, + "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule": { + "fields": { + "day_of_week": { + "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "frequency": { + "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "window_start_time": { + "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency": { + "enum": [ + "FIRST_OF_MONTH", + "SECOND_OF_MONTH", + "THIRD_OF_MONTH", + "FOURTH_OF_MONTH", + "FIRST_AND_THIRD_OF_MONTH", + "SECOND_AND_FOURTH_OF_MONTH", + "EVERY_WEEK" + ], + "enum_launch_stages": { + "EVERY_WEEK": "PUBLIC_PREVIEW", + "FIRST_AND_THIRD_OF_MONTH": "PUBLIC_PREVIEW", + "FIRST_OF_MONTH": "PUBLIC_PREVIEW", + "FOURTH_OF_MONTH": "PUBLIC_PREVIEW", + "SECOND_AND_FOURTH_OF_MONTH": "PUBLIC_PREVIEW", + "SECOND_OF_MONTH": "PUBLIC_PREVIEW", + "THIRD_OF_MONTH": "PUBLIC_PREVIEW" + } + }, + "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime": { + "fields": { + "hours": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "minutes": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.CollaborationPlatformConnectivityMessage": { + "description": "Controls which external collaboration platforms (Slack, Microsoft Teams) can connect\nto a workspace. Defaults to ALLOW_ALL.", + "fields": { + "connectivity": { + "ref": "settingsv2.CollaborationPlatformConnectivityMessageConnectivity", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.CollaborationPlatformConnectivityMessageConnectivity": { + "enum": [ + "ALLOW_ALL", + "ALLOW_TEAMS", + "ALLOW_SLACK", + "DENY_ALL" + ], + "enum_launch_stages": { + "ALLOW_ALL": "PRIVATE_PREVIEW", + "ALLOW_SLACK": "PRIVATE_PREVIEW", + "ALLOW_TEAMS": "PRIVATE_PREVIEW", + "DENY_ALL": "PRIVATE_PREVIEW" + } + }, + "settingsv2.IntegerMessage": { + "fields": { + "value": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.ListAccountSettingsMetadataResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "settings_metadata": { + "description": "List of all settings available via public APIs and their metadata", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settingsv2.ListAccountUserPreferencesMetadataResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_BETA" + }, + "settings_metadata": { + "description": "List of all settings available via public APIs and their metadata", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settingsv2.ListWorkspaceSettingsMetadataResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "settings_metadata": { + "description": "List of all settings available via public APIs and their metadata", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settingsv2.OperationalEmailCustomRecipientMessage": { + "fields": { + "email": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.PersonalComputeMessage": { + "fields": { + "value": { + "ref": "settingsv2.PersonalComputeMessagePersonalComputeMessageEnum", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.PersonalComputeMessagePersonalComputeMessageEnum": { + "description": "ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources.\nDELEGATE: Moves access control for the Personal Compute default policy to individual workspaces and requires a workspace’s users or groups to be added to the ACLs of that workspace’s Personal Compute default policy before they will be able to create compute resources through that policy.", + "enum": [ + "ON", + "DELEGATE" + ], + "enum_launch_stages": { + "DELEGATE": "PUBLIC_PREVIEW", + "ON": "PUBLIC_PREVIEW" + } + }, + "settingsv2.PreviewPhase": { + "description": "Preview phase for settings that are feature previews.\nFor settings that are not feature previews, the preview_phase field is left unset.\nMirrors only the customer-facing phases surfaced in the UI; internal-only phases\n(DISABLED, DEV, UNDER_MIGRATION, LAUNCHED, etc.) are not exposed here.", + "enum": [ + "PRIVATE_PREVIEW", + "PUBLIC_PREVIEW", + "BETA", + "GA_SOON", + "GA" + ], + "enum_launch_stages": { + "BETA": "PUBLIC_BETA", + "GA": "PUBLIC_BETA", + "GA_SOON": "PUBLIC_BETA", + "PRIVATE_PREVIEW": "PUBLIC_BETA", + "PUBLIC_PREVIEW": "PUBLIC_BETA" + } + }, + "settingsv2.RestrictWorkspaceAdminsMessage": { + "fields": { + "disable_gov_tag_creation": { + "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "status": { + "ref": "settingsv2.RestrictWorkspaceAdminsMessageStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.RestrictWorkspaceAdminsMessageStatus": { + "enum": [ + "ALLOW_ALL", + "RESTRICT_TOKENS_AND_JOB_RUN_AS" + ], + "enum_launch_stages": { + "ALLOW_ALL": "PUBLIC_PREVIEW", + "RESTRICT_TOKENS_AND_JOB_RUN_AS": "PUBLIC_PREVIEW" + } + }, + "settingsv2.Setting": { + "fields": { + "aibi_dashboard_embedding_access_policy": { + "description": "Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.", + "ref": "settingsv2.AibiDashboardEmbeddingAccessPolicy", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "aibi_dashboard_embedding_approved_domains": { + "description": "Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.", + "ref": "settingsv2.AibiDashboardEmbeddingApprovedDomains", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "allowed_apps_user_api_scopes": { + "description": "Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.", + "ref": "settingsv2.AllowedAppsUserApiScopesMessage", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "automatic_cluster_update_workspace": { + "description": "Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.", + "ref": "settingsv2.ClusterAutoRestartMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "boolean_val": { + "description": "Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.", + "ref": "settingsv2.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "collaboration_platform_connectivity": { + "description": "Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.", + "ref": "settingsv2.CollaborationPlatformConnectivityMessage", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_aibi_dashboard_embedding_access_policy": { + "description": "Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.", + "ref": "settingsv2.AibiDashboardEmbeddingAccessPolicy", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_aibi_dashboard_embedding_approved_domains": { + "description": "Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.", + "ref": "settingsv2.AibiDashboardEmbeddingApprovedDomains", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_allowed_apps_user_api_scopes": { + "description": "Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.", + "ref": "settingsv2.AllowedAppsUserApiScopesMessage", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_automatic_cluster_update_workspace": { + "description": "Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.", + "ref": "settingsv2.ClusterAutoRestartMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_boolean_val": { + "description": "Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.", + "ref": "settingsv2.BooleanMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_collaboration_platform_connectivity": { + "description": "Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.", + "ref": "settingsv2.CollaborationPlatformConnectivityMessage", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_integer_val": { + "description": "Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.", + "ref": "settingsv2.IntegerMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_operational_email_custom_recipient": { + "description": "Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.", + "ref": "settingsv2.OperationalEmailCustomRecipientMessage", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_personal_compute": { + "description": "Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.", + "ref": "settingsv2.PersonalComputeMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_restrict_workspace_admins": { + "description": "Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.", + "ref": "settingsv2.RestrictWorkspaceAdminsMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_string_val": { + "description": "Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.", + "ref": "settingsv2.StringMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "integer_val": { + "description": "Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.", + "ref": "settingsv2.IntegerMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Name of the setting.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "operational_email_custom_recipient": { + "description": "Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.", + "ref": "settingsv2.OperationalEmailCustomRecipientMessage", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "personal_compute": { + "description": "Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.", + "ref": "settingsv2.PersonalComputeMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "restrict_workspace_admins": { + "description": "Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.", + "ref": "settingsv2.RestrictWorkspaceAdminsMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "string_val": { + "description": "Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.", + "ref": "settingsv2.StringMessage", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.SettingsMetadata": { + "fields": { + "description": { + "description": "Setting description for what this setting controls", + "launch_stage": "PUBLIC_PREVIEW" + }, + "display_name": { + "description": "Human-readable display name for the setting or feature preview.\nThis field may be unset if no display name is available.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "docs_link": { + "description": "Link to databricks documentation for the setting", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the setting.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "preview_phase": { + "description": "Preview phase for feature preview settings. This field is not set for non-preview settings.", + "ref": "settingsv2.PreviewPhase", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "type": { + "description": "Sample message depicting the type of the setting. To set this setting, the value sent must match this type.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settingsv2.StringMessage": { + "fields": { + "value": { + "description": "Represents a generic string value.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.UserPreference": { + "description": "User Preference represents a user-specific setting scoped to an individual user within an account.\nUnlike workspace or account settings that apply to all users, user preferences allow personal\ncustomization (e.g., UI theme, editor preferences) without affecting other users.", + "fields": { + "boolean_val": { + "ref": "settingsv2.BooleanMessage", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "effective_boolean_val": { + "ref": "settingsv2.BooleanMessage", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_string_val": { + "ref": "settingsv2.StringMessage", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Name of the setting.", + "launch_stage": "PUBLIC_BETA" + }, + "string_val": { + "ref": "settingsv2.StringMessage", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "user_id": { + "description": "User ID of the user.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "sharing.AuthenticationType": { + "description": "The delta sharing authentication type.", + "enum": [ + "TOKEN", + "DATABRICKS", + "OIDC_FEDERATION", + "OAUTH_CLIENT_CREDENTIALS" + ], + "enum_launch_stages": { + "DATABRICKS": "GA", + "OAUTH_CLIENT_CREDENTIALS": "GA", + "OIDC_FEDERATION": "GA", + "TOKEN": "GA" + } + }, + "sharing.ColumnTypeName": { + "description": "UC supported column types\nCopied from https://src.dev.databricks.com/databricks/universe@23a85902bb58695ab9293adc9f327b0714b55e72/-/blob/managed-catalog/api/messages/table.proto?L68", + "enum": [ + "BOOLEAN", + "BYTE", + "SHORT", + "INT", + "LONG", + "FLOAT", + "DOUBLE", + "DATE", + "TIMESTAMP", + "STRING", + "BINARY", + "DECIMAL", + "INTERVAL", + "ARRAY", + "STRUCT", + "MAP", + "CHAR", + "NULL", + "USER_DEFINED_TYPE", + "TIMESTAMP_NTZ", + "VARIANT", + "TABLE_TYPE" + ], + "enum_launch_stages": { + "ARRAY": "GA", + "BINARY": "GA", + "BOOLEAN": "GA", + "BYTE": "GA", + "CHAR": "GA", + "DATE": "GA", + "DECIMAL": "GA", + "DOUBLE": "GA", + "FLOAT": "GA", + "INT": "GA", + "INTERVAL": "GA", + "LONG": "GA", + "MAP": "GA", + "NULL": "GA", + "SHORT": "GA", + "STRING": "GA", + "STRUCT": "GA", + "TABLE_TYPE": "GA", + "TIMESTAMP": "GA", + "TIMESTAMP_NTZ": "GA", + "USER_DEFINED_TYPE": "GA", + "VARIANT": "GA" + } + }, + "sharing.CreateProvider": { + "fields": { + "authentication_type": { + "ref": "sharing.AuthenticationType", + "launch_stage": "GA" + }, + "comment": { + "description": "Description about the provider.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the Provider.", + "launch_stage": "GA" + }, + "recipient_profile_str": { + "description": "This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.", + "launch_stage": "GA" + } + } + }, + "sharing.CreateRecipient": { + "fields": { + "authentication_type": { + "ref": "sharing.AuthenticationType", + "launch_stage": "GA" + }, + "comment": { + "description": "Description about the recipient.", + "launch_stage": "GA" + }, + "data_recipient_global_metastore_id": { + "description": "The global Unity Catalog metastore id provided by the data recipient.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.\nThe identifier is of format __cloud__:__region__:__metastore-uuid__.", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Expiration timestamp of the token, in epoch milliseconds.", + "launch_stage": "GA" + }, + "id": { + "description": "[Create,Update:IGN] common - id of the recipient", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "ip_access_list": { + "description": "IP Access List", + "ref": "sharing.IpAccessList", + "launch_stage": "GA" + }, + "name": { + "description": "Name of Recipient.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of the recipient owner.", + "launch_stage": "GA" + }, + "properties_kvpairs": { + "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", + "ref": "sharing.SecurablePropertiesKVPairs", + "launch_stage": "GA" + }, + "sharing_code": { + "description": "The one-time sharing code provided by the data recipient. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA" + } + } + }, + "sharing.CreateShare": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the share.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for the share.", + "launch_stage": "GA" + } + } + }, + "sharing.DeltaSharingFunction": { + "fields": { + "aliases": { + "description": "The aliass of registered model.", + "launch_stage": "GA" + }, + "comment": { + "description": "The comment of the function.", + "launch_stage": "GA" + }, + "data_type": { + "description": "The data type of the function.", + "ref": "sharing.ColumnTypeName", + "launch_stage": "GA" + }, + "dependency_list": { + "description": "The dependency list of the function.", + "ref": "sharing.delta-sharing DependencyList", + "launch_stage": "GA" + }, + "full_data_type": { + "description": "The full data type of the function.", + "launch_stage": "GA" + }, + "id": { + "description": "The id of the function.", + "launch_stage": "GA" + }, + "input_params": { + "description": "The function parameter information.", + "ref": "sharing.FunctionParameterInfos", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the function.", + "launch_stage": "GA" + }, + "properties": { + "description": "The properties of the function.", + "launch_stage": "GA" + }, + "routine_definition": { + "description": "The routine definition of the function.", + "launch_stage": "GA" + }, + "schema": { + "description": "The name of the schema that the function belongs to.", + "launch_stage": "GA" + }, + "securable_kind": { + "description": "The securable kind of the function.", + "ref": "sharing.SharedSecurableKind", + "launch_stage": "GA" + }, + "share": { + "description": "The name of the share that the function belongs to.", + "launch_stage": "GA" + }, + "share_id": { + "description": "The id of the share that the function belongs to.", + "launch_stage": "GA" + }, + "storage_location": { + "description": "The storage location of the function.", + "launch_stage": "GA" + }, + "tags": { + "description": "The tags of the function.", + "launch_stage": "GA" + } + } + }, + "sharing.FederationPolicy": { + "fields": { + "comment": { + "description": "Description of the policy. This is a user-provided description.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "create_time": { + "description": "System-generated timestamp indicating when the policy was created.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "id": { + "description": "Unique, immutable system-generated identifier for the federation policy.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY", + "IMMUTABLE" + ] + }, + "name": { + "description": "Name of the federation policy. A recipient can have multiple policies with different names.\nThe name must contain only lowercase alphanumeric characters, numbers, and hyphens.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "oidc_policy": { + "description": "Specifies the policy to use for validating OIDC claims in the federated tokens.", + "ref": "sharing.OidcFederationPolicy", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "System-generated timestamp indicating when the policy was last updated.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.FunctionParameterInfo": { + "description": "Represents a parameter of a function. The same message is used for both input and output columns.", + "fields": { + "comment": { + "description": "The comment of the parameter.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the parameter.", + "launch_stage": "GA" + }, + "parameter_default": { + "description": "The default value of the parameter.", + "launch_stage": "GA" + }, + "parameter_mode": { + "description": "The mode of the function parameter.", + "ref": "sharing.FunctionParameterMode", + "launch_stage": "GA" + }, + "parameter_type": { + "description": "The type of the function parameter.", + "ref": "sharing.FunctionParameterType", + "launch_stage": "GA" + }, + "position": { + "description": "The position of the parameter.", + "launch_stage": "GA" + }, + "type_interval_type": { + "description": "The interval type of the parameter type.", + "launch_stage": "GA" + }, + "type_json": { + "description": "The type of the parameter in JSON format.", + "launch_stage": "GA" + }, + "type_name": { + "description": "The type of the parameter in Enum format.", + "ref": "sharing.ColumnTypeName", + "launch_stage": "GA" + }, + "type_precision": { + "description": "The precision of the parameter type.", + "launch_stage": "GA" + }, + "type_scale": { + "description": "The scale of the parameter type.", + "launch_stage": "GA" + }, + "type_text": { + "description": "The type of the parameter in text format.", + "launch_stage": "GA" + } + } + }, + "sharing.FunctionParameterInfos": { + "fields": { + "parameters": { + "description": "The list of parameters of the function.", + "launch_stage": "GA" + } + } + }, + "sharing.FunctionParameterMode": { + "enum": [ + "IN", + "OUT", + "INOUT" + ], + "enum_launch_stages": { + "IN": "GA", + "INOUT": "GA", + "OUT": "GA" + } + }, + "sharing.FunctionParameterType": { + "enum": [ + "PARAM", + "COLUMN" + ], + "enum_launch_stages": { + "COLUMN": "GA", + "PARAM": "GA" + } + }, + "sharing.GetActivationUrlInfoResponse": {}, + "sharing.GetRecipientSharePermissionsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "permissions_out": { + "description": "An array of data share permissions for a recipient.", + "launch_stage": "GA" + } + } + }, + "sharing.GetSharePermissionsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "privilege_assignments": { + "description": "The privileges assigned to each principal", + "launch_stage": "GA" + } + } + }, + "sharing.IpAccessList": { + "fields": { + "allowed_ip_addresses": { + "description": "Allowed IP Addresses in CIDR notation. Limit of 100.", + "launch_stage": "GA" + } + } + }, + "sharing.ListFederationPoliciesResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "policies": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sharing.ListProviderShareAssetsResponse": { + "description": "Response to ListProviderShareAssets, which contains the list of assets of a share.", + "fields": { + "functions": { + "description": "The list of functions in the share.", + "launch_stage": "GA" + }, + "notebooks": { + "description": "The list of notebooks in the share.", + "launch_stage": "GA" + }, + "share": { + "description": "The metadata of the share.", + "ref": "sharing.Share", + "launch_stage": "GA" + }, + "tables": { + "description": "The list of tables in the share.", + "launch_stage": "GA" + }, + "volumes": { + "description": "The list of volumes in the share.", + "launch_stage": "GA" + } + } + }, + "sharing.ListProviderSharesResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "shares": { + "description": "An array of provider shares.", + "launch_stage": "GA" + } + } + }, + "sharing.ListProvidersResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "providers": { + "description": "An array of provider information objects.", + "launch_stage": "GA" + } + } + }, + "sharing.ListRecipientsResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "recipients": { + "description": "An array of recipient information objects.", + "launch_stage": "GA" + } + } + }, + "sharing.ListSharesResponse": { + "fields": { + "next_page_token": { + "description": "Opaque token to retrieve the next page of results. Absent if there are no more pages.\n__page_token__ should be set to this value for the next request (for the next page of results).", + "launch_stage": "GA" + }, + "shares": { + "description": "An array of data share information objects.", + "launch_stage": "GA" + } + } + }, + "sharing.NotebookFile": { + "fields": { + "comment": { + "description": "The comment of the notebook file.", + "launch_stage": "GA" + }, + "id": { + "description": "The id of the notebook file.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the notebook file.", + "launch_stage": "GA" + }, + "share": { + "description": "The name of the share that the notebook file belongs to.", + "launch_stage": "GA" + }, + "share_id": { + "description": "The id of the share that the notebook file belongs to.", + "launch_stage": "GA" + }, + "tags": { + "description": "The tags of the notebook file.", + "launch_stage": "GA" + } + } + }, + "sharing.OidcFederationPolicy": { + "description": "Specifies the policy to use for validating OIDC claims in your federated tokens from Delta Sharing Clients.\nRefer to https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed for more details.", + "fields": { + "audiences": { + "description": "The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches at least one audience in the policy,", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "issuer": { + "description": "The required token issuer, as specified in the 'iss' claim of federated tokens.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "subject": { + "description": "The required token subject, as specified in the subject claim of federated tokens.\nThe subject claim identifies the identity of the user or machine accessing the resource.\nExamples for Entra ID (AAD):\n- U2M flow (group access): If the subject claim is `groups`, this must be the Object ID of the group in Entra ID.\n- U2M flow (user access): If the subject claim is `oid`, this must be the Object ID of the user in Entra ID.\n- M2M flow (OAuth App access): If the subject claim is `azp`, this must be the client ID of the OAuth app registered in Entra ID.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "subject_claim": { + "description": "The claim that contains the subject of the token.\nDepending on the identity provider and the use case (U2M or M2M), this can vary:\n- For Entra ID (AAD):\n* U2M flow (group access): Use `groups`.\n* U2M flow (user access): Use `oid`.\n* M2M flow (OAuth App access): Use `azp`.\n- For other IdPs, refer to the specific IdP documentation.\n\nSupported `subject_claim` values are:\n- `oid`: Object ID of the user.\n- `azp`: Client ID of the OAuth app.\n- `groups`: Object ID of the group.\n- `sub`: Subject identifier for other use cases.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "sharing.Partition": { + "fields": { + "values": { + "description": "An array of partition values.", + "launch_stage": "GA" + } + } + }, + "sharing.PartitionValue": { + "fields": { + "name": { + "description": "The name of the partition column.", + "launch_stage": "GA" + }, + "op": { + "description": "The operator to apply for the value.", + "ref": "sharing.PartitionValueOp", + "launch_stage": "GA" + }, + "recipient_property_key": { + "description": "The key of a Delta Sharing recipient's property. For example \"databricks-account-id\".\nWhen this field is set, field `value` can not be set.", + "launch_stage": "GA" + }, + "value": { + "description": "The value of the partition column. When this value is not set, it means `null` value.\nWhen this field is set, field `recipient_property_key` can not be set.", + "launch_stage": "GA" + } + } + }, + "sharing.PartitionValueOp": { + "enum": [ + "EQUAL", + "LIKE" + ], + "enum_launch_stages": { + "EQUAL": "GA", + "LIKE": "GA" + } + }, + "sharing.PermissionsChange": { + "fields": { + "add": { + "description": "The set of privileges to add.", + "launch_stage": "GA" + }, + "principal": { + "description": "The principal whose privileges we are changing.\nOnly one of principal or principal_id should be specified, never both at the same time.", + "launch_stage": "GA" + }, + "remove": { + "description": "The set of privileges to remove.", + "launch_stage": "GA" + } + } + }, + "sharing.Privilege": { + "enum": [ + "SELECT", + "READ_PRIVATE_FILES", + "WRITE_PRIVATE_FILES", + "CREATE", + "USAGE", + "USE_CATALOG", + "USE_SCHEMA", + "CREATE_SCHEMA", + "CREATE_VIEW", + "CREATE_EXTERNAL_TABLE", + "CREATE_MATERIALIZED_VIEW", + "CREATE_FUNCTION", + "CREATE_MODEL", + "CREATE_CATALOG", + "CREATE_MANAGED_STORAGE", + "CREATE_EXTERNAL_LOCATION", + "CREATE_STORAGE_CREDENTIAL", + "CREATE_SERVICE_CREDENTIAL", + "ACCESS", + "CREATE_SHARE", + "CREATE_RECIPIENT", + "CREATE_PROVIDER", + "USE_SHARE", + "USE_RECIPIENT", + "USE_PROVIDER", + "USE_MARKETPLACE_ASSETS", + "SET_SHARE_PERMISSION", + "MODIFY", + "REFRESH", + "EXECUTE", + "READ_FILES", + "WRITE_FILES", + "CREATE_TABLE", + "ALL_PRIVILEGES", + "CREATE_CONNECTION", + "USE_CONNECTION", + "APPLY_TAG", + "CREATE_FOREIGN_CATALOG", + "CREATE_FOREIGN_SECURABLE", + "MANAGE_ALLOWLIST", + "CREATE_VOLUME", + "CREATE_EXTERNAL_VOLUME", + "READ_VOLUME", + "WRITE_VOLUME", + "MANAGE" + ], + "enum_launch_stages": { + "ACCESS": "GA", + "ALL_PRIVILEGES": "GA", + "APPLY_TAG": "GA", + "CREATE": "GA", + "CREATE_CATALOG": "GA", + "CREATE_CONNECTION": "GA", + "CREATE_EXTERNAL_LOCATION": "GA", + "CREATE_EXTERNAL_TABLE": "GA", + "CREATE_EXTERNAL_VOLUME": "GA", + "CREATE_FOREIGN_CATALOG": "GA", + "CREATE_FOREIGN_SECURABLE": "GA", + "CREATE_FUNCTION": "GA", + "CREATE_MANAGED_STORAGE": "GA", + "CREATE_MATERIALIZED_VIEW": "GA", + "CREATE_MODEL": "GA", + "CREATE_PROVIDER": "GA", + "CREATE_RECIPIENT": "GA", + "CREATE_SCHEMA": "GA", + "CREATE_SERVICE_CREDENTIAL": "GA", + "CREATE_SHARE": "GA", + "CREATE_STORAGE_CREDENTIAL": "GA", + "CREATE_TABLE": "GA", + "CREATE_VIEW": "GA", + "CREATE_VOLUME": "GA", + "EXECUTE": "GA", + "MANAGE": "GA", + "MANAGE_ALLOWLIST": "GA", + "MODIFY": "GA", + "READ_FILES": "GA", + "READ_PRIVATE_FILES": "GA", + "READ_VOLUME": "GA", + "REFRESH": "GA", + "SELECT": "GA", + "SET_SHARE_PERMISSION": "GA", + "USAGE": "GA", + "USE_CATALOG": "GA", + "USE_CONNECTION": "GA", + "USE_MARKETPLACE_ASSETS": "GA", + "USE_PROVIDER": "GA", + "USE_RECIPIENT": "GA", + "USE_SCHEMA": "GA", + "USE_SHARE": "GA", + "WRITE_FILES": "GA", + "WRITE_PRIVATE_FILES": "GA", + "WRITE_VOLUME": "GA" + } + }, + "sharing.PrivilegeAssignment": { + "fields": { + "principal": { + "description": "The principal (user email address or group name).\nFor deleted principals, `principal` is empty while `principal_id` is populated.", + "launch_stage": "GA" + }, + "privileges": { + "description": "The privileges assigned to the principal.", + "launch_stage": "GA" + } + } + }, + "sharing.ProviderInfo": { + "fields": { + "authentication_type": { + "ref": "sharing.AuthenticationType", + "launch_stage": "GA" + }, + "cloud": { + "description": "Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "comment": { + "description": "Description about the provider.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this Provider was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of Provider creator.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "data_provider_global_metastore_id": { + "description": "The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__.", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The name of the Provider.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of Provider owner.", + "launch_stage": "GA" + }, + "recipient_profile": { + "description": "The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`.", + "ref": "sharing.RecipientProfile", + "launch_stage": "GA" + }, + "recipient_profile_str": { + "description": "This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_at": { + "description": "Time at which this Provider was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of user who last modified Provider.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.ProviderShare": { + "fields": { + "name": { + "description": "The name of the Provider Share.", + "launch_stage": "GA" + } + } + }, + "sharing.RecipientInfo": { + "fields": { + "activated": { + "description": "A boolean status field showing whether the Recipient's activation URL has been exercised or not.", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "activation_url": { + "description": "Full activation url to retrieve the access token.\nIt will be empty if the token is already retrieved.", + "deprecated": true, + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "authentication_type": { + "ref": "sharing.AuthenticationType", + "launch_stage": "GA" + }, + "cloud": { + "description": "Cloud vendor of the recipient's Unity Catalog Metastore.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "comment": { + "description": "Description about the recipient.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this recipient was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of recipient creator.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "data_recipient_global_metastore_id": { + "description": "The global Unity Catalog metastore id provided by the data recipient.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.\nThe identifier is of format __cloud__:__region__:__metastore-uuid__.", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Expiration timestamp of the token, in epoch milliseconds.", + "launch_stage": "GA" + }, + "id": { + "description": "[Create,Update:IGN] common - id of the recipient", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "ip_access_list": { + "description": "IP Access List", + "ref": "sharing.IpAccessList", + "launch_stage": "GA" + }, + "metastore_id": { + "description": "Unique identifier of recipient's Unity Catalog Metastore.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Name of Recipient.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of the recipient owner.", + "launch_stage": "GA" + }, + "properties_kvpairs": { + "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", + "ref": "sharing.SecurablePropertiesKVPairs", + "launch_stage": "GA" + }, + "region": { + "description": "Cloud region of the recipient's Unity Catalog Metastore.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "sharing_code": { + "description": "The one-time sharing code provided by the data recipient. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "launch_stage": "GA" + }, + "tokens": { + "description": "This field is only present when the __authentication_type__ is **TOKEN**.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_at": { + "description": "Time at which the recipient was updated, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of recipient updater.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.RecipientProfile": { + "fields": { + "bearer_token": { + "description": "The token used to authorize the recipient.", + "launch_stage": "GA" + }, + "endpoint": { + "description": "The endpoint for the share to be used by the recipient.", + "launch_stage": "GA" + }, + "share_credentials_version": { + "description": "The version number of the recipient's credentials on a share.", + "launch_stage": "GA" + } + } + }, + "sharing.RecipientTokenInfo": { + "fields": { + "activation_url": { + "description": "Full activation URL to retrieve the access token. It will be empty if the token is already retrieved.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_at": { + "description": "Time at which this recipient token was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of recipient token creator.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expiration_time": { + "description": "Expiration timestamp of the token in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "Unique ID of the recipient token.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_at": { + "description": "Time at which this recipient token was updated, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of recipient token updater.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.RegisteredModelAlias": { + "fields": { + "alias_name": { + "description": "Name of the alias.", + "launch_stage": "GA" + }, + "version_num": { + "description": "Numeric model version that alias will reference.", + "launch_stage": "GA" + } + } + }, + "sharing.RetrieveTokenResponse": { + "fields": { + "bearerToken": { + "description": "The token used to authorize the recipient.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "endpoint": { + "description": "The endpoint for the share to be used by the recipient.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expirationTime": { + "description": "Expiration timestamp of the token in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "shareCredentialsVersion": { + "description": "These field names must follow the delta sharing protocol.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.RotateRecipientToken": { + "fields": { + "existing_token_expire_in_seconds": { + "description": "The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time\nof existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to\nexpire the existing token immediately, negative number will return an error.", + "launch_stage": "GA" + } + } + }, + "sharing.SecurablePropertiesKVPairs": { + "description": "An object with __properties__ containing map of key-value properties attached to the securable.", + "fields": { + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "GA" + } + } + }, + "sharing.Share": { + "fields": { + "id": { + "launch_stage": "GA" + }, + "name": { + "launch_stage": "GA" + } + } + }, + "sharing.ShareInfo": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Time at which this share was created, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Username of share creator.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Name of the share.", + "launch_stage": "GA" + }, + "objects": { + "description": "A list of shared data objects within the share.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of share.", + "launch_stage": "GA" + }, + "storage_location": { + "description": "Storage Location URL (full path) for the share.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "storage_root": { + "description": "Storage root URL for the share.", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Time at which this share was updated, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Username of share updater.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "sharing.ShareToPrivilegeAssignment": { + "fields": { + "privilege_assignments": { + "description": "The privileges assigned to the principal.", + "launch_stage": "GA" + }, + "share_name": { + "description": "The share name.", + "launch_stage": "GA" + } + } + }, + "sharing.SharedDataObject": { + "fields": { + "added_at": { + "description": "The time when this data object is added to the share, in epoch milliseconds.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "added_by": { + "description": "Username of the sharer.", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "cdf_enabled": { + "description": "Whether to enable cdf or indicate if cdf is enabled on the shared object.", + "launch_stage": "GA" + }, + "comment": { + "description": "A user-provided comment when adding the data object to the share.", + "launch_stage": "GA" + }, + "content": { + "description": "The content of the notebook file when the data object type is NOTEBOOK_FILE.\nThis should be base64 encoded.\nRequired for adding a NOTEBOOK_FILE, optional for updating, ignored for other types.", + "launch_stage": "GA" + }, + "data_object_type": { + "description": "The type of the data object.", + "ref": "sharing.SharedDataObjectDataObjectType", + "launch_stage": "GA" + }, + "history_data_sharing_status": { + "description": "Whether to enable or disable sharing of data history. If not specified, the default is **DISABLED**.", + "ref": "sharing.SharedDataObjectHistoryDataSharingStatus", + "launch_stage": "GA" + }, + "name": { + "description": "A fully qualified name that uniquely identifies a data object.\nFor example, a table's fully qualified name is in the format of `\u003ccatalog\u003e.\u003cschema\u003e.\u003ctable\u003e`,", + "launch_stage": "GA" + }, + "partitions": { + "description": "Array of partitions for the shared data.", + "launch_stage": "GA" + }, + "shared_as": { + "description": "A user-provided alias name for table-like data objects within the share.\n\nUse this field for table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE).\nFor non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION), use `string_shared_as` instead.\n\nImportant: For non-table objects, this field must be omitted entirely.\n\nFormat: Must be a 2-part name `\u003cschema_name\u003e.\u003ctable_name\u003e` (e.g., \"sales_schema.orders_table\")\n- Both schema and table names must contain only alphanumeric characters and underscores\n- No periods, spaces, forward slashes, or control characters are allowed within each part\n- Do not include the catalog name (use 2 parts, not 3)\n\nBehavior:\n- If not provided, the service automatically generates the alias as `\u003cschema\u003e.\u003ctable\u003e` from the object's original name\n- If you don't want to specify this field, omit it entirely from the request (do not pass an empty string)\n- The `shared_as` name must be unique within the share\n\nExamples:\n- Valid: \"analytics_schema.customer_view\"\n- Invalid: \"catalog.analytics_schema.customer_view\" (3 parts not allowed)\n- Invalid: \"analytics-schema.customer-view\" (hyphens not allowed)", + "launch_stage": "GA" + }, + "start_version": { + "description": "The start version associated with the object.\nThis allows data providers to control the lowest object version that is accessible by clients.\nIf specified, clients can query snapshots or changes for versions \u003e= start_version.\nIf not specified, clients can only query starting from the version of the object at the time\nit was added to the share.\n\nNOTE: The start_version should be \u003c= the `current` version of the object.", + "launch_stage": "GA" + }, + "status": { + "description": "One of: **ACTIVE**, **PERMISSION_DENIED**.", + "ref": "sharing.SharedDataObjectStatus", + "launch_stage": "GA" + }, + "string_shared_as": { + "description": "A user-provided alias name for non-table data objects within the share.\n\nUse this field for non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION).\nFor table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE), use `shared_as` instead.\n\nImportant: For table-like objects, this field must be omitted entirely.\n\nFormat:\n- For VOLUME: Must be a 2-part name `\u003cschema_name\u003e.\u003cvolume_name\u003e` (e.g., \"data_schema.ml_models\")\n- For FUNCTION: Must be a 2-part name `\u003cschema_name\u003e.\u003cfunction_name\u003e` (e.g., \"udf_schema.calculate_tax\")\n- For MODEL: Must be a 2-part name `\u003cschema_name\u003e.\u003cmodel_name\u003e` (e.g., \"models.prediction_model\")\n- For NOTEBOOK_FILE: Should be the notebook file name (e.g., \"analysis_notebook.py\")\n- All names must contain only alphanumeric characters and underscores\n- No periods, spaces, forward slashes, or control characters are allowed within each part\n\nBehavior:\n- If not provided, the service automatically generates the alias from the object's original name\n- If you don't want to specify this field, omit it entirely from the request (do not pass an empty string)\n- The `string_shared_as` name must be unique for objects of the same type within the share\n\nExamples:\n- Valid for VOLUME: \"data_schema.training_data\"\n- Valid for FUNCTION: \"analytics.calculate_revenue\"\n- Invalid: \"catalog.data_schema.training_data\" (3 parts not allowed for volumes)\n- Invalid: \"data-schema.training-data\" (hyphens not allowed)", + "launch_stage": "GA" + } + } + }, + "sharing.SharedDataObjectDataObjectType": { + "enum": [ + "TABLE", + "FOREIGN_TABLE", + "SCHEMA", + "VIEW", + "MATERIALIZED_VIEW", + "STREAMING_TABLE", + "MODEL", + "NOTEBOOK_FILE", + "FUNCTION", + "FEATURE_SPEC", + "VOLUME" + ], + "enum_launch_stages": { + "FEATURE_SPEC": "GA", + "FOREIGN_TABLE": "GA", + "FUNCTION": "GA", + "MATERIALIZED_VIEW": "GA", + "MODEL": "GA", + "NOTEBOOK_FILE": "GA", + "SCHEMA": "GA", + "STREAMING_TABLE": "GA", + "TABLE": "GA", + "VIEW": "GA", + "VOLUME": "GA" + } + }, + "sharing.SharedDataObjectHistoryDataSharingStatus": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "enum_launch_stages": { + "DISABLED": "GA", + "ENABLED": "GA" + } + }, + "sharing.SharedDataObjectStatus": { + "enum": [ + "ACTIVE", + "PERMISSION_DENIED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "PERMISSION_DENIED": "GA" + } + }, + "sharing.SharedDataObjectUpdate": { + "fields": { + "action": { + "description": "One of: **ADD**, **REMOVE**, **UPDATE**.", + "ref": "sharing.SharedDataObjectUpdateAction", + "launch_stage": "GA" + }, + "data_object": { + "description": "The data object that is being added, removed, or updated. The maximum number update data objects allowed is a 100.", + "ref": "sharing.SharedDataObject", + "launch_stage": "GA" + } + } + }, + "sharing.SharedDataObjectUpdateAction": { + "enum": [ + "ADD", + "REMOVE", + "UPDATE" + ], + "enum_launch_stages": { + "ADD": "GA", + "REMOVE": "GA", + "UPDATE": "GA" + } + }, + "sharing.SharedSecurableKind": { + "description": "The SecurableKind of a delta-shared object.", + "enum": [ + "FUNCTION_STANDARD", + "FUNCTION_REGISTERED_MODEL", + "FUNCTION_FEATURE_SPEC" + ], + "enum_launch_stages": { + "FUNCTION_FEATURE_SPEC": "GA", + "FUNCTION_REGISTERED_MODEL": "GA", + "FUNCTION_STANDARD": "GA" + } + }, + "sharing.Table": { + "fields": { + "comment": { + "description": "The comment of the table.", + "launch_stage": "GA" + }, + "id": { + "description": "The id of the table.", + "launch_stage": "GA" + }, + "materialization_namespace": { + "description": "The catalog and schema of the materialized table", + "launch_stage": "GA" + }, + "materialized_table_name": { + "description": "The name of a materialized table.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the table.", + "launch_stage": "GA" + }, + "schema": { + "description": "The name of the schema that the table belongs to.", + "launch_stage": "GA" + }, + "share": { + "description": "The name of the share that the table belongs to.", + "launch_stage": "GA" + }, + "share_id": { + "description": "The id of the share that the table belongs to.", + "launch_stage": "GA" + }, + "tags": { + "description": "The Tags of the table.", + "launch_stage": "GA" + } + } + }, + "sharing.UpdateProvider": { + "fields": { + "comment": { + "description": "Description about the provider.", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the provider.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of Provider owner.", + "launch_stage": "GA" + }, + "recipient_profile_str": { + "description": "This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.", + "launch_stage": "GA" + } + } + }, + "sharing.UpdateRecipient": { + "fields": { + "comment": { + "description": "Description about the recipient.", + "launch_stage": "GA" + }, + "expiration_time": { + "description": "Expiration timestamp of the token, in epoch milliseconds.", + "launch_stage": "GA" + }, + "id": { + "description": "[Create,Update:IGN] common - id of the recipient", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "ip_access_list": { + "description": "IP Access List", + "ref": "sharing.IpAccessList", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the recipient.\n.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of the recipient owner.", + "launch_stage": "GA" + }, + "properties_kvpairs": { + "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", + "ref": "sharing.SecurablePropertiesKVPairs", + "launch_stage": "GA" + } + } + }, + "sharing.UpdateShare": { + "fields": { + "comment": { + "description": "User-provided free-form text description.", + "launch_stage": "GA" + }, + "new_name": { + "description": "New name for the share.", + "launch_stage": "GA" + }, + "owner": { + "description": "Username of current owner of share.", + "launch_stage": "GA" + }, + "storage_root": { + "description": "Storage root URL for the share.", + "launch_stage": "GA" + }, + "updates": { + "description": "Array of shared data object updates.", + "launch_stage": "GA" + } + } + }, + "sharing.UpdateSharePermissions": { + "fields": { + "changes": { + "description": "Array of permissions change objects.", + "launch_stage": "GA" + }, + "omit_permissions_list": { + "description": "Optional. Whether to return the latest permissions list of the share in the response.", + "launch_stage": "GA" + } + } + }, + "sharing.UpdateSharePermissionsResponse": { + "fields": { + "privilege_assignments": { + "description": "The privileges assigned to each principal", + "launch_stage": "GA" + } + } + }, + "sharing.Volume": { + "fields": { + "comment": { + "description": "The comment of the volume.", + "launch_stage": "GA" + }, + "id": { + "description": "This id maps to the shared_volume_id in database\nRecipient needs shared_volume_id for recon\nto check if this volume is already in recipient's DB or not.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the volume.", + "launch_stage": "GA" + }, + "schema": { + "description": "The name of the schema that the volume belongs to.", + "launch_stage": "GA" + }, + "share": { + "description": "The name of the share that the volume belongs to.", + "launch_stage": "GA" + }, + "share_id": { + "description": "/ The id of the share that the volume belongs to.", + "launch_stage": "GA" + }, + "tags": { + "description": "The tags of the volume.", + "launch_stage": "GA" + } + } + }, + "sharing.delta-sharing Dependency": { + "description": "Represents a UC dependency.", + "fields": { + "function": { + "ref": "sharing.delta-sharing FunctionDependency", + "launch_stage": "GA" + }, + "table": { + "ref": "sharing.delta-sharing TableDependency", + "launch_stage": "GA" + } + } + }, + "sharing.delta-sharing DependencyList": { + "description": "Represents a list of dependencies.", + "fields": { + "dependencies": { + "description": "An array of Dependency.", + "launch_stage": "GA" + } + } + }, + "sharing.delta-sharing FunctionDependency": { + "description": "A Function in UC as a dependency.", + "fields": { + "function_name": { + "launch_stage": "GA" + }, + "schema_name": { + "launch_stage": "GA" + } + } + }, + "sharing.delta-sharing TableDependency": { + "description": "A Table in UC as a dependency.", + "fields": { + "schema_name": { + "launch_stage": "GA" + }, + "table_name": { + "launch_stage": "GA" + } + } + }, + "sql.AccessControl": { + "fields": { + "group_name": { + "launch_stage": "GA" + }, + "permission_level": { + "description": "* `CAN_VIEW`: Can view the query\n* `CAN_RUN`: Can run the query\n* `CAN_EDIT`: Can edit the query\n* `CAN_MANAGE`: Can manage the query", + "ref": "sql.PermissionLevel", + "launch_stage": "GA" + }, + "user_name": { + "launch_stage": "GA" + } + } + }, + "sql.Aggregation": { + "enum": [ + "SUM", + "COUNT", + "COUNT_DISTINCT", + "AVG", + "MEDIAN", + "MIN", + "MAX", + "STDDEV" + ], + "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" + } + }, + "sql.Alert": { + "fields": { + "condition": { + "description": "Trigger conditions of the alert.", + "ref": "sql.AlertCondition", + "launch_stage": "GA" + }, + "create_time": { + "description": "The timestamp indicating when the alert was created.", + "launch_stage": "GA" + }, + "custom_body": { + "description": "Custom body of alert notification, if it exists. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "custom_subject": { + "description": "Custom subject of alert notification, if it exists. This can include email subject entries and Slack notification headers, for example. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name of the alert.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying the alert.", + "launch_stage": "GA" + }, + "lifecycle_state": { + "description": "The workspace state of the alert. Used for tracking trashed status.", + "ref": "sql.LifecycleState", + "launch_stage": "GA" + }, + "notify_on_ok": { + "description": "Whether to notify alert subscribers when alert returns back to normal.", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "launch_stage": "GA" + }, + "parent_path": { + "description": "The workspace path of the folder containing the alert.", + "launch_stage": "GA" + }, + "query_id": { + "description": "UUID of the query attached to the alert.", + "launch_stage": "GA" + }, + "seconds_to_retrigger": { + "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the alert's trigger status. This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.", + "ref": "sql.AlertState", + "launch_stage": "GA" + }, + "trigger_time": { + "description": "Timestamp when the alert was last triggered, if the alert has been triggered before.", + "launch_stage": "GA" + }, + "update_time": { + "description": "The timestamp indicating when the alert was updated.", + "launch_stage": "GA" + } + } + }, + "sql.AlertCondition": { + "fields": { + "empty_result_state": { + "description": "Alert state if result is empty.", + "ref": "sql.AlertState", + "launch_stage": "GA" + }, + "op": { + "description": "Operator used for comparison in alert evaluation.", + "ref": "sql.AlertOperator", + "launch_stage": "GA" + }, + "operand": { + "description": "Name of the column from the query result to use for comparison in alert evaluation.", + "ref": "sql.AlertConditionOperand", + "launch_stage": "GA" + }, + "threshold": { + "description": "Threshold value used for comparison in alert evaluation.", + "ref": "sql.AlertConditionThreshold", + "launch_stage": "GA" + } + } + }, + "sql.AlertConditionOperand": { + "fields": { + "column": { + "ref": "sql.AlertOperandColumn", + "launch_stage": "GA" + } + } + }, + "sql.AlertConditionThreshold": { + "fields": { + "value": { + "ref": "sql.AlertOperandValue", + "launch_stage": "GA" + } + } + }, + "sql.AlertEvaluationState": { + "description": "UNSPECIFIED - default unspecify value for proto enum, do not use it in the code\nUNKNOWN - alert not yet evaluated\nTRIGGERED - alert is triggered\nOK - alert is not triggered\nERROR - alert evaluation failed", + "enum": [ + "UNKNOWN", + "TRIGGERED", + "OK", + "ERROR" + ], + "enum_launch_stages": { + "ERROR": "PUBLIC_PREVIEW", + "OK": "PUBLIC_PREVIEW", + "TRIGGERED": "PUBLIC_PREVIEW", + "UNKNOWN": "PUBLIC_PREVIEW" + } + }, + "sql.AlertLifecycleState": { + "enum": [ + "ACTIVE", + "DELETED" + ], + "enum_launch_stages": { + "ACTIVE": "PUBLIC_PREVIEW", + "DELETED": "PUBLIC_PREVIEW" + } + }, + "sql.AlertOperandColumn": { + "fields": { + "name": { + "launch_stage": "GA" + } + } + }, + "sql.AlertOperandValue": { + "fields": { + "bool_value": { + "launch_stage": "GA" + }, + "double_value": { + "launch_stage": "GA" + }, + "string_value": { + "launch_stage": "GA" + } + } + }, + "sql.AlertOperator": { + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "EQUAL", + "NOT_EQUAL", + "IS_NULL" + ], + "enum_launch_stages": { + "EQUAL": "GA", + "GREATER_THAN": "GA", + "GREATER_THAN_OR_EQUAL": "GA", + "IS_NULL": "GA", + "LESS_THAN": "GA", + "LESS_THAN_OR_EQUAL": "GA", + "NOT_EQUAL": "GA" + } + }, + "sql.AlertOptions": { + "description": "Alert configuration options.", + "fields": { + "column": { + "description": "Name of column in the query result to compare in alert evaluation.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "custom_body": { + "description": "Custom body of alert notification, if it exists. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "custom_subject": { + "description": "Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "empty_result_state": { + "description": "State that alert evaluates to when query result is empty.", + "ref": "sql.AlertOptionsEmptyResultState", + "launch_stage": "PUBLIC_PREVIEW" + }, + "muted": { + "description": "Whether or not the alert is muted. If an alert is muted, it will not notify users and notification destinations when triggered.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "op": { + "description": "Operator used to compare in alert evaluation: `\u003e`, `\u003e=`, `\u003c`, `\u003c=`, `==`, `!=`", + "launch_stage": "PUBLIC_PREVIEW" + }, + "value": { + "description": "Value used to compare in alert evaluation. Supported types include strings (eg. 'foobar'), floats (eg. 123.4), and booleans (true).", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.AlertOptionsEmptyResultState": { + "description": "State that alert evaluates to when query result is empty.", + "enum": [ + "ok", + "triggered", + "unknown" + ], + "enum_launch_stages": { + "ok": "PUBLIC_PREVIEW", + "triggered": "PUBLIC_PREVIEW", + "unknown": "PUBLIC_PREVIEW" + } + }, + "sql.AlertQuery": { + "fields": { + "created_at": { + "description": "The timestamp when this query was created.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "data_source_id": { + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "launch_stage": "PUBLIC_PREVIEW" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Query ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_archived": { + "description": "Indicates whether the query is trashed. Trashed queries can't be used in dashboards, or appear in search results. If this boolean is `true`, the `options` property for this query includes a `moved_to_trash_at` timestamp. Trashed queries are permanently deleted after 30 days.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_draft": { + "description": "Whether the query is a draft. Draft queries only appear in list views for their owners. Visualizations from draft queries cannot appear on dashboards.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_safe": { + "description": "Text parameter types are not safe from SQL injection for all types of data source. Set this Boolean parameter to `true` if a query either does not use any text type parameters or uses a data source type where text type parameters are handled safely.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "options": { + "ref": "sql.QueryOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query": { + "description": "The text of the query to be run.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tags": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "description": "The timestamp at which this query was last updated.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_id": { + "description": "The ID of the user who owns the query.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.AlertState": { + "enum": [ + "UNKNOWN", + "OK", + "TRIGGERED" + ], + "enum_launch_stages": { + "OK": "GA", + "TRIGGERED": "GA", + "UNKNOWN": "GA" + } + }, + "sql.AlertV2": { + "fields": { + "create_time": { + "description": "The timestamp indicating when the alert was created.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "custom_description": { + "description": "Custom description for the alert. support mustache template.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_summary": { + "description": "Custom summary for the alert. support mustache template.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "display_name": { + "description": "The display name of the alert.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "effective_run_as": { + "description": "The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.", + "ref": "sql.AlertV2RunAs", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "evaluation": { + "ref": "sql.AlertV2Evaluation", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "id": { + "description": "UUID identifying the alert.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "lifecycle_state": { + "description": "Indicates whether the query is trashed.", + "ref": "sql.AlertLifecycleState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "owner_user_name": { + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parent_path": { + "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "query_text": { + "description": "Text of the query to be run.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "run_as": { + "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", + "ref": "sql.AlertV2RunAs", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "run_as_user_name": { + "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "schedule": { + "ref": "sql.CronSchedule", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "update_time": { + "description": "The timestamp indicating when the alert was updated.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "warehouse_id": { + "description": "ID of the SQL warehouse attached to the alert.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "sql.AlertV2Evaluation": { + "fields": { + "comparison_operator": { + "description": "Operator used for comparison in alert evaluation.", + "ref": "sql.ComparisonOperator", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "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": "sql.AlertEvaluationState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "last_evaluated_at": { + "description": "Timestamp of the last evaluation.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "notification": { + "description": "User or Notification Destination to notify when alert is triggered.", + "ref": "sql.AlertV2Notification", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "source": { + "description": "Source column from result to use to evaluate alert", + "ref": "sql.AlertV2OperandColumn", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "state": { + "description": "Latest state of alert evaluation.", + "ref": "sql.AlertEvaluationState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "threshold": { + "description": "Threshold to user for alert evaluation, can be a column or a value.", + "ref": "sql.AlertV2Operand", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.AlertV2Notification": { + "fields": { + "notify_on_ok": { + "description": "Whether to notify alert subscribers when alert returns back to normal.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "subscriptions": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL", + "UNORDERED_LIST" + ] + } + } + }, + "sql.AlertV2Operand": { + "fields": { + "column": { + "ref": "sql.AlertV2OperandColumn", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "value": { + "ref": "sql.AlertV2OperandValue", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.AlertV2OperandColumn": { + "fields": { + "aggregation": { + "description": "If not set, the behavior is equivalent to using `First row` in the UI.", + "ref": "sql.Aggregation", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "display": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "sql.AlertV2OperandValue": { + "fields": { + "bool_value": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "double_value": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "string_value": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.AlertV2RunAs": { + "fields": { + "service_principal_name": { + "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "user_name": { + "description": "The email of an active workspace user. Can only set this field to their own email.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.AlertV2Subscription": { + "fields": { + "destination_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "user_email": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.BaseChunkInfo": { + "fields": { + "byte_count": { + "description": "The number of bytes in the result chunk. This field is not available when using `INLINE`\ndisposition.", + "launch_stage": "GA" + }, + "chunk_index": { + "description": "The position within the sequence of result set chunks.", + "launch_stage": "GA" + }, + "row_count": { + "description": "The number of rows within the result chunk.", + "launch_stage": "GA" + }, + "row_offset": { + "description": "The starting row offset within the result set.", + "launch_stage": "GA" + } + } + }, + "sql.Channel": { + "description": "Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.", + "fields": { + "dbsql_version": { + "launch_stage": "GA" + }, + "name": { + "ref": "sql.ChannelName", + "launch_stage": "GA" + } + } + }, + "sql.ChannelInfo": { + "description": "Details about a Channel.", + "fields": { + "dbsql_version": { + "description": "DB SQL Version the Channel is mapped to.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the channel", + "ref": "sql.ChannelName", + "launch_stage": "GA" + } + } + }, + "sql.ChannelName": { + "enum": [ + "CHANNEL_NAME_PREVIEW", + "CHANNEL_NAME_CURRENT", + "CHANNEL_NAME_PREVIOUS", + "CHANNEL_NAME_CUSTOM" + ], + "enum_launch_stages": { + "CHANNEL_NAME_CURRENT": "GA", + "CHANNEL_NAME_CUSTOM": "GA", + "CHANNEL_NAME_PREVIEW": "GA", + "CHANNEL_NAME_PREVIOUS": "GA" + } + }, + "sql.ClientConfig": { + "fields": { + "allow_custom_js_visualizations": { + "description": "allow_custom_js_visualizations is not supported/implemneted.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "allow_downloads": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "allow_external_shares": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "allow_subscriptions": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "date_format": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "date_time_format": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "disable_publish": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "enable_legacy_autodetect_types": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "feature_show_permissions_control": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "hide_plotly_mode_bar": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.ColumnInfo": { + "fields": { + "name": { + "description": "The name of the column.", + "launch_stage": "GA" + }, + "position": { + "description": "The ordinal position of the column (starting at position 0).", + "launch_stage": "GA" + }, + "type_interval_type": { + "description": "The format of the interval type.", + "launch_stage": "GA" + }, + "type_name": { + "description": "The name of the base data type. This doesn't include details for complex types such as STRUCT, MAP or ARRAY.", + "ref": "sql.ColumnInfoTypeName", + "launch_stage": "GA" + }, + "type_precision": { + "description": "Specifies the number of digits in a number. This applies to the DECIMAL type.", + "launch_stage": "GA" + }, + "type_scale": { + "description": "Specifies the number of digits to the right of the decimal point in a number. This applies to the DECIMAL type.", + "launch_stage": "GA" + }, + "type_text": { + "description": "The full SQL type specification.", + "launch_stage": "GA" + } + } + }, + "sql.ColumnInfoTypeName": { + "description": "The name of the base data type. This doesn't include details for complex types such as STRUCT, MAP or ARRAY.", + "enum": [ + "BOOLEAN", + "BYTE", + "SHORT", + "INT", + "LONG", + "FLOAT", + "DOUBLE", + "DATE", + "TIMESTAMP", + "STRING", + "BINARY", + "DECIMAL", + "INTERVAL", + "ARRAY", + "STRUCT", + "MAP", + "CHAR", + "NULL", + "USER_DEFINED_TYPE" + ], + "enum_launch_stages": { + "ARRAY": "GA", + "BINARY": "GA", + "BOOLEAN": "GA", + "BYTE": "GA", + "CHAR": "GA", + "DATE": "GA", + "DECIMAL": "GA", + "DOUBLE": "GA", + "FLOAT": "GA", + "INT": "GA", + "INTERVAL": "GA", + "LONG": "GA", + "MAP": "GA", + "NULL": "GA", + "SHORT": "GA", + "STRING": "GA", + "STRUCT": "GA", + "TIMESTAMP": "GA", + "USER_DEFINED_TYPE": "GA" + } + }, + "sql.ComparisonOperator": { + "enum": [ + "LESS_THAN", + "GREATER_THAN", + "EQUAL", + "NOT_EQUAL", + "GREATER_THAN_OR_EQUAL", + "LESS_THAN_OR_EQUAL", + "IS_NULL", + "IS_NOT_NULL" + ], + "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" + } + }, + "sql.CreateAlert": { + "fields": { + "name": { + "description": "Name of the alert.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "options": { + "description": "Alert configuration options.", + "ref": "sql.AlertOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "parent": { + "description": "The identifier of the workspace folder containing the object.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query_id": { + "description": "Query ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rearm": { + "description": "Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.CreateAlertRequest": { + "fields": { + "alert": { + "ref": "sql.CreateAlertRequestAlert", + "launch_stage": "GA" + }, + "auto_resolve_display_name": { + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "launch_stage": "GA" + } + } + }, + "sql.CreateAlertRequestAlert": { + "fields": { + "condition": { + "description": "Trigger conditions of the alert.", + "ref": "sql.AlertCondition", + "launch_stage": "GA" + }, + "custom_body": { + "description": "Custom body of alert notification, if it exists. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "custom_subject": { + "description": "Custom subject of alert notification, if it exists. This can include email subject entries and Slack notification headers, for example. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name of the alert.", + "launch_stage": "GA" + }, + "notify_on_ok": { + "description": "Whether to notify alert subscribers when alert returns back to normal.", + "launch_stage": "GA" + }, + "parent_path": { + "description": "The workspace path of the folder containing the alert.", + "launch_stage": "GA" + }, + "query_id": { + "description": "UUID of the query attached to the alert.", + "launch_stage": "GA" + }, + "seconds_to_retrigger": { + "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.", + "launch_stage": "GA" + } + } + }, + "sql.CreateQueryRequest": { + "fields": { + "auto_resolve_display_name": { + "description": "If true, automatically resolve query display name conflicts. Otherwise, fail the request if the query's display name conflicts with an existing query's display name.", + "launch_stage": "GA" + }, + "query": { + "ref": "sql.CreateQueryRequestQuery", + "launch_stage": "GA" + } + } + }, + "sql.CreateQueryRequestQuery": { + "fields": { + "apply_auto_limit": { + "description": "Whether to apply a 1000 row limit to the query result.", + "launch_stage": "GA" + }, + "catalog": { + "description": "Name of the catalog where this query will be executed.", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "parameters": { + "description": "List of query parameter definitions.", + "launch_stage": "GA" + }, + "parent_path": { + "description": "Workspace path of the workspace folder containing the object.", + "launch_stage": "GA" + }, + "query_text": { + "description": "Text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_mode": { + "description": "Sets the \"Run as\" role for the object.", + "ref": "sql.RunAsMode", + "launch_stage": "GA" + }, + "schema": { + "description": "Name of the schema where this query will be executed.", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "ID of the SQL warehouse attached to the query.", + "launch_stage": "GA" + } + } + }, + "sql.CreateQueryVisualizationsLegacyRequest": { + "description": "Add visualization to a query", + "fields": { + "description": { + "description": "A short description of this visualization. This is not displayed in the UI.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "The name of the visualization that appears on dashboards and the query screen.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "options": { + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "query_id": { + "description": "The identifier returned by :method:queries/create", + "launch_stage": "PRIVATE_PREVIEW" + }, + "type": { + "description": "The type of visualization: chart, table, pivot table, and so on.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.CreateVisualizationRequest": { + "fields": { + "visualization": { + "ref": "sql.CreateVisualizationRequestVisualization", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.CreateVisualizationRequestVisualization": { + "fields": { + "display_name": { + "description": "The display name of the visualization.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "query_id": { + "description": "UUID of the query that the visualization is attached to.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_options": { + "description": "The visualization options varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization options directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_query_plan": { + "description": "The visualization query plan varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying the visualization query plan directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "type": { + "description": "The type of visualization: counter, table, funnel, and so on.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.CreateWarehouseRequest": { + "description": "Creates a new SQL warehouse.", + "fields": { + "auto_stop_mins": { + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "launch_stage": "GA" + }, + "channel": { + "description": "Channel Details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "cluster_size": { + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "launch_stage": "GA" + }, + "creator_name": { + "description": "warehouse creator name", + "launch_stage": "GA" + }, + "enable_photon": { + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Configures whether the warehouse should use serverless compute", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "deprecated": true, + "launch_stage": "GA" + }, + "max_num_clusters": { + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "launch_stage": "GA" + }, + "min_num_clusters": { + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "launch_stage": "GA" + }, + "name": { + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "launch_stage": "GA" + }, + "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", + "ref": "sql.SpotInstancePolicy", + "launch_stage": "GA" + }, + "tags": { + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "ref": "sql.EndpointTags", + "launch_stage": "GA" + }, + "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "ref": "sql.CreateWarehouseRequestWarehouseType", + "launch_stage": "GA" + } + } + }, + "sql.CreateWarehouseRequestWarehouseType": { + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ], + "enum_launch_stages": { + "CLASSIC": "GA", + "PRO": "GA", + "TYPE_UNSPECIFIED": "GA" + } + }, + "sql.CreateWarehouseResponse": { + "fields": { + "id": { + "description": "Id for the SQL warehouse.\nThis value is unique across all SQL warehouses.", + "launch_stage": "GA" + } + } + }, + "sql.CreateWidget": { + "fields": { + "dashboard_id": { + "description": "Dashboard ID returned by :method:dashboards/create.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "options": { + "ref": "sql.WidgetOptions", + "launch_stage": "PRIVATE_PREVIEW" + }, + "text": { + "description": "If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the `visualization` field.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "visualization_id": { + "description": "Query Vizualization ID returned by :method:queryvisualizations/create.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "width": { + "description": "Width of a widget", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.CronSchedule": { + "fields": { + "pause_status": { + "description": "Indicate whether this schedule is paused or not.", + "ref": "sql.SchedulePauseStatus", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "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", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + }, + "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.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "sql.Dashboard": { + "description": "A JSON representing a dashboard containing widgets of visualizations and text boxes.", + "fields": { + "can_edit": { + "description": "Whether the authenticated user can edit the query definition.", + "launch_stage": "GA" + }, + "created_at": { + "description": "Timestamp when this dashboard was created.", + "launch_stage": "GA" + }, + "dashboard_filters_enabled": { + "description": "In the web application, query filters that share a name are coupled to a single selection box if this value is `true`.", + "launch_stage": "GA" + }, + "id": { + "description": "The ID for this dashboard.", + "launch_stage": "GA" + }, + "is_archived": { + "description": "Indicates whether a dashboard is trashed. Trashed dashboards won't appear in list views. If this boolean is `true`, the `options` property for this dashboard includes a `moved_to_trash_at` timestamp. Items in trash are permanently deleted after 30 days.", + "launch_stage": "GA" + }, + "is_draft": { + "description": "Whether a dashboard is a draft. Draft dashboards only appear in list views for their owners.", + "launch_stage": "GA" + }, + "is_favorite": { + "description": "Indicates whether this query object appears in the current user's favorites list. This flag determines whether the star icon for favorites is selected.", + "launch_stage": "GA" + }, + "name": { + "description": "The title of the dashboard that appears in list views and at the top of the dashboard page.", + "launch_stage": "GA" + }, + "options": { + "ref": "sql.DashboardOptions", + "launch_stage": "GA" + }, + "parent": { + "description": "The identifier of the workspace folder containing the object.", + "launch_stage": "GA" + }, + "permission_tier": { + "description": "* `CAN_VIEW`: Can view the query\n* `CAN_RUN`: Can run the query\n* `CAN_EDIT`: Can edit the query\n* `CAN_MANAGE`: Can manage the query", + "ref": "sql.PermissionLevel", + "launch_stage": "GA" + }, + "slug": { + "description": "URL slug. Usually mirrors the query name with dashes (`-`) instead of spaces. Appears in the URL for this query.", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "updated_at": { + "description": "Timestamp when this dashboard was last updated.", + "launch_stage": "GA" + }, + "user": { + "ref": "sql.User", + "launch_stage": "GA" + }, + "user_id": { + "description": "The ID of the user who owns the dashboard.", + "launch_stage": "GA" + }, + "widgets": { + "launch_stage": "GA" + } + } + }, + "sql.DashboardEditContent": { + "fields": { + "name": { + "description": "The title of this dashboard that appears in list views and at the top of the dashboard page.", + "launch_stage": "GA" + }, + "run_as_role": { + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "ref": "sql.RunAsRole", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + } + } + }, + "sql.DashboardOptions": { + "fields": { + "moved_to_trash_at": { + "description": "The timestamp when this dashboard was moved to trash. Only present when the `is_archived` property is `true`. Trashed items are deleted after thirty days.", + "launch_stage": "GA" + } + } + }, + "sql.DataSource": { + "description": "A JSON object representing a DBSQL data source / SQL warehouse.", + "fields": { + "id": { + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "launch_stage": "GA" + }, + "name": { + "description": "The string name of this data source / SQL warehouse as it appears in the Databricks SQL web application.", + "launch_stage": "GA" + }, + "pause_reason": { + "description": "Reserved for internal use.", + "launch_stage": "GA" + }, + "paused": { + "description": "Reserved for internal use.", + "launch_stage": "GA" + }, + "supports_auto_limit": { + "description": "Reserved for internal use.", + "launch_stage": "GA" + }, + "syntax": { + "description": "Reserved for internal use.", + "launch_stage": "GA" + }, + "type": { + "description": "The type of data source. For SQL warehouses, this will be `databricks_internal`.", + "launch_stage": "GA" + }, + "view_only": { + "description": "Reserved for internal use.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "The ID of the associated SQL warehouse, if this data source is backed by a SQL warehouse.", + "launch_stage": "GA" + } + } + }, + "sql.DatePrecision": { + "enum": [ + "DAY_PRECISION", + "MINUTE_PRECISION", + "SECOND_PRECISION" + ], + "enum_launch_stages": { + "DAY_PRECISION": "GA", + "MINUTE_PRECISION": "GA", + "SECOND_PRECISION": "GA" + } + }, + "sql.DateRange": { + "fields": { + "end": { + "launch_stage": "GA" + }, + "start": { + "launch_stage": "GA" + } + } + }, + "sql.DateRangeValue": { + "fields": { + "date_range_value": { + "description": "Manually specified date-time range value.", + "ref": "sql.DateRange", + "launch_stage": "GA" + }, + "dynamic_date_range_value": { + "description": "Dynamic date-time range value based on current date-time.", + "ref": "sql.DateRangeValueDynamicDateRange", + "launch_stage": "GA" + }, + "precision": { + "description": "Date-time precision to format the value into when the query is run. Defaults to DAY_PRECISION (YYYY-MM-DD).", + "ref": "sql.DatePrecision", + "launch_stage": "GA" + }, + "start_day_of_week": { + "launch_stage": "GA" + } + } + }, + "sql.DateRangeValueDynamicDateRange": { + "enum": [ + "TODAY", + "YESTERDAY", + "THIS_WEEK", + "THIS_MONTH", + "THIS_YEAR", + "LAST_WEEK", + "LAST_MONTH", + "LAST_YEAR", + "LAST_HOUR", + "LAST_8_HOURS", + "LAST_24_HOURS", + "LAST_7_DAYS", + "LAST_14_DAYS", + "LAST_30_DAYS", + "LAST_60_DAYS", + "LAST_90_DAYS", + "LAST_12_MONTHS" + ], + "enum_launch_stages": { + "LAST_12_MONTHS": "GA", + "LAST_14_DAYS": "GA", + "LAST_24_HOURS": "GA", + "LAST_30_DAYS": "GA", + "LAST_60_DAYS": "GA", + "LAST_7_DAYS": "GA", + "LAST_8_HOURS": "GA", + "LAST_90_DAYS": "GA", + "LAST_HOUR": "GA", + "LAST_MONTH": "GA", + "LAST_WEEK": "GA", + "LAST_YEAR": "GA", + "THIS_MONTH": "GA", + "THIS_WEEK": "GA", + "THIS_YEAR": "GA", + "TODAY": "GA", + "YESTERDAY": "GA" + } + }, + "sql.DateValue": { + "fields": { + "date_value": { + "description": "Manually specified date-time value.", + "launch_stage": "GA" + }, + "dynamic_date_value": { + "description": "Dynamic date-time value based on current date-time.", + "ref": "sql.DateValueDynamicDate", + "launch_stage": "GA" + }, + "precision": { + "description": "Date-time precision to format the value into when the query is run. Defaults to DAY_PRECISION (YYYY-MM-DD).", + "ref": "sql.DatePrecision", + "launch_stage": "GA" + } + } + }, + "sql.DateValueDynamicDate": { + "enum": [ + "NOW", + "YESTERDAY" + ], + "enum_launch_stages": { + "NOW": "GA", + "YESTERDAY": "GA" + } + }, + "sql.DefaultWarehouseOverride": { + "description": "Represents a per-user default warehouse override configuration.\nThis resource allows users or administrators to customize how a user's\ndefault warehouse is selected for SQL operations.\nIf no override exists for a user, the workspace default warehouse will be used.", + "fields": { + "default_warehouse_override_id": { + "description": "The ID component of the resource name (user ID).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "launch_stage": "PUBLIC_BETA" + }, + "type": { + "description": "The type of override behavior.", + "ref": "sql.DefaultWarehouseOverrideType", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "warehouse_id": { + "description": "The specific warehouse ID when type is CUSTOM.\nNot set for LAST_SELECTED type.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.DefaultWarehouseOverrideType": { + "description": "Type of default warehouse override behavior.", + "enum": [ + "LAST_SELECTED", + "CUSTOM" + ], + "enum_launch_stages": { + "CUSTOM": "PUBLIC_BETA", + "LAST_SELECTED": "PUBLIC_BETA" + } + }, + "sql.DeleteResponse": {}, + "sql.DeleteWarehouseResponse": {}, + "sql.Disposition": { + "enum": [ + "INLINE", + "EXTERNAL_LINKS" + ], + "enum_launch_stages": { + "EXTERNAL_LINKS": "GA", + "INLINE": "GA" + } + }, + "sql.EditAlert": { + "fields": { + "name": { + "description": "Name of the alert.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "options": { + "description": "Alert configuration options.", + "ref": "sql.AlertOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query_id": { + "description": "Query ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rearm": { + "description": "Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.EditWarehouseRequest": { + "description": "This is an incremental edit functionality, so all fields except id are optional. If a field is set, the corresponding\nconfiguration in the SQL warehouse is modified. If a field is unset, the existing configuration value in the SQL\nwarehouse is retained. Thus, this API is not idempotent.", + "fields": { + "auto_stop_mins": { + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "launch_stage": "GA" + }, + "channel": { + "description": "Channel Details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "cluster_size": { + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "launch_stage": "GA" + }, + "creator_name": { + "description": "warehouse creator name", + "launch_stage": "GA" + }, + "enable_photon": { + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Configures whether the warehouse should use serverless compute", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "deprecated": true, + "launch_stage": "GA" + }, + "max_num_clusters": { + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "launch_stage": "GA" + }, + "min_num_clusters": { + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "launch_stage": "GA" + }, + "name": { + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "launch_stage": "GA" + }, + "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", + "ref": "sql.SpotInstancePolicy", + "launch_stage": "GA" + }, + "tags": { + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "ref": "sql.EndpointTags", + "launch_stage": "GA" + }, + "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "ref": "sql.EditWarehouseRequestWarehouseType", + "launch_stage": "GA" + } + } + }, + "sql.EditWarehouseRequestWarehouseType": { + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ], + "enum_launch_stages": { + "CLASSIC": "GA", + "PRO": "GA", + "TYPE_UNSPECIFIED": "GA" + } + }, + "sql.EditWarehouseResponse": {}, + "sql.Empty": { + "description": "Represents an empty message, similar to google.protobuf.Empty, which is not available in the firm\nright now." + }, + "sql.EndpointConfPair": { + "fields": { + "key": { + "launch_stage": "GA" + }, + "value": { + "launch_stage": "GA" + } + } + }, + "sql.EndpointHealth": { + "fields": { + "details": { + "description": "Details about errors that are causing current degraded/failed status.", + "launch_stage": "GA" + }, + "failure_reason": { + "description": "The reason for failure to bring up clusters for this warehouse. This is available when status is 'FAILED' and sometimes when it is DEGRADED.", + "ref": "sql.TerminationReason", + "launch_stage": "GA" + }, + "message": { + "description": "Deprecated. split into summary and details for security", + "deprecated": true, + "launch_stage": "GA" + }, + "status": { + "description": "Health status of the endpoint.", + "ref": "sql.Status", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "summary": { + "description": "A short summary of the health status in case of degraded/failed warehouses.", + "launch_stage": "GA" + } + } + }, + "sql.EndpointInfo": { + "fields": { + "auto_stop_mins": { + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "launch_stage": "GA" + }, + "channel": { + "description": "Channel Details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "cluster_size": { + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "launch_stage": "GA" + }, + "creator_name": { + "description": "warehouse creator name", + "launch_stage": "GA" + }, + "enable_photon": { + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Configures whether the warehouse should use serverless compute", + "launch_stage": "GA" + }, + "health": { + "description": "Optional health status. Assume the warehouse is healthy if this field is not set.", + "ref": "sql.EndpointHealth", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "unique identifier for warehouse", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "instance_profile_arn": { + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "deprecated": true, + "launch_stage": "GA" + }, + "jdbc_url": { + "description": "the jdbc connection string for this warehouse", + "launch_stage": "GA" + }, + "max_num_clusters": { + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "launch_stage": "GA" + }, + "min_num_clusters": { + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "launch_stage": "GA" + }, + "name": { + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "launch_stage": "GA" + }, + "num_active_sessions": { + "description": "Deprecated. current number of active sessions for the warehouse", + "deprecated": true, + "launch_stage": "GA" + }, + "num_clusters": { + "description": "current number of clusters running for the service", + "launch_stage": "GA" + }, + "odbc_params": { + "description": "ODBC parameters for the SQL warehouse", + "ref": "sql.OdbcParams", + "launch_stage": "GA" + }, + "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", + "ref": "sql.SpotInstancePolicy", + "launch_stage": "GA" + }, + "state": { + "description": "state of the endpoint", + "ref": "sql.State", + "launch_stage": "GA" + }, + "tags": { + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "ref": "sql.EndpointTags", + "launch_stage": "GA" + }, + "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "ref": "sql.EndpointInfoWarehouseType", + "launch_stage": "GA" + } + } + }, + "sql.EndpointInfoWarehouseType": { + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ], + "enum_launch_stages": { + "CLASSIC": "GA", + "PRO": "GA", + "TYPE_UNSPECIFIED": "GA" + } + }, + "sql.EndpointTagPair": { + "fields": { + "key": { + "launch_stage": "GA" + }, + "value": { + "launch_stage": "GA" + } + } + }, + "sql.EndpointTags": { + "fields": { + "custom_tags": { + "launch_stage": "GA" + } + } + }, + "sql.EnumValue": { + "fields": { + "enum_options": { + "description": "List of valid query parameter values, newline delimited.", + "launch_stage": "GA" + }, + "multi_values_options": { + "description": "If specified, allows multiple values to be selected for this parameter.", + "ref": "sql.MultiValuesOptions", + "launch_stage": "GA" + }, + "values": { + "description": "List of selected query parameter values.", + "launch_stage": "GA" + } + } + }, + "sql.ExecuteStatementRequest": { + "fields": { + "byte_limit": { + "description": "Applies the given byte limit to the statement's result size. Byte counts are based on internal data\nrepresentations and might not match the final size in the requested `format`. If the result was truncated due to\nthe byte limit, then `truncated` in the response is set to `true`.\nWhen using `EXTERNAL_LINKS` disposition, a default `byte_limit` of 100 GiB is applied if `byte_limit` is not\nexplicitly set.", + "launch_stage": "GA" + }, + "catalog": { + "description": "Sets default catalog for statement execution, similar to\n[`USE CATALOG`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-catalog.html)\nin SQL.", + "launch_stage": "GA" + }, + "disposition": { + "description": "The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.\n\nStatements executed with `INLINE` disposition will return result data inline, in `JSON_ARRAY` format, in a series\nof chunks. If a given statement produces a result set with a size larger than 25 MiB,\nthat statement execution is aborted, and no result set will be available.\n\n**NOTE**\nByte limits are computed based upon internal representations of the result set data, and might not match the sizes\nvisible in JSON responses.\n\nStatements executed with `EXTERNAL_LINKS` disposition will return result data as external links: URLs that point\nto cloud storage internal to the workspace. Using `EXTERNAL_LINKS` disposition allows statements to generate\narbitrarily sized result sets for fetching up to 100 GiB. The resulting links have two important properties:\n\n1. They point to resources _external_ to the Databricks compute; therefore any associated authentication\ninformation (typically a personal access token, OAuth token, or similar) _must be removed_ when fetching from\nthese links.\n\n2. These are URLs\nwith a specific expiration, indicated in the response. The behavior when attempting to use an expired link is\ncloud specific.", + "ref": "sql.Disposition", + "launch_stage": "GA" + }, + "format": { + "description": "Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and `CSV`.\n\nImportant: The formats `ARROW_STREAM` and `CSV` are supported only with `EXTERNAL_LINKS` disposition.\n`JSON_ARRAY` is supported in `INLINE` and `EXTERNAL_LINKS` disposition.\n\nWhen specifying `format=JSON_ARRAY`, result data will be formatted as an array of arrays of values, where each\nvalue is either the *string representation* of a value, or `null`.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM range(3)` would\nlook like this:\n\n```\n[\n[ \"id-1\", \"1\", null ],\n[ \"id-2\", \"2\", null ],\n[ \"id-3\", \"3\", null ],\n]\n```\n\nWhen specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`, each chunk in the result contains compact\nJSON with no indentation or extra whitespace.\n\nWhen specifying `format=ARROW_STREAM` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be formatted\nas Apache Arrow Stream. See the\n[Apache Arrow streaming format](https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format).\n\nWhen specifying `format=CSV` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be a CSV according to\n[RFC 4180](https://www.rfc-editor.org/rfc/rfc4180) standard.\nAll the columns values will have *string representation* similar to the `JSON_ARRAY` format, and `null` values will\nbe encoded as “null”.\nOnly the first chunk in the result would contain a header row with column names.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null as nullCol FROM range(3)` would\nlook like this:\n\n```\nstrCol,intCol,nullCol\nid-1,1,null\nid-2,2,null\nid-3,3,null\n```", + "ref": "sql.Format", + "launch_stage": "GA" + }, + "on_wait_timeout": { + "description": "When `wait_timeout \u003e 0s`, the call will block up to the specified time. If the statement execution doesn't\nfinish within this time, `on_wait_timeout` determines whether the execution should continue or be canceled.\nWhen set to `CONTINUE`, the statement execution continues asynchronously and the call returns a statement ID\nwhich can be used for polling with :method:statementexecution/getStatement. When set to `CANCEL`,\nthe statement execution is canceled and the call returns with a `CANCELED` state.", + "ref": "sql.ExecuteStatementRequestOnWaitTimeout", + "launch_stage": "GA" + }, + "parameters": { + "description": "A list of parameters to pass into a SQL statement containing parameter markers. A\nparameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.\n\nFor example, the following statement contains two parameters, `my_name` and `my_date`:\n\n```\nSELECT * FROM my_table WHERE name = :my_name AND date = :my_date\n```\n\nThe parameters can be passed in the request body as follows:\n\n`\n{\n...,\n\"statement\": \"SELECT * FROM my_table WHERE name = :my_name AND date = :my_date\",\n\"parameters\": [\n{ \"name\": \"my_name\", \"value\": \"the name\" },\n{ \"name\": \"my_date\", \"value\": \"2020-01-01\", \"type\": \"DATE\" }\n]\n}\n`\n\nCurrently, positional parameters denoted by a `?` marker are not supported by the\nDatabricks SQL Statement Execution API.\n\nAlso see the section [Parameter markers](https://docs.databricks.com/sql/language-manual/sql-ref-parameter-marker.html) of the SQL language reference.", + "launch_stage": "GA" + }, + "query_tags": { + "description": "An array of query tags to annotate a SQL statement. A query tag\nconsists of a non-empty key and, optionally, a value. To represent a NULL\nvalue, either omit the `value` field or manually set it to `null` or white space.\nRefer to the SQL language reference for the format specification of query tags.\nThere's no significance to the order of tags. Only one value per key will be recorded.\nA sequence in excess of 20 query tags will be coerced to 20.\nExample:\n\n{\n...,\n\"query_tags\": [\n{ \"key\": \"team\", \"value\": \"eng\" },\n{ \"key\": \"some key only tag\" }\n]\n}", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "row_limit": { + "description": "Applies the given row limit to the statement's result set, but unlike the `LIMIT` clause in SQL,\nit also sets the `truncated` field in the response to indicate whether the result was trimmed due to the limit or\nnot.", + "launch_stage": "GA" + }, + "schema": { + "description": "Sets default schema for statement execution, similar to\n[`USE SCHEMA`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-schema.html)\nin SQL.", + "launch_stage": "GA" + }, + "statement": { + "description": "The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.\nThe maximum query text size is 16 MiB.", + "launch_stage": "GA" + }, + "wait_timeout": { + "description": "The time in seconds the call will wait for the statement's result set as `Ns`, where `N` can be set to 0 or to a\nvalue between 5 and 50.\n\nWhen set to `0s`, the statement will execute in asynchronous mode and the call will not wait for the execution to\nfinish. In this case, the call returns directly with `PENDING` state and a statement ID which can be used for\npolling with :method:statementexecution/getStatement.\n\nWhen set between 5 and 50 seconds, the call will behave synchronously up to this timeout and wait for the statement\nexecution to finish. If the execution finishes within this time, the call returns immediately with a manifest and\nresult data (or a `FAILED` state in case of an execution error). If the statement takes longer to execute,\n`on_wait_timeout` determines what should happen after the timeout is reached.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "Warehouse upon which to execute a statement. See also\n[What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)", + "launch_stage": "GA" + } + } + }, + "sql.ExecuteStatementRequestOnWaitTimeout": { + "description": "When `wait_timeout \u003e 0s`, the call will block up to the specified time. If the statement execution doesn't\nfinish within this time, `on_wait_timeout` determines whether the execution should continue or be canceled.\nWhen set to `CONTINUE`, the statement execution continues asynchronously and the call returns a statement ID\nwhich can be used for polling with :method:statementexecution/getStatement. When set to `CANCEL`,\nthe statement execution is canceled and the call returns with a `CANCELED` state.", + "enum": [ + "CONTINUE", + "CANCEL" + ], + "enum_launch_stages": { + "CANCEL": "GA", + "CONTINUE": "GA" + } + }, + "sql.ExternalLink": { + "fields": { + "byte_count": { + "description": "The number of bytes in the result chunk. This field is not available when using `INLINE`\ndisposition.", + "launch_stage": "GA" + }, + "chunk_index": { + "description": "The position within the sequence of result set chunks.", + "launch_stage": "GA" + }, + "expiration": { + "description": "Indicates the date-time that the given external link will expire and\nbecomes invalid, after which point a new `external_link` must be requested.", + "launch_stage": "GA" + }, + "external_link": { + "description": "A URL pointing to a\nchunk of result data, hosted by an external service, with a short expiration time\n(\u003c= 15 minutes). As this URL contains a temporary credential, it should be considered sensitive\nand the client should not expose this URL in a log.", + "launch_stage": "GA" + }, + "http_headers": { + "description": "HTTP headers that must be included with a GET request to the `external_link`.\nEach header is provided as a key-value pair.\nHeaders are typically used to pass a decryption key to the external service.\nThe values of these headers should be considered sensitive and the client should not expose\nthese values in a log.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_chunk_index": { + "description": "When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are no\nmore chunks. The next chunk can be fetched with a\n:method:statementexecution/getstatementresultchunkn request.", + "launch_stage": "GA" + }, + "next_chunk_internal_link": { + "description": "When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no more\nchunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and should be\ntreated as an opaque link. This is an alternative to using `next_chunk_index`.", + "launch_stage": "GA" + }, + "row_count": { + "description": "The number of rows within the result chunk.", + "launch_stage": "GA" + }, + "row_offset": { + "description": "The starting row offset within the result set.", + "launch_stage": "GA" + } + } + }, + "sql.ExternalQuerySource": { + "fields": { + "alert_id": { + "description": "The canonical identifier for this SQL alert", + "launch_stage": "GA" + }, + "dashboard_id": { + "description": "The canonical identifier for this Lakeview dashboard", + "launch_stage": "GA" + }, + "genie_space_id": { + "description": "The canonical identifier for this Genie space", + "launch_stage": "GA" + }, + "job_info": { + "ref": "sql.ExternalQuerySourceJobInfo", + "launch_stage": "GA" + }, + "legacy_dashboard_id": { + "description": "The canonical identifier for this legacy dashboard", + "launch_stage": "GA" + }, + "notebook_id": { + "description": "The canonical identifier for this notebook", + "launch_stage": "GA" + }, + "sql_query_id": { + "description": "The canonical identifier for this SQL query", + "launch_stage": "GA" + } + } + }, + "sql.ExternalQuerySourceJobInfo": { + "fields": { + "job_id": { + "description": "The canonical identifier for this job.", + "launch_stage": "GA" + }, + "job_run_id": { + "description": "The canonical identifier of the run. This ID is unique across all runs of all jobs.", + "launch_stage": "GA" + }, + "job_task_run_id": { + "description": "The canonical identifier of the task run.", + "launch_stage": "GA" + } + } + }, + "sql.Format": { + "enum": [ + "JSON_ARRAY", + "ARROW_STREAM", + "CSV" + ], + "enum_launch_stages": { + "ARROW_STREAM": "GA", + "CSV": "GA", + "JSON_ARRAY": "GA" + } + }, + "sql.GetResponse": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "description": "An object's type and UUID, separated by a forward slash (/) character.", + "launch_stage": "GA" + }, + "object_type": { + "description": "A singular noun object type.", + "ref": "sql.ObjectType", + "launch_stage": "GA" + } + } + }, + "sql.GetWarehousePermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "sql.GetWarehouseResponse": { + "fields": { + "auto_stop_mins": { + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "launch_stage": "GA" + }, + "channel": { + "description": "Channel Details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "cluster_size": { + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "launch_stage": "GA" + }, + "creator_name": { + "description": "warehouse creator name", + "launch_stage": "GA" + }, + "enable_photon": { + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Configures whether the warehouse should use serverless compute", + "launch_stage": "GA" + }, + "health": { + "description": "Optional health status. Assume the warehouse is healthy if this field is not set.", + "ref": "sql.EndpointHealth", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "unique identifier for warehouse", + "launch_stage": "GA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "instance_profile_arn": { + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "deprecated": true, + "launch_stage": "GA" + }, + "jdbc_url": { + "description": "the jdbc connection string for this warehouse", + "launch_stage": "GA" + }, + "max_num_clusters": { + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "launch_stage": "GA" + }, + "min_num_clusters": { + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "launch_stage": "GA" + }, + "name": { + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "launch_stage": "GA" + }, + "num_active_sessions": { + "description": "Deprecated. current number of active sessions for the warehouse", + "deprecated": true, + "launch_stage": "GA" + }, + "num_clusters": { + "description": "current number of clusters running for the service", + "launch_stage": "GA" + }, + "odbc_params": { + "description": "ODBC parameters for the SQL warehouse", + "ref": "sql.OdbcParams", + "launch_stage": "GA" + }, + "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", + "ref": "sql.SpotInstancePolicy", + "launch_stage": "GA" + }, + "state": { + "description": "state of the endpoint", + "ref": "sql.State", + "launch_stage": "GA" + }, + "tags": { + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "ref": "sql.EndpointTags", + "launch_stage": "GA" + }, + "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "ref": "sql.GetWarehouseResponseWarehouseType", + "launch_stage": "GA" + } + } + }, + "sql.GetWarehouseResponseWarehouseType": { + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ], + "enum_launch_stages": { + "CLASSIC": "GA", + "PRO": "GA", + "TYPE_UNSPECIFIED": "GA" + } + }, + "sql.GetWorkspaceWarehouseConfigResponse": { + "fields": { + "channel": { + "description": "Optional: Channel selection details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "config_param": { + "description": "Deprecated: Use sql_configuration_parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "deprecated": true, + "launch_stage": "GA" + }, + "data_access_config": { + "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Deprecated: only setting this to true is allowed.", + "deprecated": true, + "launch_stage": "GA" + }, + "enabled_warehouse_types": { + "description": "List of Warehouse Types allowed in this workspace (limits allowed value of\nthe type field in CreateWarehouse and EditWarehouse). Note: Some types\ncannot be disabled, they don't need to be specified\nin SetWorkspaceWarehouseConfig.\nNote: Disabling a type may cause existing warehouses to be converted to\nanother type. Used by frontend to save specific type availability in the\nwarehouse create and edit form UI.", + "launch_stage": "GA" + }, + "global_param": { + "description": "Deprecated: Use sql_configuration_parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "deprecated": true, + "launch_stage": "GA" + }, + "google_service_account": { + "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "AWS Only: The instance profile used to pass an IAM role to the SQL\nwarehouses. This configuration is also applied to the workspace's\nserverless compute for notebooks and jobs.", + "deprecated": true, + "launch_stage": "GA" + }, + "security_policy": { + "description": "Security policy for warehouses", + "ref": "sql.GetWorkspaceWarehouseConfigResponseSecurityPolicy", + "launch_stage": "GA" + }, + "sql_configuration_parameters": { + "description": "SQL configuration parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "launch_stage": "GA" + } + } + }, + "sql.GetWorkspaceWarehouseConfigResponseSecurityPolicy": { + "description": "Security policy to be used for warehouses", + "enum": [ + "NONE", + "DATA_ACCESS_CONTROL", + "PASSTHROUGH" + ], + "enum_launch_stages": { + "DATA_ACCESS_CONTROL": "GA", + "NONE": "GA", + "PASSTHROUGH": "GA" + } + }, + "sql.LegacyAlert": { + "fields": { + "created_at": { + "description": "Timestamp when the alert was created.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "id": { + "description": "Alert ID.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "last_triggered_at": { + "description": "Timestamp when the alert was last triggered.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of the alert.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "options": { + "description": "Alert configuration options.", + "ref": "sql.AlertOptions", + "launch_stage": "PUBLIC_PREVIEW" + }, + "parent": { + "description": "The identifier of the workspace folder containing the object.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query": { + "ref": "sql.AlertQuery", + "launch_stage": "PUBLIC_PREVIEW" + }, + "rearm": { + "description": "Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "state": { + "description": "State of the alert. Possible values are: `unknown` (yet to be evaluated), `triggered` (evaluated and fulfilled trigger conditions), or `ok` (evaluated and did not fulfill trigger conditions).", + "ref": "sql.LegacyAlertState", + "launch_stage": "PUBLIC_PREVIEW" + }, + "updated_at": { + "description": "Timestamp when the alert was last updated.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "user": { + "ref": "sql.User", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.LegacyAlertState": { + "enum": [ + "ok", + "triggered", + "unknown" + ], + "enum_launch_stages": { + "ok": "PUBLIC_PREVIEW", + "triggered": "PUBLIC_PREVIEW", + "unknown": "PUBLIC_PREVIEW" + } + }, + "sql.LegacyQuery": { + "fields": { + "can_edit": { + "description": "Describes whether the authenticated user is allowed to edit the definition of this query.", + "launch_stage": "GA" + }, + "created_at": { + "description": "The timestamp when this query was created.", + "launch_stage": "GA" + }, + "data_source_id": { + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "id": { + "description": "Query ID.", + "launch_stage": "GA" + }, + "is_archived": { + "description": "Indicates whether the query is trashed. Trashed queries can't be used in dashboards, or appear in search results. If this boolean is `true`, the `options` property for this query includes a `moved_to_trash_at` timestamp. Trashed queries are permanently deleted after 30 days.", + "launch_stage": "GA" + }, + "is_draft": { + "description": "Whether the query is a draft. Draft queries only appear in list views for their owners. Visualizations from draft queries cannot appear on dashboards.", + "launch_stage": "GA" + }, + "is_favorite": { + "description": "Whether this query object appears in the current user's favorites list. This flag determines whether the star icon for favorites is selected.", + "launch_stage": "GA" + }, + "is_safe": { + "description": "Text parameter types are not safe from SQL injection for all types of data source. Set this Boolean parameter to `true` if a query either does not use any text type parameters or uses a data source type where text type parameters are handled safely.", + "launch_stage": "GA" + }, + "last_modified_by": { + "ref": "sql.User", + "launch_stage": "GA" + }, + "last_modified_by_id": { + "description": "The ID of the user who last saved changes to this query.", + "launch_stage": "GA" + }, + "latest_query_data_id": { + "description": "If there is a cached result for this query and user, this field includes the query result ID. If this query uses parameters, this field is always null.", + "launch_stage": "GA" + }, + "name": { + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "options": { + "ref": "sql.QueryOptions", + "launch_stage": "GA" + }, + "parent": { + "description": "The identifier of the workspace folder containing the object.", + "launch_stage": "GA" + }, + "permission_tier": { + "description": "* `CAN_VIEW`: Can view the query\n* `CAN_RUN`: Can run the query\n* `CAN_EDIT`: Can edit the query\n* `CAN_MANAGE`: Can manage the query", + "ref": "sql.PermissionLevel", + "launch_stage": "GA" + }, + "query": { + "description": "The text of the query to be run.", + "launch_stage": "GA" + }, + "query_hash": { + "description": "A SHA-256 hash of the query text along with the authenticated user ID.", + "launch_stage": "GA" + }, + "run_as_role": { + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "ref": "sql.RunAsRole", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "updated_at": { + "description": "The timestamp at which this query was last updated.", + "launch_stage": "GA" + }, + "user": { + "ref": "sql.User", + "launch_stage": "GA" + }, + "user_id": { + "description": "The ID of the user who owns the query.", + "launch_stage": "GA" + }, + "visualizations": { + "launch_stage": "GA" + } + } + }, + "sql.LegacyVisualization": { + "description": "The visualization description API changes frequently and is unsupported. You can duplicate a visualization by copying description objects received _from the API_ and then using them to create a new one with a POST request to the same endpoint. Databricks does not recommend constructing ad-hoc visualizations entirely in JSON.", + "fields": { + "created_at": { + "launch_stage": "GA" + }, + "description": { + "description": "A short description of this visualization. This is not displayed in the UI.", + "launch_stage": "GA" + }, + "id": { + "description": "The UUID for this visualization.", + "launch_stage": "GA" + }, + "name": { + "description": "The name of the visualization that appears on dashboards and the query screen.", + "launch_stage": "GA" + }, + "options": { + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "launch_stage": "GA" + }, + "query": { + "ref": "sql.LegacyQuery", + "launch_stage": "GA" + }, + "type": { + "description": "The type of visualization: chart, table, pivot table, and so on.", + "launch_stage": "GA" + }, + "updated_at": { + "launch_stage": "GA" + } + } + }, + "sql.LifecycleState": { + "enum": [ + "ACTIVE", + "TRASHED" + ], + "enum_launch_stages": { + "ACTIVE": "GA", + "TRASHED": "GA" + } + }, + "sql.ListAlertsResponse": { + "fields": { + "next_page_token": { + "launch_stage": "GA" + }, + "results": { + "launch_stage": "GA" + } + } + }, + "sql.ListAlertsResponseAlert": { + "fields": { + "condition": { + "description": "Trigger conditions of the alert.", + "ref": "sql.AlertCondition", + "launch_stage": "GA" + }, + "create_time": { + "description": "The timestamp indicating when the alert was created.", + "launch_stage": "GA" + }, + "custom_body": { + "description": "Custom body of alert notification, if it exists. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "custom_subject": { + "description": "Custom subject of alert notification, if it exists. This can include email subject entries and Slack notification headers, for example. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name of the alert.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying the alert.", + "launch_stage": "GA" + }, + "lifecycle_state": { + "description": "The workspace state of the alert. Used for tracking trashed status.", + "ref": "sql.LifecycleState", + "launch_stage": "GA" + }, + "notify_on_ok": { + "description": "Whether to notify alert subscribers when alert returns back to normal.", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "launch_stage": "GA" + }, + "query_id": { + "description": "UUID of the query attached to the alert.", + "launch_stage": "GA" + }, + "seconds_to_retrigger": { + "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the alert's trigger status. This field is set to UNKNOWN if the alert has not yet been evaluated or ran into an error during the last evaluation.", + "ref": "sql.AlertState", + "launch_stage": "GA" + }, + "trigger_time": { + "description": "Timestamp when the alert was last triggered, if the alert has been triggered before.", + "launch_stage": "GA" + }, + "update_time": { + "description": "The timestamp indicating when the alert was updated.", + "launch_stage": "GA" + } + } + }, + "sql.ListAlertsV2Response": { + "fields": { + "alerts": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "next_page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.ListDefaultWarehouseOverridesResponse": { + "description": "Response message for ListDefaultWarehouseOverrides.", + "fields": { + "default_warehouse_overrides": { + "description": "The default warehouse overrides in the workspace.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "sql.ListOrder": { + "enum": [ + "created_at", + "name" + ], + "enum_launch_stages": { + "created_at": "GA", + "name": "GA" + } + }, + "sql.ListQueriesResponse": { + "fields": { + "has_next_page": { + "description": "Whether there is another page of results.", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results.", + "launch_stage": "GA" + }, + "res": { + "launch_stage": "GA" + } + } + }, + "sql.ListQueryObjectsResponse": { + "fields": { + "next_page_token": { + "launch_stage": "GA" + }, + "results": { + "launch_stage": "GA" + } + } + }, + "sql.ListQueryObjectsResponseQuery": { + "fields": { + "apply_auto_limit": { + "description": "Whether to apply a 1000 row limit to the query result.", + "launch_stage": "GA" + }, + "catalog": { + "description": "Name of the catalog where this query will be executed.", + "launch_stage": "GA" + }, + "create_time": { + "description": "Timestamp when this query was created.", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying the query.", + "launch_stage": "GA" + }, + "last_modifier_user_name": { + "description": "Username of the user who last saved changes to this query.", + "launch_stage": "GA" + }, + "lifecycle_state": { + "description": "Indicates whether the query is trashed.", + "ref": "sql.LifecycleState", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "Username of the user that owns the query.", + "launch_stage": "GA" + }, + "parameters": { + "description": "List of query parameter definitions.", + "launch_stage": "GA" + }, + "query_text": { + "description": "Text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_mode": { + "description": "Sets the \"Run as\" role for the object.", + "ref": "sql.RunAsMode", + "launch_stage": "GA" + }, + "schema": { + "description": "Name of the schema where this query will be executed.", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "update_time": { + "description": "Timestamp when this query was last updated.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "ID of the SQL warehouse attached to the query.", + "launch_stage": "GA" + } + } + }, + "sql.ListResponse": { + "fields": { + "count": { + "description": "The total number of dashboards.", + "launch_stage": "GA" + }, + "page": { + "description": "The current page being displayed.", + "launch_stage": "GA" + }, + "page_size": { + "description": "The number of dashboards per page.", + "launch_stage": "GA" + }, + "results": { + "description": "List of dashboards returned.", + "launch_stage": "GA" + } + } + }, + "sql.ListString": { + "launch_stage": "GA" + }, + "sql.ListVisualizationsForQueryResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "results": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.ListWarehousesResponse": { + "fields": { + "next_page_token": { + "description": "A token, which can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "GA" + }, + "warehouses": { + "description": "A list of warehouses and their configurations.", + "launch_stage": "GA" + } + } + }, + "sql.MultiValuesOptions": { + "fields": { + "prefix": { + "description": "Character that prefixes each selected parameter value.", + "launch_stage": "GA" + }, + "separator": { + "description": "Character that separates each selected parameter value. Defaults to a comma.", + "launch_stage": "GA" + }, + "suffix": { + "description": "Character that suffixes each selected parameter value.", + "launch_stage": "GA" + } + } + }, + "sql.NumericValue": { + "fields": { + "value": { + "launch_stage": "GA" + } + } + }, + "sql.ObjectType": { + "description": "A singular noun object type.", + "enum": [ + "alert", + "dashboard", + "data_source", + "query" + ], + "enum_launch_stages": { + "alert": "GA", + "dashboard": "GA", + "data_source": "GA", + "query": "GA" + } + }, + "sql.ObjectTypePlural": { + "description": "Always a plural of the object type.", + "enum": [ + "alerts", + "dashboards", + "data_sources", + "queries" + ], + "enum_launch_stages": { + "alerts": "GA", + "dashboards": "GA", + "data_sources": "GA", + "queries": "GA" + } + }, + "sql.OdbcParams": { + "fields": { + "hostname": { + "launch_stage": "GA" + }, + "path": { + "launch_stage": "GA" + }, + "port": { + "launch_stage": "GA" + }, + "protocol": { + "launch_stage": "GA" + } + } + }, + "sql.OwnableObjectType": { + "enum": [ + "alert", + "dashboard", + "query" + ], + "enum_launch_stages": { + "alert": "GA", + "dashboard": "GA", + "query": "GA" + } + }, + "sql.Parameter": { + "fields": { + "enumOptions": { + "description": "List of valid parameter values, newline delimited. Only applies for dropdown list parameters.", + "launch_stage": "GA" + }, + "multiValuesOptions": { + "description": "If specified, allows multiple values to be selected for this parameter. Only applies to dropdown list and query-based dropdown list parameters.", + "ref": "sql.MultiValuesOptions", + "launch_stage": "GA" + }, + "name": { + "description": "The literal parameter marker that appears between double curly braces in the query text.", + "launch_stage": "GA" + }, + "queryId": { + "description": "The UUID of the query that provides the parameter values. Only applies for query-based dropdown list parameters.", + "launch_stage": "GA" + }, + "title": { + "description": "The text displayed in a parameter picking widget.", + "launch_stage": "GA" + }, + "type": { + "description": "Parameters can have several different types.", + "ref": "sql.ParameterType", + "launch_stage": "GA" + }, + "value": { + "description": "The default value for this parameter.", + "launch_stage": "GA" + } + } + }, + "sql.ParameterType": { + "enum": [ + "datetime", + "enum", + "number", + "query", + "text" + ], + "enum_launch_stages": { + "datetime": "GA", + "enum": "GA", + "number": "GA", + "query": "GA", + "text": "GA" + } + }, + "sql.PermissionLevel": { + "description": "* `CAN_VIEW`: Can view the query\n* `CAN_RUN`: Can run the query\n* `CAN_EDIT`: Can edit the query\n* `CAN_MANAGE`: Can manage the query", + "enum": [ + "CAN_EDIT", + "CAN_MANAGE", + "CAN_RUN", + "CAN_VIEW" + ], + "enum_launch_stages": { + "CAN_EDIT": "GA", + "CAN_MANAGE": "GA", + "CAN_RUN": "GA", + "CAN_VIEW": "GA" + }, + "enum_descriptions": { + "CAN_EDIT": "Can edit the query", + "CAN_MANAGE": "Can manage the query", + "CAN_RUN": "Can run the query", + "CAN_VIEW": "Can view the query" + } + }, + "sql.PlansState": { + "description": "Possible Reasons for which we have not saved plans in the database", + "enum": [ + "IGNORED_SMALL_DURATION", + "IGNORED_LARGE_PLANS_SIZE", + "EXISTS", + "UNKNOWN", + "EMPTY", + "IGNORED_SPARK_PLAN_TYPE" + ], + "enum_launch_stages": { + "EMPTY": "GA", + "EXISTS": "GA", + "IGNORED_LARGE_PLANS_SIZE": "GA", + "IGNORED_SMALL_DURATION": "GA", + "IGNORED_SPARK_PLAN_TYPE": "GA", + "UNKNOWN": "GA" + } + }, + "sql.Query": { + "fields": { + "apply_auto_limit": { + "description": "Whether to apply a 1000 row limit to the query result.", + "launch_stage": "GA" + }, + "catalog": { + "description": "Name of the catalog where this query will be executed.", + "launch_stage": "GA" + }, + "create_time": { + "description": "Timestamp when this query was created.", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "id": { + "description": "UUID identifying the query.", + "launch_stage": "GA" + }, + "last_modifier_user_name": { + "description": "Username of the user who last saved changes to this query.", + "launch_stage": "GA" + }, + "lifecycle_state": { + "description": "Indicates whether the query is trashed.", + "ref": "sql.LifecycleState", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "Username of the user that owns the query.", + "launch_stage": "GA" + }, + "parameters": { + "description": "List of query parameter definitions.", + "launch_stage": "GA" + }, + "parent_path": { + "description": "Workspace path of the workspace folder containing the object.", + "launch_stage": "GA" + }, + "query_text": { + "description": "Text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_mode": { + "description": "Sets the \"Run as\" role for the object.", + "ref": "sql.RunAsMode", + "launch_stage": "GA" + }, + "schema": { + "description": "Name of the schema where this query will be executed.", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "update_time": { + "description": "Timestamp when this query was last updated.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "ID of the SQL warehouse attached to the query.", + "launch_stage": "GA" + } + } + }, + "sql.QueryBackedValue": { + "fields": { + "multi_values_options": { + "description": "If specified, allows multiple values to be selected for this parameter.", + "ref": "sql.MultiValuesOptions", + "launch_stage": "GA" + }, + "query_id": { + "description": "UUID of the query that provides the parameter values.", + "launch_stage": "GA" + }, + "values": { + "description": "List of selected query parameter values.", + "launch_stage": "GA" + } + } + }, + "sql.QueryEditContent": { + "fields": { + "data_source_id": { + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "name": { + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "options": { + "description": "Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.", + "launch_stage": "GA" + }, + "query": { + "description": "The text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_role": { + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "ref": "sql.RunAsRole", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + } + } + }, + "sql.QueryFilter": { + "fields": { + "query_start_time_range": { + "description": "A range filter for query submitted time. The time range must be less than or equal to 30 days.", + "ref": "sql.TimeRange", + "launch_stage": "GA" + }, + "statement_ids": { + "description": "A list of statement IDs.", + "launch_stage": "GA" + }, + "statuses": { + "description": "A list of statuses (QUEUED, RUNNING, CANCELED, FAILED, FINISHED) to match query results. Corresponds to\nthe `status` field in the response.\nFiltering for multiple statuses is not recommended. Instead, opt to filter by a single status\nmultiple times and then combine the results.", + "launch_stage": "GA" + }, + "user_ids": { + "description": "A list of user IDs who ran the queries.", + "launch_stage": "GA" + }, + "warehouse_ids": { + "description": "A list of warehouse IDs.", + "launch_stage": "GA" + } + } + }, + "sql.QueryInfo": { + "fields": { + "cache_query_id": { + "description": "The ID of the cached query if this result retrieved from cache", + "launch_stage": "GA" + }, + "channel_used": { + "description": "SQL Warehouse channel information at the time of query execution", + "ref": "sql.ChannelInfo", + "launch_stage": "GA" + }, + "client_application": { + "description": "Client application that ran the statement. For example: Databricks SQL Editor, Tableau, and Power BI.\nThis field is derived from information provided by client applications. While values are expected to\nremain static over time, this cannot be guaranteed.", + "launch_stage": "GA" + }, + "duration": { + "description": "Total time of the statement execution. This value does not include the time taken to retrieve the results, which\ncan result in a discrepancy between this value and the start-to-finish wall-clock time.", + "launch_stage": "GA" + }, + "endpoint_id": { + "description": "Alias for `warehouse_id`.", + "deprecated": true, + "launch_stage": "GA" + }, + "error_message": { + "description": "Message describing why the query could not complete.", + "launch_stage": "GA" + }, + "executed_as_user_id": { + "description": "The ID of the user whose credentials were used to run the query.", + "launch_stage": "GA" + }, + "executed_as_user_name": { + "description": "The email address or username of the user whose credentials were used to run the query.", + "launch_stage": "GA" + }, + "execution_end_time_ms": { + "description": "The time execution of the query ended.", + "launch_stage": "GA" + }, + "is_final": { + "description": "Whether more updates for the query are expected.", + "launch_stage": "GA" + }, + "lookup_key": { + "description": "A key that can be used to look up query details.", + "launch_stage": "GA" + }, + "metrics": { + "description": "Metrics about query execution.", + "ref": "sql.QueryMetrics", + "launch_stage": "GA" + }, + "plans_state": { + "description": "Whether plans exist for the execution, or the reason why they are missing", + "ref": "sql.PlansState", + "launch_stage": "GA" + }, + "query_end_time_ms": { + "description": "The time the query ended.", + "launch_stage": "GA" + }, + "query_id": { + "description": "The query ID.", + "launch_stage": "GA" + }, + "query_source": { + "description": "A struct that contains key-value pairs representing Databricks entities that were involved in the execution\nof this statement, such as jobs, notebooks, or dashboards. This field only records Databricks entities.", + "ref": "sql.ExternalQuerySource", + "launch_stage": "GA" + }, + "query_start_time_ms": { + "description": "The time the query started.", + "launch_stage": "GA" + }, + "query_tags": { + "description": "A query execution can be optionally annotated with query tags", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query_text": { + "description": "The text of the query.", + "launch_stage": "GA" + }, + "rows_produced": { + "description": "The number of results returned by the query.", + "launch_stage": "GA" + }, + "session_id": { + "description": "The spark session UUID that query ran on.\nThis is either the Spark Connect, DBSQL, or SDP session ID.", + "launch_stage": "GA" + }, + "spark_ui_url": { + "description": "URL to the Spark UI query plan.", + "launch_stage": "GA" + }, + "statement_type": { + "description": "Type of statement for this query", + "ref": "sql.QueryStatementType", + "launch_stage": "GA" + }, + "status": { + "description": "Query status with one the following values:\n\n- `QUEUED`: Query has been received and queued.\n- `RUNNING`: Query has started.\n- `CANCELED`: Query has been cancelled by the user.\n- `FAILED`: Query has failed.\n- `FINISHED`: Query has completed.", + "ref": "sql.QueryStatus", + "launch_stage": "GA" + }, + "user_id": { + "description": "The ID of the user who ran the query.", + "launch_stage": "GA" + }, + "user_name": { + "description": "The email address or username of the user who ran the query.", + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "Warehouse ID.", + "launch_stage": "GA" + } + } + }, + "sql.QueryList": { + "fields": { + "count": { + "description": "The total number of queries.", + "launch_stage": "GA" + }, + "page": { + "description": "The page number that is currently displayed.", + "launch_stage": "GA" + }, + "page_size": { + "description": "The number of queries per page.", + "launch_stage": "GA" + }, + "results": { + "description": "List of queries returned.", + "launch_stage": "GA" + } + } + }, + "sql.QueryMetrics": { + "description": "A query metric that encapsulates a set of measurements for a single query.\nMetrics come from the driver and are stored in the history service database.", + "fields": { + "compilation_time_ms": { + "description": "Time spent loading metadata and optimizing the query, in milliseconds.", + "launch_stage": "GA" + }, + "execution_time_ms": { + "description": "Time spent executing the query, in milliseconds.", + "launch_stage": "GA" + }, + "network_sent_bytes": { + "description": "Total amount of data sent over the network between executor nodes during shuffle, in bytes.", + "launch_stage": "GA" + }, + "overloading_queue_start_timestamp": { + "description": "Timestamp of when the query was enqueued waiting while the warehouse was at max load.\nThis field is optional and will not appear if the query skipped the overloading queue.", + "launch_stage": "GA" + }, + "photon_total_time_ms": { + "description": "Total execution time for all individual Photon query engine tasks in the query, in milliseconds.", + "launch_stage": "GA" + }, + "projected_remaining_task_total_time_ms": { + "description": "projected remaining work to be done aggregated across all stages in the query, in milliseconds", + "launch_stage": "GA" + }, + "projected_remaining_wallclock_time_ms": { + "description": "projected lower bound on remaining total task time based on projected_remaining_task_total_time_ms / maximum concurrency", + "launch_stage": "GA" + }, + "provisioning_queue_start_timestamp": { + "description": "Timestamp of when the query was enqueued waiting for a cluster to be provisioned for the warehouse.\nThis field is optional and will not appear if the query skipped the provisioning queue.", + "launch_stage": "GA" + }, + "pruned_bytes": { + "description": "Total number of file bytes in all tables not read due to pruning", + "launch_stage": "GA" + }, + "pruned_files_count": { + "description": "Total number of files from all tables not read due to pruning", + "launch_stage": "GA" + }, + "query_compilation_start_timestamp": { + "description": "Timestamp of when the underlying compute started compilation of the query.", + "launch_stage": "GA" + }, + "read_bytes": { + "description": "Total size of data read by the query, in bytes.", + "launch_stage": "GA" + }, + "read_cache_bytes": { + "description": "Size of persistent data read from the cache, in bytes.", + "launch_stage": "GA" + }, + "read_files_bytes": { + "description": "Total number of file bytes in all tables read", + "launch_stage": "GA" + }, + "read_files_count": { + "description": "Number of files read after pruning", + "launch_stage": "GA" + }, + "read_partitions_count": { + "description": "Number of partitions read after pruning.", + "launch_stage": "GA" + }, + "read_remote_bytes": { + "description": "Size of persistent data read from cloud object storage on your cloud tenant, in bytes.", + "launch_stage": "GA" + }, + "remaining_task_count": { + "description": "number of remaining tasks to complete\nthis is based on the current status and could be bigger or smaller in the future based on future updates", + "launch_stage": "GA" + }, + "result_fetch_time_ms": { + "description": "Time spent fetching the query results after the execution finished, in milliseconds.", + "launch_stage": "GA" + }, + "result_from_cache": { + "description": "`true` if the query result was fetched from cache, `false` otherwise.", + "launch_stage": "GA" + }, + "rows_produced_count": { + "description": "Total number of rows returned by the query.", + "launch_stage": "GA" + }, + "rows_read_count": { + "description": "Total number of rows read by the query.", + "launch_stage": "GA" + }, + "runnable_tasks": { + "description": "number of remaining tasks to complete, calculated by autoscaler StatementAnalysis.scala\ndeprecated: use remaining_task_count instead", + "deprecated": true, + "launch_stage": "GA" + }, + "spill_to_disk_bytes": { + "description": "Size of data temporarily written to disk while executing the query, in bytes.", + "launch_stage": "GA" + }, + "task_time_over_time_range": { + "description": "sum of task times completed in a range of wall clock time, approximated to a configurable number of points\naggregated over all stages and jobs in the query (based on task_total_time_ms)", + "ref": "sql.TaskTimeOverRange", + "launch_stage": "GA" + }, + "task_total_time_ms": { + "description": "Sum of execution time for all of the query’s tasks, in milliseconds.", + "launch_stage": "GA" + }, + "total_time_ms": { + "description": "Total execution time of the query from the client’s point of view, in milliseconds.", + "launch_stage": "GA" + }, + "work_to_be_done": { + "description": "remaining work to be done across all stages in the query, calculated by autoscaler StatementAnalysis.scala, in milliseconds\ndeprecated: using projected_remaining_task_total_time_ms instead", + "deprecated": true, + "launch_stage": "GA" + }, + "write_remote_bytes": { + "description": "Size pf persistent data written to cloud object storage in your cloud tenant, in bytes.", + "launch_stage": "GA" + } + } + }, + "sql.QueryOptions": { + "fields": { + "catalog": { + "description": "The name of the catalog to execute this query in.", + "launch_stage": "GA" + }, + "moved_to_trash_at": { + "description": "The timestamp when this query was moved to trash. Only present when the `is_archived` property is `true`. Trashed items are deleted after thirty days.", + "launch_stage": "GA" + }, + "parameters": { + "launch_stage": "GA" + }, + "schema": { + "description": "The name of the schema to execute this query in.", + "launch_stage": "GA" + } + } + }, + "sql.QueryParameter": { + "fields": { + "date_range_value": { + "description": "Date-range query parameter value. Can only specify one of `dynamic_date_range_value` or `date_range_value`.", + "ref": "sql.DateRangeValue", + "launch_stage": "GA" + }, + "date_value": { + "description": "Date query parameter value. Can only specify one of `dynamic_date_value` or `date_value`.", + "ref": "sql.DateValue", + "launch_stage": "GA" + }, + "enum_value": { + "description": "Dropdown query parameter value.", + "ref": "sql.EnumValue", + "launch_stage": "GA" + }, + "name": { + "description": "Literal parameter marker that appears between double curly braces in the query text.", + "launch_stage": "GA" + }, + "numeric_value": { + "description": "Numeric query parameter value.", + "ref": "sql.NumericValue", + "launch_stage": "GA" + }, + "query_backed_value": { + "description": "Query-based dropdown query parameter value.", + "ref": "sql.QueryBackedValue", + "launch_stage": "GA" + }, + "text_value": { + "description": "Text query parameter value.", + "ref": "sql.TextValue", + "launch_stage": "GA" + }, + "title": { + "description": "Text displayed in the user-facing parameter widget in the UI.", + "launch_stage": "GA" + } + } + }, + "sql.QueryPostContent": { + "fields": { + "data_source_id": { + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "name": { + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "options": { + "description": "Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.", + "launch_stage": "GA" + }, + "parent": { + "description": "The identifier of the workspace folder containing the object.", + "launch_stage": "GA" + }, + "query": { + "description": "The text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_role": { + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "ref": "sql.RunAsRole", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + } + } + }, + "sql.QueryStatementType": { + "enum": [ + "OTHER", + "ALTER", + "ANALYZE", + "COPY", + "CREATE", + "DELETE", + "DESCRIBE", + "DROP", + "EXPLAIN", + "GRANT", + "INSERT", + "MERGE", + "OPTIMIZE", + "REFRESH", + "REPLACE", + "REVOKE", + "SELECT", + "SET", + "SHOW", + "TRUNCATE", + "UPDATE", + "USE" + ], + "enum_launch_stages": { + "ALTER": "GA", + "ANALYZE": "GA", + "COPY": "GA", + "CREATE": "GA", + "DELETE": "GA", + "DESCRIBE": "GA", + "DROP": "GA", + "EXPLAIN": "GA", + "GRANT": "GA", + "INSERT": "GA", + "MERGE": "GA", + "OPTIMIZE": "GA", + "OTHER": "GA", + "REFRESH": "GA", + "REPLACE": "GA", + "REVOKE": "GA", + "SELECT": "GA", + "SET": "GA", + "SHOW": "GA", + "TRUNCATE": "GA", + "UPDATE": "GA", + "USE": "GA" + } + }, + "sql.QueryStatus": { + "description": "Statuses which are also used by OperationStatus in runtime.\nWhen adding a new QueryStatus, make sure to update com.databricks.sqlgateway.history.QueryStatusOrdering", + "enum": [ + "QUEUED", + "STARTED", + "COMPILING", + "COMPILED", + "RUNNING", + "CANCELED", + "FAILED", + "FINISHED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "COMPILED": "GA", + "COMPILING": "GA", + "FAILED": "GA", + "FINISHED": "GA", + "QUEUED": "GA", + "RUNNING": "GA", + "STARTED": "GA" + } + }, + "sql.QueryTag": { + "description": "* A query execution can be annotated with an optional key-value pair to\nallow users to attribute the executions by key and optional value to filter by.\nQueryTag is the user-facing representation.", + "fields": { + "key": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "value": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.RepeatedEndpointConfPairs": { + "fields": { + "config_pair": { + "description": "Deprecated: Use configuration_pairs", + "deprecated": true, + "launch_stage": "GA" + }, + "configuration_pairs": { + "launch_stage": "GA" + } + } + }, + "sql.RestoreResponse": {}, + "sql.ResultData": { + "description": "Contains the result data of a single chunk when using `INLINE` disposition. When using\n`EXTERNAL_LINKS` disposition, the array `external_links` is used instead to provide\nURLs to the result data\nin cloud storage. Exactly one of these alternatives is used. (While the `external_links`\narray prepares the API to return multiple links in a single response. Currently only a single\nlink is returned.)", + "fields": { + "byte_count": { + "description": "The number of bytes in the result chunk. This field is not available when using `INLINE`\ndisposition.", + "launch_stage": "GA" + }, + "chunk_index": { + "description": "The position within the sequence of result set chunks.", + "launch_stage": "GA" + }, + "data_array": { + "description": "The `JSON_ARRAY` format is an array of arrays of values, where each non-null value is\nformatted as a string. Null values are encoded as JSON `null`.", + "launch_stage": "GA" + }, + "external_links": { + "launch_stage": "GA" + }, + "next_chunk_index": { + "description": "When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are no\nmore chunks. The next chunk can be fetched with a\n:method:statementexecution/getstatementresultchunkn request.", + "launch_stage": "GA" + }, + "next_chunk_internal_link": { + "description": "When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no more\nchunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and should be\ntreated as an opaque link. This is an alternative to using `next_chunk_index`.", + "launch_stage": "GA" + }, + "row_count": { + "description": "The number of rows within the result chunk.", + "launch_stage": "GA" + }, + "row_offset": { + "description": "The starting row offset within the result set.", + "launch_stage": "GA" + } + } + }, + "sql.ResultManifest": { + "description": "The result manifest provides schema and metadata for the result set.", + "fields": { + "chunks": { + "description": "Array of result set chunk metadata.", + "launch_stage": "GA" + }, + "format": { + "ref": "sql.Format", + "launch_stage": "GA" + }, + "schema": { + "ref": "sql.ResultSchema", + "launch_stage": "GA" + }, + "total_byte_count": { + "description": "The total number of bytes in the result set. This field is not available when using `INLINE`\ndisposition.", + "launch_stage": "GA" + }, + "total_chunk_count": { + "description": "The total number of chunks that the result set has been divided into.", + "launch_stage": "GA" + }, + "total_row_count": { + "description": "The total number of rows in the result set.", + "launch_stage": "GA" + }, + "truncated": { + "description": "Indicates whether the result is truncated due to `row_limit` or `byte_limit`.", + "launch_stage": "GA" + } + } + }, + "sql.ResultSchema": { + "description": "The schema is an ordered list of column descriptions.", + "fields": { + "column_count": { + "launch_stage": "GA" + }, + "columns": { + "launch_stage": "GA" + } + } + }, + "sql.RunAsMode": { + "enum": [ + "OWNER", + "VIEWER" + ], + "enum_launch_stages": { + "OWNER": "GA", + "VIEWER": "GA" + } + }, + "sql.RunAsRole": { + "enum": [ + "owner", + "viewer" + ], + "enum_launch_stages": { + "owner": "GA", + "viewer": "GA" + } + }, + "sql.SchedulePauseStatus": { + "enum": [ + "UNPAUSED", + "PAUSED" + ], + "enum_launch_stages": { + "PAUSED": "PUBLIC_PREVIEW", + "UNPAUSED": "PUBLIC_PREVIEW" + } + }, + "sql.ServiceError": { + "fields": { + "error_code": { + "ref": "sql.ServiceErrorCode", + "launch_stage": "GA" + }, + "message": { + "description": "A brief summary of the error condition.", + "launch_stage": "GA" + } + } + }, + "sql.ServiceErrorCode": { + "enum": [ + "UNKNOWN", + "INTERNAL_ERROR", + "TEMPORARILY_UNAVAILABLE", + "IO_ERROR", + "BAD_REQUEST", + "SERVICE_UNDER_MAINTENANCE", + "WORKSPACE_TEMPORARILY_UNAVAILABLE", + "DEADLINE_EXCEEDED", + "CANCELLED", + "RESOURCE_EXHAUSTED", + "ABORTED", + "NOT_FOUND", + "ALREADY_EXISTS", + "UNAUTHENTICATED" + ], + "enum_launch_stages": { + "ABORTED": "GA", + "ALREADY_EXISTS": "GA", + "BAD_REQUEST": "GA", + "CANCELLED": "GA", + "DEADLINE_EXCEEDED": "GA", + "INTERNAL_ERROR": "GA", + "IO_ERROR": "GA", + "NOT_FOUND": "GA", + "RESOURCE_EXHAUSTED": "GA", + "SERVICE_UNDER_MAINTENANCE": "GA", + "TEMPORARILY_UNAVAILABLE": "GA", + "UNAUTHENTICATED": "GA", + "UNKNOWN": "GA", + "WORKSPACE_TEMPORARILY_UNAVAILABLE": "GA" + } + }, + "sql.SetRequest": { + "description": "Set object ACL", + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "sql.SetResponse": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "description": "An object's type and UUID, separated by a forward slash (/) character.", + "launch_stage": "GA" + }, + "object_type": { + "description": "A singular noun object type.", + "ref": "sql.ObjectType", + "launch_stage": "GA" + } + } + }, + "sql.SetWorkspaceWarehouseConfigRequest": { + "description": "Sets the workspace level warehouse configuration that is shared by all SQL warehouses in this workspace.\n\nThis is idempotent.", + "fields": { + "channel": { + "description": "Optional: Channel selection details", + "ref": "sql.Channel", + "launch_stage": "GA" + }, + "config_param": { + "description": "Deprecated: Use sql_configuration_parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "deprecated": true, + "launch_stage": "GA" + }, + "data_access_config": { + "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "launch_stage": "GA" + }, + "enable_serverless_compute": { + "description": "Deprecated: only setting this to true is allowed.", + "deprecated": true, + "launch_stage": "GA" + }, + "enabled_warehouse_types": { + "description": "List of Warehouse Types allowed in this workspace (limits allowed value of\nthe type field in CreateWarehouse and EditWarehouse). Note: Some types\ncannot be disabled, they don't need to be specified\nin SetWorkspaceWarehouseConfig.\nNote: Disabling a type may cause existing warehouses to be converted to\nanother type. Used by frontend to save specific type availability in the\nwarehouse create and edit form UI.", + "launch_stage": "GA" + }, + "global_param": { + "description": "Deprecated: Use sql_configuration_parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "deprecated": true, + "launch_stage": "GA" + }, + "google_service_account": { + "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "launch_stage": "GA" + }, + "instance_profile_arn": { + "description": "AWS Only: The instance profile used to pass an IAM role to the SQL\nwarehouses. This configuration is also applied to the workspace's\nserverless compute for notebooks and jobs.", + "deprecated": true, + "launch_stage": "GA" + }, + "security_policy": { + "description": "Security policy for warehouses", + "ref": "sql.SetWorkspaceWarehouseConfigRequestSecurityPolicy", + "launch_stage": "GA" + }, + "sql_configuration_parameters": { + "description": "SQL configuration parameters", + "ref": "sql.RepeatedEndpointConfPairs", + "launch_stage": "GA" + } + } + }, + "sql.SetWorkspaceWarehouseConfigRequestSecurityPolicy": { + "description": "Security policy to be used for warehouses", + "enum": [ + "NONE", + "DATA_ACCESS_CONTROL", + "PASSTHROUGH" + ], + "enum_launch_stages": { + "DATA_ACCESS_CONTROL": "GA", + "NONE": "GA", + "PASSTHROUGH": "GA" + } + }, + "sql.SetWorkspaceWarehouseConfigResponse": {}, + "sql.SpotInstancePolicy": { + "description": "EndpointSpotInstancePolicy configures whether the endpoint should use spot\ninstances.\n\nThe breakdown of how the EndpointSpotInstancePolicy converts to per cloud\nconfigurations is:\n\n+-------+--------------------------------------+--------------------------------+\n| Cloud | COST_OPTIMIZED | RELIABILITY_OPTIMIZED |\n+-------+--------------------------------------+--------------------------------+\n| AWS | On Demand Driver with Spot Executors | On Demand Driver and\nExecutors | | AZURE | On Demand Driver and Executors | On Demand Driver\nand Executors |\n+-------+--------------------------------------+--------------------------------+\n\nWhile including \"spot\" in the enum name may limit the the future\nextensibility of this field because it limits this enum to denoting \"spot or\nnot\", this is the field that PM recommends after discussion with customers\nper SC-48783.", + "enum": [ + "POLICY_UNSPECIFIED", + "COST_OPTIMIZED", + "RELIABILITY_OPTIMIZED" + ], + "enum_launch_stages": { + "COST_OPTIMIZED": "GA", + "POLICY_UNSPECIFIED": "GA", + "RELIABILITY_OPTIMIZED": "GA" + } + }, + "sql.StartWarehouseResponse": {}, + "sql.State": { + "description": "*\nState of a warehouse.", + "enum": [ + "STARTING", + "RUNNING", + "STOPPING", + "STOPPED", + "DELETING", + "DELETED" + ], + "enum_launch_stages": { + "DELETED": "GA", + "DELETING": "GA", + "RUNNING": "GA", + "STARTING": "GA", + "STOPPED": "GA", + "STOPPING": "GA" + } + }, + "sql.StatementParameterListItem": { + "fields": { + "name": { + "description": "The name of a parameter marker to be substituted in the statement.", + "launch_stage": "GA" + }, + "type": { + "description": "The data type, given as a string. For example: `INT`, `STRING`, `DECIMAL(10,2)`.\nIf no type is given the type is assumed to be `STRING`. Complex types, such as\n`ARRAY`, `MAP`, and `STRUCT` are not supported. For valid types, refer to the\nsection [Data types](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.", + "launch_stage": "GA" + }, + "value": { + "description": "The value to substitute, represented as a string. If omitted, the value is interpreted as NULL.", + "launch_stage": "GA" + } + } + }, + "sql.StatementResponse": { + "fields": { + "manifest": { + "ref": "sql.ResultManifest", + "launch_stage": "GA" + }, + "result": { + "ref": "sql.ResultData", + "launch_stage": "GA" + }, + "statement_id": { + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "launch_stage": "GA" + }, + "status": { + "ref": "sql.StatementStatus", + "launch_stage": "GA" + } + } + }, + "sql.StatementState": { + "enum": [ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELED", + "CLOSED" + ], + "enum_launch_stages": { + "CANCELED": "GA", + "CLOSED": "GA", + "FAILED": "GA", + "PENDING": "GA", + "RUNNING": "GA", + "SUCCEEDED": "GA" + } + }, + "sql.StatementStatus": { + "description": "The status response includes execution state and if relevant, error information.", + "fields": { + "error": { + "ref": "sql.ServiceError", + "launch_stage": "GA" + }, + "sql_state": { + "description": "SQLSTATE error code returned when the statement execution fails.\nOnly populated when the statement status is `FAILED`.", + "launch_stage": "GA" + }, + "state": { + "description": "Statement execution state:\n- `PENDING`: waiting for warehouse\n- `RUNNING`: running\n- `SUCCEEDED`: execution was successful, result data available for fetch\n- `FAILED`: execution failed; reason for failure described in accompanying error message\n- `CANCELED`: user canceled; can come from explicit cancel call, or timeout with\n`on_wait_timeout=CANCEL`\n- `CLOSED`: execution successful, and statement closed; result no longer available for fetch", + "ref": "sql.StatementState", + "launch_stage": "GA" + } + } + }, + "sql.Status": { + "enum": [ + "HEALTHY", + "DEGRADED", + "FAILED" + ], + "enum_launch_stages": { + "DEGRADED": "GA", + "FAILED": "GA", + "HEALTHY": "GA" + } + }, + "sql.StopWarehouseResponse": {}, + "sql.Success": { + "fields": { + "message": { + "ref": "sql.SuccessMessage", + "launch_stage": "GA" + } + } + }, + "sql.SuccessMessage": { + "enum": [ + "Success" + ], + "enum_launch_stages": { + "Success": "GA" + } + }, + "sql.TaskTimeOverRange": { + "fields": { + "entries": { + "launch_stage": "GA" + }, + "interval": { + "description": "interval length for all entries (difference in start time and end time of an entry range)\nthe same for all entries\nstart time of first interval is query_start_time_ms", + "launch_stage": "GA" + } + } + }, + "sql.TaskTimeOverRangeEntry": { + "fields": { + "task_completed_time_ms": { + "description": "total task completion time in this time range, aggregated over all stages and jobs in the query", + "launch_stage": "GA" + } + } + }, + "sql.TerminationReason": { + "fields": { + "code": { + "description": "status code indicating why the cluster was terminated", + "ref": "sql.TerminationReasonCode", + "launch_stage": "GA" + }, + "parameters": { + "description": "list of parameters that provide additional information about why the cluster was terminated", + "launch_stage": "GA" + }, + "type": { + "description": "type of the termination", + "ref": "sql.TerminationReasonType", + "launch_stage": "GA" + } + } + }, + "sql.TerminationReasonCode": { + "description": "The status code indicating why the cluster was terminated", + "enum": [ + "UNKNOWN", + "USER_REQUEST", + "JOB_FINISHED", + "INACTIVITY", + "CLOUD_PROVIDER_SHUTDOWN", + "COMMUNICATION_LOST", + "CLOUD_PROVIDER_LAUNCH_FAILURE", + "INIT_SCRIPT_FAILURE", + "SPARK_STARTUP_FAILURE", + "INVALID_ARGUMENT", + "UNEXPECTED_LAUNCH_FAILURE", + "INTERNAL_ERROR", + "INSTANCE_UNREACHABLE", + "REQUEST_REJECTED", + "TRIAL_EXPIRED", + "DRIVER_UNREACHABLE", + "SPARK_ERROR", + "DRIVER_UNRESPONSIVE", + "METASTORE_COMPONENT_UNHEALTHY", + "DBFS_COMPONENT_UNHEALTHY", + "EXECUTION_COMPONENT_UNHEALTHY", + "AZURE_RESOURCE_MANAGER_THROTTLING", + "AZURE_RESOURCE_PROVIDER_THROTTLING", + "NETWORK_CONFIGURATION_FAILURE", + "CONTAINER_LAUNCH_FAILURE", + "INSTANCE_POOL_CLUSTER_FAILURE", + "SKIPPED_SLOW_NODES", + "ATTACH_PROJECT_FAILURE", + "UPDATE_INSTANCE_PROFILE_FAILURE", + "DATABASE_CONNECTION_FAILURE", + "REQUEST_THROTTLED", + "SELF_BOOTSTRAP_FAILURE", + "GLOBAL_INIT_SCRIPT_FAILURE", + "SLOW_IMAGE_DOWNLOAD", + "INVALID_SPARK_IMAGE", + "NPIP_TUNNEL_TOKEN_FAILURE", + "HIVE_METASTORE_PROVISIONING_FAILURE", + "AZURE_INVALID_DEPLOYMENT_TEMPLATE", + "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE", + "SUBNET_EXHAUSTED_FAILURE", + "BOOTSTRAP_TIMEOUT", + "STORAGE_DOWNLOAD_FAILURE", + "CONTROL_PLANE_REQUEST_FAILURE", + "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION", + "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE", + "DOCKER_IMAGE_PULL_FAILURE", + "AZURE_VNET_CONFIGURATION_FAILURE", + "NPIP_TUNNEL_SETUP_FAILURE", + "AWS_AUTHORIZATION_FAILURE", + "NEPHOS_RESOURCE_MANAGEMENT", + "STS_CLIENT_SETUP_FAILURE", + "SECURITY_DAEMON_REGISTRATION_EXCEPTION", + "AWS_REQUEST_LIMIT_EXCEEDED", + "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE", + "AWS_UNSUPPORTED_FAILURE", + "AZURE_QUOTA_EXCEEDED_EXCEPTION", + "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION", + "NFS_MOUNT_FAILURE", + "K8S_AUTOSCALING_FAILURE", + "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT", + "SPARK_IMAGE_DOWNLOAD_FAILURE", + "AZURE_VM_EXTENSION_FAILURE", + "WORKSPACE_CANCELLED_ERROR", + "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE", + "TEMPORARILY_UNAVAILABLE", + "WORKER_SETUP_FAILURE", + "IP_EXHAUSTION_FAILURE", + "GCP_QUOTA_EXCEEDED", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT", + "GCP_SERVICE_ACCOUNT_DELETED", + "AZURE_BYOK_KEY_PERMISSION_FAILURE", + "SPOT_INSTANCE_TERMINATION", + "AZURE_EPHEMERAL_DISK_FAILURE", + "ABUSE_DETECTED", + "IMAGE_PULL_PERMISSION_DENIED", + "WORKSPACE_CONFIGURATION_ERROR", + "SECRET_RESOLUTION_ERROR", + "UNSUPPORTED_INSTANCE_TYPE", + "CLOUD_PROVIDER_DISK_SETUP_FAILURE", + "SSH_BOOTSTRAP_FAILURE", + "AWS_INACCESSIBLE_KMS_KEY_FAILURE", + "INIT_CONTAINER_NOT_FINISHED", + "SPARK_IMAGE_DOWNLOAD_THROTTLED", + "SPARK_IMAGE_NOT_FOUND", + "CLUSTER_OPERATION_THROTTLED", + "CLUSTER_OPERATION_TIMEOUT", + "SERVERLESS_LONG_RUNNING_TERMINATED", + "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE", + "INVALID_WORKER_IMAGE_FAILURE", + "WORKSPACE_UPDATE", + "INVALID_AWS_PARAMETER", + "DRIVER_OUT_OF_DISK", + "DRIVER_OUT_OF_MEMORY", + "DRIVER_LAUNCH_TIMEOUT", + "DRIVER_UNEXPECTED_FAILURE", + "UNEXPECTED_POD_RECREATION", + "GCP_INACCESSIBLE_KMS_KEY_FAILURE", + "GCP_KMS_KEY_PERMISSION_DENIED", + "DRIVER_EVICTION", + "USER_INITIATED_VM_TERMINATION", + "GCP_IAM_TIMEOUT", + "AWS_RESOURCE_QUOTA_EXCEEDED", + "CLOUD_ACCOUNT_SETUP_FAILURE", + "AWS_INVALID_KEY_PAIR", + "DRIVER_POD_CREATION_FAILURE", + "MAINTENANCE_MODE", + "INTERNAL_CAPACITY_FAILURE", + "EXECUTOR_POD_UNSCHEDULED", + "STORAGE_DOWNLOAD_FAILURE_SLOW", + "STORAGE_DOWNLOAD_FAILURE_THROTTLED", + "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED", + "AWS_INSTANCE_PROFILE_UPDATE_FAILURE", + "INSTANCE_POOL_NOT_FOUND", + "INSTANCE_POOL_MAX_CAPACITY_REACHED", + "AWS_INVALID_KMS_KEY_STATE", + "GCP_INSUFFICIENT_CAPACITY", + "GCP_API_RATE_QUOTA_EXCEEDED", + "GCP_RESOURCE_QUOTA_EXCEEDED", + "GCP_IP_SPACE_EXHAUSTED", + "GCP_SERVICE_ACCOUNT_ACCESS_DENIED", + "GCP_SERVICE_ACCOUNT_NOT_FOUND", + "GCP_FORBIDDEN", + "GCP_NOT_FOUND", + "RESOURCE_USAGE_BLOCKED", + "DATA_ACCESS_CONFIG_CHANGED", + "ACCESS_TOKEN_FAILURE", + "INVALID_INSTANCE_PLACEMENT_PROTOCOL", + "BUDGET_POLICY_RESOLUTION_FAILURE", + "IN_PENALTY_BOX", + "DISASTER_RECOVERY_REPLICATION", + "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG", + "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG", + "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG", + "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG", + "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG", + "GCP_SUBNET_NOT_READY", + "CLOUD_OPERATION_CANCELLED", + "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED", + "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED", + "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED", + "EOS_SPARK_IMAGE", + "NO_MATCHED_K8S", + "LAZY_ALLOCATION_TIMEOUT", + "DRIVER_NODE_UNREACHABLE", + "SECRET_CREATION_FAILURE", + "POD_SCHEDULING_FAILURE", + "POD_ASSIGNMENT_FAILURE", + "ALLOCATION_TIMEOUT", + "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS", + "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS", + "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY", + "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS", + "NETVISOR_SETUP_TIMEOUT", + "NO_MATCHED_K8S_TESTING_TAG", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG", + "GKE_BASED_CLUSTER_TERMINATION", + "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS", + "DOCKER_INVALID_OS_EXCEPTION", + "DOCKER_CONTAINER_CREATION_EXCEPTION", + "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION", + "DNS_RESOLUTION_ERROR", + "GCP_DENIED_BY_ORG_POLICY", + "SECRET_PERMISSION_DENIED", + "NETWORK_CHECK_NIC_FAILURE", + "NETWORK_CHECK_DNS_SERVER_FAILURE", + "NETWORK_CHECK_STORAGE_FAILURE", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE", + "DRIVER_UNHEALTHY", + "USAGE_POLICY_ENTITLEMENT_DENIED", + "K8S_ACTIVE_POD_QUOTA_EXCEEDED", + "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED", + "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG", + "DBR_IMAGE_RESOLUTION_FAILURE", + "CONTROL_PLANE_CONNECTION_FAILURE", + "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG", + "RATE_LIMITED", + "MTLS_PORT_CONNECTIVITY_FAILURE", + "HIVEMETASTORE_CONNECTIVITY_FAILURE" + ], + "enum_launch_stages": { + "ABUSE_DETECTED": "GA", + "ACCESS_TOKEN_FAILURE": "GA", + "ALLOCATION_TIMEOUT": "GA", + "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY": "GA", + "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS": "GA", + "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS": "GA", + "ATTACH_PROJECT_FAILURE": "GA", + "AWS_AUTHORIZATION_FAILURE": "GA", + "AWS_INACCESSIBLE_KMS_KEY_FAILURE": "GA", + "AWS_INSTANCE_PROFILE_UPDATE_FAILURE": "GA", + "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE": "GA", + "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE": "GA", + "AWS_INVALID_KEY_PAIR": "GA", + "AWS_INVALID_KMS_KEY_STATE": "GA", + "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE": "GA", + "AWS_REQUEST_LIMIT_EXCEEDED": "GA", + "AWS_RESOURCE_QUOTA_EXCEEDED": "GA", + "AWS_UNSUPPORTED_FAILURE": "GA", + "AZURE_BYOK_KEY_PERMISSION_FAILURE": "GA", + "AZURE_EPHEMERAL_DISK_FAILURE": "GA", + "AZURE_INVALID_DEPLOYMENT_TEMPLATE": "GA", + "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION": "GA", + "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE": "GA", + "AZURE_QUOTA_EXCEEDED_EXCEPTION": "GA", + "AZURE_RESOURCE_MANAGER_THROTTLING": "GA", + "AZURE_RESOURCE_PROVIDER_THROTTLING": "GA", + "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE": "GA", + "AZURE_VM_EXTENSION_FAILURE": "GA", + "AZURE_VNET_CONFIGURATION_FAILURE": "GA", + "BOOTSTRAP_TIMEOUT": "GA", + "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION": "GA", + "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG": "GA", + "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED": "GA", + "BUDGET_POLICY_RESOLUTION_FAILURE": "GA", + "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED": "GA", + "CLOUD_ACCOUNT_SETUP_FAILURE": "GA", + "CLOUD_OPERATION_CANCELLED": "GA", + "CLOUD_PROVIDER_DISK_SETUP_FAILURE": "GA", + "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED": "GA", + "CLOUD_PROVIDER_LAUNCH_FAILURE": "GA", + "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG": "GA", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT": "GA", + "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG": "GA", + "CLOUD_PROVIDER_SHUTDOWN": "GA", + "CLUSTER_OPERATION_THROTTLED": "GA", + "CLUSTER_OPERATION_TIMEOUT": "GA", + "COMMUNICATION_LOST": "GA", + "CONTAINER_LAUNCH_FAILURE": "GA", + "CONTROL_PLANE_CONNECTION_FAILURE": "GA", + "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG": "GA", + "CONTROL_PLANE_REQUEST_FAILURE": "GA", + "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG": "GA", + "DATABASE_CONNECTION_FAILURE": "GA", + "DATA_ACCESS_CONFIG_CHANGED": "GA", + "DBFS_COMPONENT_UNHEALTHY": "GA", + "DBR_IMAGE_RESOLUTION_FAILURE": "GA", + "DISASTER_RECOVERY_REPLICATION": "GA", + "DNS_RESOLUTION_ERROR": "GA", + "DOCKER_CONTAINER_CREATION_EXCEPTION": "GA", + "DOCKER_IMAGE_PULL_FAILURE": "GA", + "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION": "GA", + "DOCKER_INVALID_OS_EXCEPTION": "GA", + "DRIVER_EVICTION": "GA", + "DRIVER_LAUNCH_TIMEOUT": "GA", + "DRIVER_NODE_UNREACHABLE": "GA", + "DRIVER_OUT_OF_DISK": "GA", + "DRIVER_OUT_OF_MEMORY": "GA", + "DRIVER_POD_CREATION_FAILURE": "GA", + "DRIVER_UNEXPECTED_FAILURE": "GA", + "DRIVER_UNHEALTHY": "GA", + "DRIVER_UNREACHABLE": "GA", + "DRIVER_UNRESPONSIVE": "GA", + "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED": "GA", + "EOS_SPARK_IMAGE": "GA", + "EXECUTION_COMPONENT_UNHEALTHY": "GA", + "EXECUTOR_POD_UNSCHEDULED": "GA", + "GCP_API_RATE_QUOTA_EXCEEDED": "GA", + "GCP_DENIED_BY_ORG_POLICY": "GA", + "GCP_FORBIDDEN": "GA", + "GCP_IAM_TIMEOUT": "GA", + "GCP_INACCESSIBLE_KMS_KEY_FAILURE": "GA", + "GCP_INSUFFICIENT_CAPACITY": "GA", + "GCP_IP_SPACE_EXHAUSTED": "GA", + "GCP_KMS_KEY_PERMISSION_DENIED": "GA", + "GCP_NOT_FOUND": "GA", + "GCP_QUOTA_EXCEEDED": "GA", + "GCP_RESOURCE_QUOTA_EXCEEDED": "GA", + "GCP_SERVICE_ACCOUNT_ACCESS_DENIED": "GA", + "GCP_SERVICE_ACCOUNT_DELETED": "GA", + "GCP_SERVICE_ACCOUNT_NOT_FOUND": "GA", + "GCP_SUBNET_NOT_READY": "GA", + "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED": "GA", + "GKE_BASED_CLUSTER_TERMINATION": "GA", + "GLOBAL_INIT_SCRIPT_FAILURE": "GA", + "HIVEMETASTORE_CONNECTIVITY_FAILURE": "GA", + "HIVE_METASTORE_PROVISIONING_FAILURE": "GA", + "IMAGE_PULL_PERMISSION_DENIED": "GA", + "INACTIVITY": "GA", + "INIT_CONTAINER_NOT_FINISHED": "GA", + "INIT_SCRIPT_FAILURE": "GA", + "INSTANCE_POOL_CLUSTER_FAILURE": "GA", + "INSTANCE_POOL_MAX_CAPACITY_REACHED": "GA", + "INSTANCE_POOL_NOT_FOUND": "GA", + "INSTANCE_UNREACHABLE": "GA", + "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG": "GA", + "INTERNAL_CAPACITY_FAILURE": "GA", + "INTERNAL_ERROR": "GA", + "INVALID_ARGUMENT": "GA", + "INVALID_AWS_PARAMETER": "GA", + "INVALID_INSTANCE_PLACEMENT_PROTOCOL": "GA", + "INVALID_SPARK_IMAGE": "GA", + "INVALID_WORKER_IMAGE_FAILURE": "GA", + "IN_PENALTY_BOX": "GA", + "IP_EXHAUSTION_FAILURE": "GA", + "JOB_FINISHED": "GA", + "K8S_ACTIVE_POD_QUOTA_EXCEEDED": "GA", + "K8S_AUTOSCALING_FAILURE": "GA", + "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT": "GA", + "LAZY_ALLOCATION_TIMEOUT": "GA", + "MAINTENANCE_MODE": "GA", + "METASTORE_COMPONENT_UNHEALTHY": "GA", + "MTLS_PORT_CONNECTIVITY_FAILURE": "GA", + "NEPHOS_RESOURCE_MANAGEMENT": "GA", + "NETVISOR_SETUP_TIMEOUT": "GA", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE": "GA", + "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_DNS_SERVER_FAILURE": "GA", + "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE": "GA", + "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE": "GA", + "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_NIC_FAILURE": "GA", + "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CHECK_STORAGE_FAILURE": "GA", + "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG": "GA", + "NETWORK_CONFIGURATION_FAILURE": "GA", + "NFS_MOUNT_FAILURE": "GA", + "NO_MATCHED_K8S": "GA", + "NO_MATCHED_K8S_TESTING_TAG": "GA", + "NPIP_TUNNEL_SETUP_FAILURE": "GA", + "NPIP_TUNNEL_TOKEN_FAILURE": "GA", + "POD_ASSIGNMENT_FAILURE": "GA", + "POD_SCHEDULING_FAILURE": "GA", + "RATE_LIMITED": "GA", + "REQUEST_REJECTED": "GA", + "REQUEST_THROTTLED": "GA", + "RESOURCE_USAGE_BLOCKED": "GA", + "SECRET_CREATION_FAILURE": "GA", + "SECRET_PERMISSION_DENIED": "GA", + "SECRET_RESOLUTION_ERROR": "GA", + "SECURITY_DAEMON_REGISTRATION_EXCEPTION": "GA", + "SELF_BOOTSTRAP_FAILURE": "GA", + "SERVERLESS_LONG_RUNNING_TERMINATED": "GA", + "SKIPPED_SLOW_NODES": "GA", + "SLOW_IMAGE_DOWNLOAD": "GA", + "SPARK_ERROR": "GA", + "SPARK_IMAGE_DOWNLOAD_FAILURE": "GA", + "SPARK_IMAGE_DOWNLOAD_THROTTLED": "GA", + "SPARK_IMAGE_NOT_FOUND": "GA", + "SPARK_STARTUP_FAILURE": "GA", + "SPOT_INSTANCE_TERMINATION": "GA", + "SSH_BOOTSTRAP_FAILURE": "GA", + "STORAGE_DOWNLOAD_FAILURE": "GA", + "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG": "GA", + "STORAGE_DOWNLOAD_FAILURE_SLOW": "GA", + "STORAGE_DOWNLOAD_FAILURE_THROTTLED": "GA", + "STS_CLIENT_SETUP_FAILURE": "GA", + "SUBNET_EXHAUSTED_FAILURE": "GA", + "TEMPORARILY_UNAVAILABLE": "GA", + "TRIAL_EXPIRED": "GA", + "UNEXPECTED_LAUNCH_FAILURE": "GA", + "UNEXPECTED_POD_RECREATION": "GA", + "UNKNOWN": "GA", + "UNSUPPORTED_INSTANCE_TYPE": "GA", + "UPDATE_INSTANCE_PROFILE_FAILURE": "GA", + "USAGE_POLICY_ENTITLEMENT_DENIED": "GA", + "USER_INITIATED_VM_TERMINATION": "GA", + "USER_REQUEST": "GA", + "WORKER_SETUP_FAILURE": "GA", + "WORKSPACE_CANCELLED_ERROR": "GA", + "WORKSPACE_CONFIGURATION_ERROR": "GA", + "WORKSPACE_UPDATE": "GA" + } + }, + "sql.TerminationReasonType": { + "description": "type of the termination", + "enum": [ + "SUCCESS", + "CLIENT_ERROR", + "SERVICE_FAULT", + "CLOUD_FAILURE" + ], + "enum_launch_stages": { + "CLIENT_ERROR": "GA", + "CLOUD_FAILURE": "GA", + "SERVICE_FAULT": "GA", + "SUCCESS": "GA" + } + }, + "sql.TextValue": { + "fields": { + "value": { + "launch_stage": "GA" + } + } + }, + "sql.TimeRange": { + "fields": { + "end_time_ms": { + "description": "The end time in milliseconds.", + "launch_stage": "GA" + }, + "start_time_ms": { + "description": "The start time in milliseconds.", + "launch_stage": "GA" + } + } + }, + "sql.TransferOwnershipObjectId": { + "fields": { + "new_owner": { + "description": "Email address for the new owner, who must exist in the workspace.", + "launch_stage": "GA" + } + } + }, + "sql.TransferOwnershipRequest": { + "fields": { + "new_owner": { + "description": "Email address for the new owner, who must exist in the workspace.", + "launch_stage": "GA" + } + } + }, + "sql.UpdateAlertRequest": { + "fields": { + "alert": { + "ref": "sql.UpdateAlertRequestAlert", + "launch_stage": "GA" + }, + "auto_resolve_display_name": { + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "sql.UpdateAlertRequestAlert": { + "fields": { + "condition": { + "description": "Trigger conditions of the alert.", + "ref": "sql.AlertCondition", + "launch_stage": "GA" + }, + "custom_body": { + "description": "Custom body of alert notification, if it exists. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "custom_subject": { + "description": "Custom subject of alert notification, if it exists. This can include email subject entries and Slack notification headers, for example. See [here](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "The display name of the alert.", + "launch_stage": "GA" + }, + "notify_on_ok": { + "description": "Whether to notify alert subscribers when alert returns back to normal.", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "launch_stage": "GA" + }, + "query_id": { + "description": "UUID of the query attached to the alert.", + "launch_stage": "GA" + }, + "seconds_to_retrigger": { + "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.", + "launch_stage": "GA" + } + } + }, + "sql.UpdateQueryRequest": { + "fields": { + "auto_resolve_display_name": { + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "launch_stage": "GA" + }, + "query": { + "ref": "sql.UpdateQueryRequestQuery", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "sql.UpdateQueryRequestQuery": { + "fields": { + "apply_auto_limit": { + "description": "Whether to apply a 1000 row limit to the query result.", + "launch_stage": "GA" + }, + "catalog": { + "description": "Name of the catalog where this query will be executed.", + "launch_stage": "GA" + }, + "description": { + "description": "General description that conveys additional information about this query such as usage notes.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the query that appears in list views, widget headings, and on the query page.", + "launch_stage": "GA" + }, + "owner_user_name": { + "description": "Username of the user that owns the query.", + "launch_stage": "GA" + }, + "parameters": { + "description": "List of query parameter definitions.", + "launch_stage": "GA" + }, + "query_text": { + "description": "Text of the query to be run.", + "launch_stage": "GA" + }, + "run_as_mode": { + "description": "Sets the \"Run as\" role for the object.", + "ref": "sql.RunAsMode", + "launch_stage": "GA" + }, + "schema": { + "description": "Name of the schema where this query will be executed.", + "launch_stage": "GA" + }, + "tags": { + "launch_stage": "GA" + }, + "warehouse_id": { + "description": "ID of the SQL warehouse attached to the query.", + "launch_stage": "GA" + } + } + }, + "sql.UpdateResponse": {}, + "sql.UpdateVisualizationRequest": { + "fields": { + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "visualization": { + "ref": "sql.UpdateVisualizationRequestVisualization", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.UpdateVisualizationRequestVisualization": { + "fields": { + "display_name": { + "description": "The display name of the visualization.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_options": { + "description": "The visualization options varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization options directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_query_plan": { + "description": "The visualization query plan varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying the visualization query plan directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "type": { + "description": "The type of visualization: counter, table, funnel, and so on.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.UpdateWidgetRequest": { + "fields": { + "dashboard_id": { + "description": "Dashboard ID returned by :method:dashboards/create.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "options": { + "ref": "sql.WidgetOptions", + "launch_stage": "PRIVATE_PREVIEW" + }, + "text": { + "description": "If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the `visualization` field.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "visualization_id": { + "description": "Query Vizualization ID returned by :method:queryvisualizations/create.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "width": { + "description": "Width of a widget", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.User": { + "fields": { + "email": { + "launch_stage": "GA" + }, + "id": { + "launch_stage": "GA" + }, + "name": { + "launch_stage": "GA" + } + } + }, + "sql.Visualization": { + "fields": { + "create_time": { + "description": "The timestamp indicating when the visualization was created.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "display_name": { + "description": "The display name of the visualization.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "id": { + "description": "UUID identifying the visualization.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "query_id": { + "description": "UUID of the query that the visualization is attached to.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_options": { + "description": "The visualization options varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization options directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serialized_query_plan": { + "description": "The visualization query plan varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying the visualization query plan directly.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "type": { + "description": "The type of visualization: counter, table, funnel, and so on.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_time": { + "description": "The timestamp indicating when the visualization was updated.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "sql.WarehouseAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "sql.WarehousePermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "sql.WarehouseAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "sql.WarehousePermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "sql.WarehousePermissionLevel", + "launch_stage": "GA" + } + } + }, + "sql.WarehousePermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "IS_OWNER", + "CAN_USE", + "CAN_MONITOR", + "CAN_VIEW" + ] + }, + "sql.WarehousePermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "sql.WarehousePermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "sql.WarehousePermissionLevel", + "launch_stage": "GA" + } + } + }, + "sql.WarehousePermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "sql.WarehouseTypePair": { + "description": "*\nConfiguration values to enable or disable the access to specific warehouse\ntypes in the workspace.", + "fields": { + "enabled": { + "description": "If set to false the specific warehouse type will not be be allowed as a\nvalue for warehouse_type in CreateWarehouse and EditWarehouse", + "launch_stage": "GA" + }, + "warehouse_type": { + "ref": "sql.WarehouseTypePairWarehouseType", + "launch_stage": "GA" + } + } + }, + "sql.WarehouseTypePairWarehouseType": { + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ], + "enum_launch_stages": { + "CLASSIC": "GA", + "PRO": "GA", + "TYPE_UNSPECIFIED": "GA" + } + }, + "sql.Widget": { + "fields": { + "id": { + "description": "The unique ID for this widget.", + "launch_stage": "GA" + }, + "options": { + "ref": "sql.WidgetOptions", + "launch_stage": "GA" + }, + "visualization": { + "description": "The visualization description API changes frequently and is unsupported. You can duplicate a visualization by copying description objects received _from the API_ and then using them to create a new one with a POST request to the same endpoint. Databricks does not recommend constructing ad-hoc visualizations entirely in JSON.", + "ref": "sql.LegacyVisualization", + "launch_stage": "GA" + }, + "width": { + "description": "Unused field.", + "launch_stage": "GA" + } + } + }, + "sql.WidgetOptions": { + "fields": { + "created_at": { + "description": "Timestamp when this object was created", + "launch_stage": "GA" + }, + "description": { + "description": "Custom description of the widget", + "launch_stage": "GA" + }, + "isHidden": { + "description": "Whether this widget is hidden on the dashboard.", + "launch_stage": "GA" + }, + "parameterMappings": { + "description": "How parameters used by the visualization in this widget relate to other widgets on the dashboard. Databricks does not recommend modifying this definition in JSON.", + "launch_stage": "GA" + }, + "position": { + "description": "Coordinates of this widget on a dashboard. This portion of the API changes frequently and is unsupported.", + "ref": "sql.WidgetPosition", + "launch_stage": "GA" + }, + "title": { + "description": "Custom title of the widget", + "launch_stage": "GA" + }, + "updated_at": { + "description": "Timestamp of the last time this object was updated.", + "launch_stage": "GA" + } + } + }, + "sql.WidgetPosition": { + "description": "Coordinates of this widget on a dashboard. This portion of the API changes frequently and is unsupported.", + "fields": { + "autoHeight": { + "description": "reserved for internal use", + "launch_stage": "GA" + }, + "col": { + "description": "column in the dashboard grid. Values start with 0", + "launch_stage": "GA" + }, + "row": { + "description": "row in the dashboard grid. Values start with 0", + "launch_stage": "GA" + }, + "sizeX": { + "description": "width of the widget measured in dashboard grid cells", + "launch_stage": "GA" + }, + "sizeY": { + "description": "height of the widget measured in dashboard grid cells", + "launch_stage": "GA" + } + } + }, + "sql.cancelExecutionRequest": {}, + "sql.startRequest": { + "description": "Starts a SQL warehouse.\nThis API is idempotent." + }, + "sql.stopRequest": { + "description": "Stops a SQL warehouse.\nThis API is idempotent." + }, + "supervisoragents.App": { + "description": "Databricks app. Supported app: custom mcp, custom agent.", + "fields": { + "name": { + "description": "App name", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "supervisoragents.Example": { + "description": "An example associated with a Supervisor Agent.\nContains a question and guidelines for how the agent should respond.", + "fields": { + "example_id": { + "description": "The universally unique identifier (UUID) of the example.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "guidelines": { + "description": "Guidelines for answering the question.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "name": { + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "launch_stage": "PUBLIC_BETA" + }, + "question": { + "description": "The example question.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "supervisoragents.GenieSpace": { + "fields": { + "id": { + "description": "Deprecated: use space_id instead. Still REQUIRED for backward compatibility\nuntil a future API version removes it.", + "deprecated": true, + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "supervisoragents.GetSupervisorAgentPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.KnowledgeAssistant": { + "fields": { + "knowledge_assistant_id": { + "description": "The ID of the knowledge assistant.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "serving_endpoint_name": { + "description": "Deprecated: use knowledge_assistant_id instead.", + "deprecated": true, + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "supervisoragents.ListExamplesResponse": { + "description": "A list of Supervisor Agent examples.", + "fields": { + "examples": { + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.ListSupervisorAgentsResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be sent as `page_token` to retrieve the next page.\nIf this field is omitted, there are no subsequent pages.", + "launch_stage": "PUBLIC_BETA" + }, + "supervisor_agents": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.ListToolsResponse": { + "fields": { + "next_page_token": { + "launch_stage": "PUBLIC_BETA" + }, + "tools": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgent": { + "fields": { + "create_time": { + "description": "Creation timestamp.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "creator": { + "description": "The creator of the Supervisor Agent.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "Description of what this agent can do (user-facing).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "display_name": { + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "endpoint_name": { + "description": "The name of the supervisor agent's serving endpoint.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "experiment_id": { + "description": "The MLflow experiment ID.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "id": { + "description": "Deprecated: Use supervisor_agent_id instead.", + "deprecated": true, + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "instructions": { + "description": "Optional natural-language instructions for the supervisor agent.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "launch_stage": "PUBLIC_BETA" + }, + "supervisor_agent_id": { + "description": "The universally unique identifier (UUID) of the Supervisor Agent.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "supervisoragents.SupervisorAgentAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "supervisoragents.SupervisorAgentPermissionLevel", + "launch_stage": "PUBLIC_BETA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "PUBLIC_BETA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgentAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "PUBLIC_BETA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "PUBLIC_BETA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "PUBLIC_BETA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "PUBLIC_BETA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgentPermission": { + "fields": { + "inherited": { + "launch_stage": "PUBLIC_BETA" + }, + "inherited_from_object": { + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "supervisoragents.SupervisorAgentPermissionLevel", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgentPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_QUERY" + ] + }, + "supervisoragents.SupervisorAgentPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_BETA" + }, + "object_id": { + "launch_stage": "PUBLIC_BETA" + }, + "object_type": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgentPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "PUBLIC_BETA" + }, + "permission_level": { + "ref": "supervisoragents.SupervisorAgentPermissionLevel", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.SupervisorAgentPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.Tool": { + "fields": { + "app": { + "ref": "supervisoragents.App", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "description": { + "description": "Description of what this tool does (user-facing).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "genie_space": { + "ref": "supervisoragents.GenieSpace", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "description": "Deprecated: Use tool_id instead.", + "deprecated": true, + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "knowledge_assistant": { + "ref": "supervisoragents.KnowledgeAssistant", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "name": { + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "launch_stage": "PUBLIC_BETA" + }, + "tool_id": { + "description": "User specified id of the Tool.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tool_type": { + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + }, + "uc_connection": { + "ref": "supervisoragents.UcConnection", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "uc_function": { + "ref": "supervisoragents.UcFunction", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "volume": { + "ref": "supervisoragents.Volume", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "supervisoragents.UcConnection": { + "description": "Databricks UC connection. Supported connection: external mcp server.", + "fields": { + "name": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "supervisoragents.UcFunction": { + "fields": { + "name": { + "description": "Full uc function name", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "supervisoragents.Volume": { + "fields": { + "name": { + "description": "Full uc volume name", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "tags.ListTagAssignmentsResponse": { + "fields": { + "next_page_token": { + "description": "Pagination token to request the next page of tag assignments", + "launch_stage": "PUBLIC_BETA" + }, + "tag_assignments": { + "launch_stage": "PUBLIC_BETA" + } + } + }, + "tags.ListTagPoliciesResponse": { + "fields": { + "next_page_token": { + "launch_stage": "GA" + }, + "tag_policies": { + "launch_stage": "GA" + } + } + }, + "tags.TagAssignment": { + "fields": { + "entity_id": { + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "entity_type": { + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "tag_key": { + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "tag_value": { + "description": "The value of the tag", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "tags.TagPolicy": { + "fields": { + "create_time": { + "description": "Timestamp when the tag policy was created", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "id": { + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tag_key": { + "launch_stage": "GA", + "behaviors": [ + "REQUIRED", + "IMMUTABLE" + ] + }, + "update_time": { + "description": "Timestamp when the tag policy was last updated", + "launch_stage": "GA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "values": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL", + "UNORDERED_LIST" + ] + } + } + }, + "tags.Value": { + "fields": { + "name": { + "launch_stage": "GA", + "behaviors": [ + "REQUIRED" + ] + } + } + }, + "vectorsearch.ColumnInfo": { + "fields": { + "name": { + "description": "Name of the column.", + "launch_stage": "GA" + }, + "type_text": { + "description": "Data type of the column (e.g., \"string\", \"int\", \"array\u003cfloat\u003e\")", + "launch_stage": "GA" + } + } + }, + "vectorsearch.CreateEndpoint": { + "fields": { + "budget_policy_id": { + "description": "The budget policy id to be applied", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "endpoint_type": { + "description": "Type of endpoint", + "ref": "vectorsearch.EndpointType", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the AI Search endpoint", + "launch_stage": "GA" + }, + "target_qps": { + "description": "Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "usage_policy_id": { + "description": "The usage policy id to be applied once we've migrated to usage policies", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "vectorsearch.CreateVectorIndexRequest": { + "fields": { + "delta_sync_index_spec": { + "description": "Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.", + "ref": "vectorsearch.DeltaSyncVectorIndexSpecRequest", + "launch_stage": "GA" + }, + "direct_access_index_spec": { + "description": "Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`.", + "ref": "vectorsearch.DirectAccessVectorIndexSpec", + "launch_stage": "GA" + }, + "endpoint_name": { + "description": "Name of the endpoint to be used for serving the index", + "launch_stage": "GA" + }, + "index_subtype": { + "description": "The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", + "ref": "vectorsearch.IndexSubtype", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "index_type": { + "ref": "vectorsearch.VectorIndexType", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the index", + "launch_stage": "GA" + }, + "primary_key": { + "description": "Primary key of the index", + "launch_stage": "GA" + } + } + }, + "vectorsearch.CustomTag": { + "fields": { + "key": { + "description": "Key field for an AI Search endpoint tag.", + "launch_stage": "GA" + }, + "value": { + "description": "[Optional] Value field for an AI Search endpoint tag.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.DeleteDataResult": { + "fields": { + "failed_primary_keys": { + "description": "List of primary keys for rows that failed to process.", + "launch_stage": "GA" + }, + "success_row_count": { + "description": "Count of successfully processed rows.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.DeleteDataStatus": { + "enum": [ + "SUCCESS", + "PARTIAL_SUCCESS", + "FAILURE" + ], + "enum_launch_stages": { + "FAILURE": "GA", + "PARTIAL_SUCCESS": "GA", + "SUCCESS": "GA" + } + }, + "vectorsearch.DeleteDataVectorIndexResponse": { + "fields": { + "result": { + "description": "Result of the upsert or delete operation.", + "ref": "vectorsearch.DeleteDataResult", + "launch_stage": "GA" + }, + "status": { + "description": "Status of the delete operation.", + "ref": "vectorsearch.DeleteDataStatus", + "launch_stage": "GA" + } + } + }, + "vectorsearch.DeleteEndpointResponse": {}, + "vectorsearch.DeleteIndexResponse": {}, + "vectorsearch.DeltaSyncVectorIndexSpecRequest": { + "fields": { + "columns_to_index": { + "description": "[Optional] Alias for columns_to_sync. Select the columns to include in the vector index.\nIf you leave this field blank, all columns from the source table are included.\nThe primary key column and embedding source column or embedding vector column are always included.\nOnly one of columns_to_sync or columns_to_index may be specified.", + "launch_stage": "GA" + }, + "columns_to_sync": { + "description": "[Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns\nfrom the source table are synced with the index. The primary key column and embedding source column or\nembedding vector column are always synced.", + "launch_stage": "GA" + }, + "embedding_source_columns": { + "description": "The columns that contain the embedding source.", + "launch_stage": "GA" + }, + "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors.", + "launch_stage": "GA" + }, + "embedding_writeback_table": { + "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", + "launch_stage": "GA" + }, + "pipeline_type": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", + "ref": "vectorsearch.PipelineType", + "launch_stage": "GA" + }, + "source_table": { + "description": "The name of the source table.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.DeltaSyncVectorIndexSpecResponse": { + "fields": { + "columns_to_index": { + "description": "[Optional] Alias for columns_to_sync. Select the columns to include in the vector index.\nIf you leave this field blank, all columns from the source table are included.\nThe primary key column and embedding source column or embedding vector column are always included.\nOnly one of columns_to_sync or columns_to_index may be specified.", + "launch_stage": "GA" + }, + "columns_to_sync": { + "description": "[Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns\nfrom the source table are synced with the index. The primary key column and embedding source column or\nembedding vector column are always synced.", + "launch_stage": "GA" + }, + "embedding_source_columns": { + "description": "The columns that contain the embedding source.", + "launch_stage": "GA" + }, + "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors.", + "launch_stage": "GA" + }, + "embedding_writeback_table": { + "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", + "launch_stage": "GA" + }, + "pipeline_id": { + "description": "The ID of the pipeline that is used to sync the index.", + "launch_stage": "GA" + }, + "pipeline_type": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", + "ref": "vectorsearch.PipelineType", + "launch_stage": "GA" + }, + "source_table": { + "description": "The name of the source table.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.DirectAccessVectorIndexSpec": { + "fields": { + "embedding_source_columns": { + "description": "The columns that contain the embedding source. The format should be array[double].", + "launch_stage": "GA" + }, + "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors. The format should be array[double].", + "launch_stage": "GA" + }, + "schema_json": { + "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.EmbeddingSourceColumn": { + "fields": { + "embedding_model_endpoint_name": { + "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", + "launch_stage": "GA" + }, + "model_endpoint_name_for_query": { + "description": "Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the column", + "launch_stage": "GA" + } + } + }, + "vectorsearch.EmbeddingVectorColumn": { + "fields": { + "embedding_dimension": { + "description": "Dimension of the embedding vector", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the column", + "launch_stage": "GA" + } + } + }, + "vectorsearch.EndpointInfo": { + "fields": { + "budget_policy_id": { + "description": "The user-selected budget policy id for the endpoint.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "creation_timestamp": { + "description": "Timestamp of endpoint creation", + "launch_stage": "GA" + }, + "creator": { + "description": "Creator of the endpoint", + "launch_stage": "GA" + }, + "custom_tags": { + "description": "The custom tags assigned to the endpoint", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "effective_budget_policy_id": { + "description": "The budget policy id applied to the endpoint", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "endpoint_status": { + "description": "Current status of the endpoint", + "ref": "vectorsearch.EndpointStatus", + "launch_stage": "GA" + }, + "endpoint_type": { + "description": "Type of endpoint", + "ref": "vectorsearch.EndpointType", + "launch_stage": "GA" + }, + "id": { + "description": "Unique identifier of the endpoint", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "Timestamp of last update to the endpoint", + "launch_stage": "GA" + }, + "last_updated_user": { + "description": "User who last updated the endpoint", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the AI Search endpoint", + "launch_stage": "GA" + }, + "num_indexes": { + "description": "Number of indexes on the endpoint", + "launch_stage": "GA" + }, + "scaling_info": { + "description": "Scaling information for the endpoint", + "ref": "vectorsearch.EndpointScalingInfo", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "vectorsearch.EndpointScalingInfo": { + "fields": { + "requested_target_qps": { + "description": "The requested QPS target for the endpoint. Best-effort; the system does not\nguarantee this QPS will be achieved.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "state": { + "description": "The current state of the scaling change request.", + "ref": "vectorsearch.ScalingChangeState", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "vectorsearch.EndpointStatus": { + "description": "Status information of an endpoint", + "fields": { + "message": { + "description": "Additional status message", + "launch_stage": "GA" + }, + "state": { + "description": "Current state of the endpoint", + "ref": "vectorsearch.EndpointStatusState", + "launch_stage": "GA" + } + } + }, + "vectorsearch.EndpointStatusState": { + "description": "Current state of the endpoint", + "enum": [ + "PROVISIONING", + "ONLINE", + "OFFLINE", + "RED_STATE", + "YELLOW_STATE", + "DELETED" + ], + "enum_launch_stages": { + "DELETED": "GA", + "OFFLINE": "GA", + "ONLINE": "GA", + "PROVISIONING": "GA", + "RED_STATE": "GA", + "YELLOW_STATE": "GA" + } + }, + "vectorsearch.EndpointType": { + "description": "Type of endpoint.", + "enum": [ + "STORAGE_OPTIMIZED", + "STANDARD" + ], + "enum_launch_stages": { + "STANDARD": "GA", + "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW" + } + }, + "vectorsearch.GetVectorSearchEndpointPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "vectorsearch.IndexSubtype": { + "description": "The subtype of the AI Search index, determining the indexing and retrieval strategy.\n- `VECTOR`: Not supported. Use `HYBRID` instead.\n- `FULL_TEXT`: An index that uses full-text search without vector embeddings.\n- `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.", + "enum": [ + "VECTOR", + "FULL_TEXT", + "HYBRID" + ], + "enum_launch_stages": { + "FULL_TEXT": "PUBLIC_BETA", + "HYBRID": "PUBLIC_BETA", + "VECTOR": "PUBLIC_BETA" + }, + "enum_descriptions": { + "FULL_TEXT": "An index that uses full-text search without vector embeddings.", + "HYBRID": "An index that uses vector embeddings for similarity search and hybrid search.", + "VECTOR": "Not supported. Use `HYBRID` instead." + } + }, + "vectorsearch.ListEndpointResponse": { + "fields": { + "endpoints": { + "description": "An array of Endpoint objects", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ListString": { + "launch_stage": "GA" + }, + "vectorsearch.ListValue": { + "fields": { + "values": { + "description": "Repeated field of dynamically typed values.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ListVectorIndexesResponse": { + "fields": { + "next_page_token": { + "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "launch_stage": "GA" + }, + "vector_indexes": { + "launch_stage": "GA" + } + } + }, + "vectorsearch.MapStringValueEntry": { + "description": "Key-value pair.", + "fields": { + "key": { + "description": "Column name.", + "launch_stage": "GA" + }, + "value": { + "description": "Column value, nullable.", + "ref": "vectorsearch.Value", + "launch_stage": "GA" + } + } + }, + "vectorsearch.Metric": { + "description": "Metric specification", + "fields": { + "labels": { + "description": "Metric labels", + "launch_stage": "GA" + }, + "name": { + "description": "Metric name", + "launch_stage": "GA" + }, + "percentile": { + "description": "Percentile for the metric", + "launch_stage": "GA" + } + } + }, + "vectorsearch.MetricLabel": { + "description": "Label for a metric", + "fields": { + "name": { + "description": "Label name", + "launch_stage": "GA" + }, + "value": { + "description": "Label value", + "launch_stage": "GA" + } + } + }, + "vectorsearch.MetricValue": { + "description": "Single metric value at a specific timestamp", + "fields": { + "timestamp": { + "description": "Timestamp of the metric value (milliseconds since epoch)", + "launch_stage": "GA" + }, + "value": { + "description": "Metric value", + "launch_stage": "GA" + } + } + }, + "vectorsearch.MetricValues": { + "description": "Collection of metric values for a specific metric", + "fields": { + "metric": { + "description": "Metric specification", + "ref": "vectorsearch.Metric", + "launch_stage": "GA" + }, + "values": { + "description": "Time series of metric values", + "launch_stage": "GA" + } + } + }, + "vectorsearch.MiniVectorIndex": { + "fields": { + "creator": { + "description": "The user who created the index.", + "launch_stage": "GA" + }, + "endpoint_name": { + "description": "Name of the endpoint associated with the index", + "launch_stage": "GA" + }, + "index_subtype": { + "description": "The subtype of the index.", + "ref": "vectorsearch.IndexSubtype", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "index_type": { + "ref": "vectorsearch.VectorIndexType", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the index", + "launch_stage": "GA" + }, + "primary_key": { + "description": "Primary key of the index", + "launch_stage": "GA" + } + } + }, + "vectorsearch.PatchEndpointBudgetPolicyRequest": { + "fields": { + "budget_policy_id": { + "description": "The budget policy id to be applied", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "vectorsearch.PatchEndpointBudgetPolicyResponse": { + "fields": { + "budget_policy_id": { + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "effective_budget_policy_id": { + "description": "The budget policy applied to the AI Search endpoint.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "vectorsearch.PatchEndpointRequest": { + "fields": { + "target_qps": { + "description": "Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS\nwill be achieved.", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "vectorsearch.PipelineType": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", + "enum": [ + "TRIGGERED", + "CONTINUOUS" + ], + "enum_launch_stages": { + "CONTINUOUS": "GA", + "TRIGGERED": "GA" + }, + "enum_descriptions": { + "CONTINUOUS": "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", + "TRIGGERED": "If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started." + } + }, + "vectorsearch.QueryVectorIndexNextPageRequest": { + "description": "Request payload for getting next page of results.", + "fields": { + "endpoint_name": { + "description": "Name of the endpoint.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Page token returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` API.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.QueryVectorIndexRequest": { + "fields": { + "columns": { + "description": "List of column names to include in the response.", + "launch_stage": "GA" + }, + "columns_to_rerank": { + "description": "Column names used to retrieve data to send to the reranker.", + "preview": "PRIVATE", + "launch_stage": "PRIVATE_PREVIEW" + }, + "filters_json": { + "description": "JSON string representing query filters.\n\nExample filters:\n\n- `{\"id \u003c\": 5}`: Filter for id less than 5.\n- `{\"id \u003e\": 5}`: Filter for id greater than 5.\n- `{\"id \u003c=\": 5}`: Filter for id less than equal to 5.\n- `{\"id \u003e=\": 5}`: Filter for id greater than equal to 5.\n- `{\"id\": 5}`: Filter for id equal to 5.", + "launch_stage": "GA" + }, + "num_results": { + "description": "Number of results to return. Defaults to 10.", + "launch_stage": "GA" + }, + "query_text": { + "description": "Query text. Required for Delta Sync Index using model endpoint.", + "launch_stage": "GA" + }, + "query_type": { + "description": "The query type to use. Choices are `ANN` and `HYBRID` and `FULL_TEXT`. Defaults to `ANN`.", + "launch_stage": "GA" + }, + "query_vector": { + "description": "Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.", + "launch_stage": "GA" + }, + "reranker": { + "description": "If set, the top 50 results are reranked with the Databricks Reranker model before returning the `num_results` results to the user.\nThe setting `columns_to_rerank` selects which columns are used for reranking. For each datapoint, the columns selected are concatenated before\nbeing sent to the reranking model. See https://docs.databricks.com/aws/en/vector-search/query-vector-search#rerank for more information.", + "ref": "vectorsearch.RerankerConfig", + "launch_stage": "GA" + }, + "score_threshold": { + "description": "Threshold for the approximate nearest neighbor search. Defaults to 0.0.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.QueryVectorIndexResponse": { + "fields": { + "manifest": { + "description": "Metadata about the result set.", + "ref": "vectorsearch.ResultManifest", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "[Optional] Token that can be used in `QueryVectorIndexNextPage` API to get next page of results.\nIf more than 1000 results satisfy the query, they are returned in groups of 1000.\nEmpty value means no more results. The maximum number of results that can be returned is 10,000.", + "launch_stage": "GA" + }, + "result": { + "description": "Data returned in the query result.", + "ref": "vectorsearch.ResultData", + "launch_stage": "GA" + } + } + }, + "vectorsearch.RerankerConfig": { + "fields": { + "model": { + "description": "Reranker identifier:\n- When model_type=BASE/UNSPECIFIED: must be \"databricks_reranker\".\n- When model_type=FINETUNED: the Model Serving endpoint name hosting a finetuned reranker.", + "launch_stage": "GA" + }, + "parameters": { + "description": "Parameters that control how the reranker processes the query results.", + "ref": "vectorsearch.RerankerConfigRerankerParameters", + "launch_stage": "GA" + } + } + }, + "vectorsearch.RerankerConfigRerankerParameters": { + "fields": { + "columns_to_rerank": { + "launch_stage": "GA" + } + } + }, + "vectorsearch.ResultData": { + "description": "Data returned in the query result.", + "fields": { + "data_array": { + "description": "Data rows returned in the query.", + "launch_stage": "GA" + }, + "row_count": { + "description": "Number of rows in the result set.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ResultManifest": { + "description": "Metadata about the result set.", + "fields": { + "column_count": { + "description": "Number of columns in the result set.", + "launch_stage": "GA" + }, + "columns": { + "description": "Information about each column in the result set.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.RetrieveUserVisibleMetricsRequest": { + "description": "Request to retrieve user-visible metrics", + "fields": { + "end_time": { + "description": "End time for metrics query", + "launch_stage": "GA" + }, + "granularity_in_seconds": { + "description": "Granularity in seconds", + "launch_stage": "GA" + }, + "metrics": { + "description": "List of metrics to retrieve", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token for pagination", + "launch_stage": "GA" + }, + "start_time": { + "description": "Start time for metrics query", + "launch_stage": "GA" + } + } + }, + "vectorsearch.RetrieveUserVisibleMetricsResponse": { + "description": "Response containing user-visible metrics", + "fields": { + "metric_values": { + "description": "Collection of metric values", + "launch_stage": "GA" + }, + "next_page_token": { + "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ScalingChangeState": { + "enum": [ + "SCALING_CHANGE_UNSPECIFIED", + "SCALING_CHANGE_APPLIED", + "SCALING_CHANGE_IN_PROGRESS" + ], + "enum_launch_stages": { + "SCALING_CHANGE_APPLIED": "PUBLIC_BETA", + "SCALING_CHANGE_IN_PROGRESS": "PUBLIC_BETA", + "SCALING_CHANGE_UNSPECIFIED": "PUBLIC_BETA" + } + }, + "vectorsearch.ScanVectorIndexRequest": { + "fields": { + "last_primary_key": { + "description": "Primary key of the last entry returned in the previous scan.", + "launch_stage": "GA" + }, + "num_results": { + "description": "Number of results to return. Defaults to 10.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ScanVectorIndexResponse": { + "description": "Response to a scan vector index request.", + "fields": { + "data": { + "description": "List of data entries", + "launch_stage": "GA" + }, + "last_primary_key": { + "description": "Primary key of the last entry.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.Struct": { + "fields": { + "fields": { + "description": "Data entry, corresponding to a row in a vector index.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.SyncIndexResponse": {}, + "vectorsearch.UpdateEndpointCustomTagsRequest": { + "fields": { + "custom_tags": { + "description": "The new custom tags for the AI Search endpoint", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "vectorsearch.UpdateEndpointCustomTagsResponse": { + "fields": { + "custom_tags": { + "description": "All the custom tags that are applied to the AI Search endpoint.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "name": { + "description": "The name of the AI Search endpoint whose custom tags were updated.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "vectorsearch.UpsertDataResult": { + "fields": { + "failed_primary_keys": { + "description": "List of primary keys for rows that failed to process.", + "launch_stage": "GA" + }, + "success_row_count": { + "description": "Count of successfully processed rows.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.UpsertDataStatus": { + "enum": [ + "SUCCESS", + "PARTIAL_SUCCESS", + "FAILURE" + ], + "enum_launch_stages": { + "FAILURE": "GA", + "PARTIAL_SUCCESS": "GA", + "SUCCESS": "GA" + } + }, + "vectorsearch.UpsertDataVectorIndexRequest": { + "fields": { + "inputs_json": { + "description": "JSON string representing the data to be upserted.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.UpsertDataVectorIndexResponse": { + "fields": { + "result": { + "description": "Result of the upsert or delete operation.", + "ref": "vectorsearch.UpsertDataResult", + "launch_stage": "GA" + }, + "status": { + "description": "Status of the upsert operation.", + "ref": "vectorsearch.UpsertDataStatus", + "launch_stage": "GA" + } + } + }, + "vectorsearch.Value": { + "fields": { + "bool_value": { + "launch_stage": "GA" + }, + "list_value": { + "ref": "vectorsearch.ListValue", + "launch_stage": "GA" + }, + "number_value": { + "launch_stage": "GA" + }, + "string_value": { + "launch_stage": "GA" + }, + "struct_value": { + "ref": "vectorsearch.Struct", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorIndex": { + "fields": { + "creator": { + "description": "The user who created the index.", + "launch_stage": "GA" + }, + "delta_sync_index_spec": { + "ref": "vectorsearch.DeltaSyncVectorIndexSpecResponse", + "launch_stage": "GA" + }, + "direct_access_index_spec": { + "ref": "vectorsearch.DirectAccessVectorIndexSpec", + "launch_stage": "GA" + }, + "endpoint_name": { + "description": "Name of the endpoint associated with the index", + "launch_stage": "GA" + }, + "index_subtype": { + "description": "The subtype of the index.", + "ref": "vectorsearch.IndexSubtype", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_BETA" + }, + "index_type": { + "ref": "vectorsearch.VectorIndexType", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the index", + "launch_stage": "GA" + }, + "primary_key": { + "description": "Primary key of the index", + "launch_stage": "GA" + }, + "status": { + "ref": "vectorsearch.VectorIndexStatus", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorIndexStatus": { + "fields": { + "index_url": { + "description": "Index API Url to be used to perform operations on the index", + "launch_stage": "GA" + }, + "indexed_row_count": { + "description": "Number of rows indexed", + "launch_stage": "GA" + }, + "message": { + "description": "Message associated with the index status", + "launch_stage": "GA" + }, + "ready": { + "description": "Whether the index is ready for search", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorIndexType": { + "description": "There are 2 types of AI Search indexes:\n- `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.\n- `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.", + "enum": [ + "DELTA_SYNC", + "DIRECT_ACCESS" + ], + "enum_launch_stages": { + "DELTA_SYNC": "GA", + "DIRECT_ACCESS": "GA" + }, + "enum_descriptions": { + "DELTA_SYNC": "An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.", + "DIRECT_ACCESS": "An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates." + } + }, + "vectorsearch.VectorSearchEndpointAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "vectorsearch.VectorSearchEndpointPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorSearchEndpointAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorSearchEndpointPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "vectorsearch.VectorSearchEndpointPermissionLevel", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorSearchEndpointPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_CREATE", + "CAN_MANAGE", + "CAN_USE" + ] + }, + "vectorsearch.VectorSearchEndpointPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorSearchEndpointPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "vectorsearch.VectorSearchEndpointPermissionLevel", + "launch_stage": "GA" + } + } + }, + "vectorsearch.VectorSearchEndpointPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "vectorsearch.syncIndexRequest": {}, + "workspace.AclItem": { + "description": "An item representing an ACL rule applied to the given principal (user or group)\non the associated scope point.", + "fields": { + "permission": { + "description": "The permission level applied to the principal.", + "ref": "workspace.AclPermission", + "launch_stage": "GA" + }, + "principal": { + "description": "The principal in which the permission is applied.", + "launch_stage": "GA" + } + } + }, + "workspace.AclPermission": { + "description": "The ACL permission levels for Secret ACLs applied to secret scopes.", + "enum": [ + "READ", + "WRITE", + "MANAGE" + ], + "enum_launch_stages": { + "MANAGE": "GA", + "READ": "GA", + "WRITE": "GA" + } + }, + "workspace.AzureKeyVaultSecretScopeMetadata": { + "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", + "fields": { + "dns_name": { + "description": "The DNS of the KeyVault", + "launch_stage": "GA" + }, + "resource_id": { + "description": "The resource id of the azure KeyVault that user wants to associate the scope with.", + "launch_stage": "GA" + } + } + }, + "workspace.CreateCredentialsRequest": { + "fields": { + "git_email": { + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "launch_stage": "GA" + }, + "git_provider": { + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "launch_stage": "GA" + }, + "git_username": { + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "launch_stage": "GA" + }, + "is_default_for_provider": { + "description": "if the credential is the default for the given provider", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "the name of the git credential, used for identification and ease of lookup", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "personal_access_token": { + "description": "The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).", + "launch_stage": "GA" + }, + "principal_id": { + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "launch_stage": "GA" + } + } + }, + "workspace.CreateCredentialsResponse": { + "fields": { + "credential_id": { + "description": "ID of the credential object in the workspace.", + "launch_stage": "GA" + }, + "git_email": { + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "launch_stage": "GA" + }, + "git_provider": { + "description": "The Git provider associated with the credential.", + "launch_stage": "GA" + }, + "git_username": { + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "launch_stage": "GA" + }, + "is_default_for_provider": { + "description": "if the credential is the default for the given provider", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "the name of the git credential, used for identification and ease of lookup", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "workspace.CreateRepoRequest": { + "fields": { + "path": { + "description": "Desired path for the repo in the workspace. Almost any path in the workspace can be chosen.\nIf repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`.", + "launch_stage": "GA" + }, + "provider": { + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "launch_stage": "GA" + }, + "sparse_checkout": { + "description": "If specified, the repo will be created with sparse checkout enabled. You cannot enable/disable\nsparse checkout after the repo is created.", + "ref": "workspace.SparseCheckout", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the Git repository to be linked.", + "launch_stage": "GA" + } + } + }, + "workspace.CreateRepoResponse": { + "fields": { + "branch": { + "description": "Branch that the Git folder (repo) is checked out to.", + "launch_stage": "GA" + }, + "head_commit_id": { + "description": "SHA-1 hash representing the commit ID of the current HEAD of the Git folder (repo).", + "launch_stage": "GA" + }, + "id": { + "description": "ID of the Git folder (repo) object in the workspace.", + "launch_stage": "GA" + }, + "path": { + "description": "Path of the Git folder (repo) in the workspace.", + "launch_stage": "GA" + }, + "provider": { + "description": "Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`,\n`bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab\nSelf-Managed), or `awsCodeCommit` (deprecated).", + "launch_stage": "GA" + }, + "sparse_checkout": { + "description": "Sparse checkout settings for the Git folder (repo).", + "ref": "workspace.SparseCheckout", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the linked Git repository.", + "launch_stage": "GA" + } + } + }, + "workspace.CreateScope": { + "fields": { + "backend_azure_keyvault": { + "description": "The metadata for the secret scope if the type is ``AZURE_KEYVAULT``", + "ref": "workspace.AzureKeyVaultSecretScopeMetadata", + "launch_stage": "GA" + }, + "initial_manage_principal": { + "description": "The principal that is initially granted ``MANAGE`` permission to the created scope.", + "launch_stage": "GA" + }, + "scope": { + "description": "Scope name requested by the user. Scope names are unique.", + "launch_stage": "GA" + }, + "scope_backend_type": { + "description": "The backend type the scope will be created with. If not specified, will default to ``DATABRICKS``", + "ref": "workspace.ScopeBackendType", + "launch_stage": "GA" + } + } + }, + "workspace.CredentialInfo": { + "fields": { + "credential_id": { + "description": "ID of the credential object in the workspace.", + "launch_stage": "GA" + }, + "git_email": { + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "launch_stage": "GA" + }, + "git_provider": { + "description": "The Git provider associated with the credential. One of `gitHub`, `bitbucketCloud`,\n`gitLab`, `azureDevOpsServices` (Azure DevOps Services, including Microsoft Entra ID\nauthentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket Data Center),\n`gitLabEnterpriseEdition` (GitLab Self-Managed), or `awsCodeCommit` (deprecated).", + "launch_stage": "GA" + }, + "git_username": { + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "launch_stage": "GA" + }, + "is_default_for_provider": { + "description": "if the credential is the default for the given provider", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "the name of the git credential, used for identification and ease of lookup", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "workspace.Delete": { + "fields": { + "path": { + "description": "The absolute path of the notebook or directory.", + "launch_stage": "GA" + }, + "recursive": { + "description": "The flag that specifies whether to delete the object recursively. It is `false` by default.\nPlease note this deleting directory is not atomic. If it fails in the middle, some of objects\nunder this directory may be deleted and cannot be undone.", + "launch_stage": "GA" + } + } + }, + "workspace.DeleteAcl": { + "fields": { + "principal": { + "description": "The principal to remove an existing ACL from.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope to remove permissions from.", + "launch_stage": "GA" + } + } + }, + "workspace.DeleteCredentialsResponse": {}, + "workspace.DeleteRepoResponse": {}, + "workspace.DeleteResponse": {}, + "workspace.DeleteScope": { + "fields": { + "scope": { + "description": "Name of the scope to delete.", + "launch_stage": "GA" + } + } + }, + "workspace.DeleteSecret": { + "fields": { + "key": { + "description": "Name of the secret to delete.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope that contains the secret to delete.", + "launch_stage": "GA" + } + } + }, + "workspace.DeleteSecretResponse": {}, + "workspace.ExportResponse": { + "description": "The request field `direct_download` determines whether a JSON response or binary contents are returned by this endpoint.", + "fields": { + "content": { + "description": "The base64-encoded content.\nIf the limit (10MB) is exceeded, exception with error code **MAX_NOTEBOOK_SIZE_EXCEEDED** is thrown.", + "launch_stage": "GA" + }, + "file_type": { + "description": "The file type of the exported file.", + "launch_stage": "GA" + } + } + }, + "workspace.GetCredentialsResponse": { + "fields": { + "credential_id": { + "description": "ID of the credential object in the workspace.", + "launch_stage": "GA" + }, + "git_email": { + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "launch_stage": "GA" + }, + "git_provider": { + "description": "The Git provider associated with the credential.", + "launch_stage": "GA" + }, + "git_username": { + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "launch_stage": "GA" + }, + "is_default_for_provider": { + "description": "if the credential is the default for the given provider", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "the name of the git credential, used for identification and ease of lookup", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "workspace.GetRepoPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "workspace.GetRepoResponse": { + "fields": { + "branch": { + "description": "Branch that the local version of the repo is checked out to.", + "launch_stage": "GA" + }, + "head_commit_id": { + "description": "SHA-1 hash representing the commit ID of the current HEAD of the repo.", + "launch_stage": "GA" + }, + "id": { + "description": "ID of the Git folder (repo) object in the workspace.", + "launch_stage": "GA" + }, + "path": { + "description": "Path of the Git folder (repo) in the workspace.", + "launch_stage": "GA" + }, + "provider": { + "description": "Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`,\n`bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab\nSelf-Managed), or `awsCodeCommit` (deprecated).", + "launch_stage": "GA" + }, + "sparse_checkout": { + "description": "Sparse checkout settings for the Git folder (repo).", + "ref": "workspace.SparseCheckout", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the linked Git repository.", + "launch_stage": "GA" + } + } + }, + "workspace.GetSecretResponse": { + "fields": { + "key": { + "description": "A unique name to identify the secret.", + "launch_stage": "GA" + }, + "value": { + "description": "The value of the secret in its byte representation.", + "launch_stage": "GA" + } + } + }, + "workspace.GetWorkspaceObjectPermissionLevelsResponse": { + "fields": { + "permission_levels": { + "description": "Specific permission levels", + "launch_stage": "GA" + } + } + }, + "workspace.Import": { + "fields": { + "content": { + "description": "The base64-encoded content. This has a limit of 10 MB.\n\nIf the limit (10MB) is exceeded, exception with error code **MAX_NOTEBOOK_SIZE_EXCEEDED** is thrown.\nThis parameter might be absent, and instead a posted file is used.", + "launch_stage": "GA" + }, + "format": { + "description": "This specifies the format of the file to be imported.\n\nThe value is case sensitive.\n\n- `AUTO`: The item is imported depending on an analysis of the item's extension and\nthe header content provided in the request. If the item is imported as a notebook,\nthen the item's extension is automatically removed.\n- `SOURCE`: The notebook or directory is imported as source code.\n- `HTML`: The notebook is imported as an HTML file.\n- `JUPYTER`: The notebook is imported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is imported in Databricks archive format. Required for directories.\n- `R_MARKDOWN`: The notebook is imported from R Markdown format.", + "ref": "workspace.ImportFormat", + "launch_stage": "GA" + }, + "language": { + "description": "The language of the object. This value is set only if the object type is `NOTEBOOK`.", + "ref": "workspace.Language", + "launch_stage": "GA" + }, + "overwrite": { + "description": "The flag that specifies whether to overwrite existing object. It is `false` by default.\nFor `DBC` format, `overwrite` is not supported since it may contain a directory.", + "launch_stage": "GA" + }, + "path": { + "description": "The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.", + "launch_stage": "GA" + } + } + }, + "workspace.ImportFormat": { + "description": "The format for workspace import and export.", + "enum": [ + "SOURCE", + "HTML", + "JUPYTER", + "DBC", + "R_MARKDOWN", + "AUTO", + "RAW" + ], + "enum_launch_stages": { + "AUTO": "GA", + "DBC": "GA", + "HTML": "GA", + "JUPYTER": "GA", + "RAW": "GA", + "R_MARKDOWN": "GA", + "SOURCE": "GA" + } + }, + "workspace.ImportResponse": {}, + "workspace.Language": { + "description": "The language of notebook.", + "enum": [ + "SCALA", + "PYTHON", + "SQL", + "R" + ], + "enum_launch_stages": { + "PYTHON": "GA", + "R": "GA", + "SCALA": "GA", + "SQL": "GA" + } + }, + "workspace.ListAclsResponse": { + "fields": { + "items": { + "description": "The associated ACLs rule applied to principals in the given scope.", + "launch_stage": "GA" + } + } + }, + "workspace.ListCredentialsResponse": { + "fields": { + "credentials": { + "description": "List of credentials.", + "launch_stage": "GA" + } + } + }, + "workspace.ListReposResponse": { + "fields": { + "next_page_token": { + "description": "Token that can be specified as a query parameter to the `GET /repos` endpoint to retrieve\nthe next page of results.", + "launch_stage": "GA" + }, + "repos": { + "description": "List of Git folders (repos).", + "launch_stage": "GA" + } + } + }, + "workspace.ListResponse": { + "fields": { + "objects": { + "description": "List of objects.", + "launch_stage": "GA" + } + } + }, + "workspace.ListScopesResponse": { + "fields": { + "scopes": { + "description": "The available secret scopes.", + "launch_stage": "GA" + } + } + }, + "workspace.ListSecretsResponse": { + "fields": { + "secrets": { + "description": "Metadata information of all secrets contained within the given scope.", + "launch_stage": "GA" + } + } + }, + "workspace.Mkdirs": { + "fields": { + "path": { + "description": "The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.", + "launch_stage": "GA" + } + } + }, + "workspace.MkdirsResponse": {}, + "workspace.ObjectInfo": { + "description": "The information of the object in workspace. It will be returned by ``list`` and ``get-status``.", + "fields": { + "created_at": { + "description": "Only applicable to files. The creation UTC timestamp.", + "launch_stage": "GA" + }, + "language": { + "description": "The language of the object. This value is set only if the object type is ``NOTEBOOK``. For Jupyter (.ipynb) notebooks, this is always ``PYTHON``.", + "ref": "workspace.Language", + "launch_stage": "GA" + }, + "modified_at": { + "description": "Only applicable to files, the last modified UTC timestamp.", + "launch_stage": "GA" + }, + "object_id": { + "description": "Unique identifier for the object.", + "launch_stage": "GA" + }, + "object_type": { + "description": "The type of the object in workspace.\n\n- `NOTEBOOK`: document that contains runnable code, visualizations, and explanatory text.\n- `DIRECTORY`: directory\n- `LIBRARY`: library\n- `FILE`: file\n- `REPO`: repository\n- `DASHBOARD`: Lakeview dashboard", + "ref": "workspace.ObjectType", + "launch_stage": "GA" + }, + "path": { + "description": "The absolute path of the object.", + "launch_stage": "GA" + }, + "resource_id": { + "description": "A unique identifier for the object that is consistent across all Databricks APIs.", + "launch_stage": "GA" + }, + "size": { + "description": "Only applicable to files. The file size in bytes can be returned.", + "launch_stage": "GA" + } + } + }, + "workspace.ObjectType": { + "description": "The type of the object in workspace.", + "enum": [ + "NOTEBOOK", + "DIRECTORY", + "LIBRARY", + "FILE", + "REPO", + "DASHBOARD" + ], + "enum_launch_stages": { + "DASHBOARD": "GA", + "DIRECTORY": "GA", + "FILE": "GA", + "LIBRARY": "GA", + "NOTEBOOK": "GA", + "REPO": "GA" + } + }, + "workspace.PutAcl": { + "fields": { + "permission": { + "description": "The permission level applied to the principal.", + "ref": "workspace.AclPermission", + "launch_stage": "GA" + }, + "principal": { + "description": "The principal in which the permission is applied.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope to apply permissions to.", + "launch_stage": "GA" + } + } + }, + "workspace.PutSecret": { + "fields": { + "bytes_value": { + "description": "If specified, value will be stored as bytes.", + "launch_stage": "GA" + }, + "key": { + "description": "A unique name to identify the secret.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope to which the secret will be associated with.", + "launch_stage": "GA" + }, + "string_value": { + "description": "If specified, note that the value will be stored in UTF-8 (MB4) form.", + "launch_stage": "GA" + } + } + }, + "workspace.RepoAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.RepoPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "workspace.RepoAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "workspace.RepoInfo": { + "description": "Git folder (repo) information.", + "fields": { + "branch": { + "description": "Name of the current git branch of the git folder (repo).", + "launch_stage": "GA" + }, + "head_commit_id": { + "description": "Current git commit id of the git folder (repo).", + "launch_stage": "GA" + }, + "id": { + "description": "Id of the git folder (repo) in the Workspace.", + "launch_stage": "GA" + }, + "path": { + "description": "Root path of the git folder (repo) in the Workspace.", + "launch_stage": "GA" + }, + "provider": { + "description": "Git provider of the remote git repository, e.g. `gitHub`, `azureDevOpsServices`,\n`bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab\nSelf-Managed), or `awsCodeCommit` (deprecated).", + "launch_stage": "GA" + }, + "sparse_checkout": { + "description": "Sparse checkout config for the git folder (repo).", + "ref": "workspace.SparseCheckout", + "launch_stage": "GA" + }, + "url": { + "description": "URL of the remote git repository.", + "launch_stage": "GA" + } + } + }, + "workspace.RepoPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.RepoPermissionLevel", + "launch_stage": "GA" + } + } + }, + "workspace.RepoPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_RUN", + "CAN_READ" + ] + }, + "workspace.RepoPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "workspace.RepoPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.RepoPermissionLevel", + "launch_stage": "GA" + } + } + }, + "workspace.RepoPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "workspace.ScopeBackendType": { + "description": "The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes\nwill be supported in a later release.", + "enum": [ + "DATABRICKS", + "AZURE_KEYVAULT" + ], + "enum_launch_stages": { + "AZURE_KEYVAULT": "GA", + "DATABRICKS": "GA" + } + }, + "workspace.SecretMetadata": { + "description": "The metadata about a secret. Returned when listing secrets. Does not contain the\nactual secret value.", + "fields": { + "key": { + "description": "A unique name to identify the secret.", + "launch_stage": "GA" + }, + "last_updated_timestamp": { + "description": "The last updated timestamp (in milliseconds) for the secret.", + "launch_stage": "GA" + } + } + }, + "workspace.SecretScope": { + "description": "An organizational resource for storing secrets. Secret scopes can be\ndifferent types (Databricks-managed, Azure KeyVault backed, etc), and ACLs\ncan be applied to control permissions for all secrets within a scope.", + "fields": { + "backend_type": { + "description": "The type of secret scope backend.", + "ref": "workspace.ScopeBackendType", + "launch_stage": "GA" + }, + "keyvault_metadata": { + "description": "The metadata for the secret scope if the type is ``AZURE_KEYVAULT``", + "ref": "workspace.AzureKeyVaultSecretScopeMetadata", + "launch_stage": "GA" + }, + "name": { + "description": "A unique name to identify the secret scope.", + "launch_stage": "GA" + } + } + }, + "workspace.SparseCheckout": { + "description": "Sparse checkout configuration, it contains options like cone patterns.", + "fields": { + "patterns": { + "description": "List of sparse checkout cone patterns, see\n[cone mode handling](https://git-scm.com/docs/git-sparse-checkout#_internalscone_mode_handling)\nfor details.", + "launch_stage": "GA" + } + } + }, + "workspace.SparseCheckoutUpdate": { + "description": "Sparse checkout configuration, it contains options like cone patterns.", + "fields": { + "patterns": { + "description": "List of sparse checkout cone patterns, see\n[cone mode handling](https://git-scm.com/docs/git-sparse-checkout#_internalscone_mode_handling)\nfor details.", + "launch_stage": "GA" + } + } + }, + "workspace.UpdateCredentialsRequest": { + "fields": { + "git_email": { + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "launch_stage": "GA" + }, + "git_provider": { + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "launch_stage": "GA" + }, + "git_username": { + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "launch_stage": "GA" + }, + "is_default_for_provider": { + "description": "if the credential is the default for the given provider", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "the name of the git credential, used for identification and ease of lookup", + "preview": "PUBLIC", + "launch_stage": "PUBLIC_PREVIEW" + }, + "personal_access_token": { + "description": "The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).", + "launch_stage": "GA" + }, + "principal_id": { + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "launch_stage": "GA" + } + } + }, + "workspace.UpdateCredentialsResponse": {}, + "workspace.UpdateRepoRequest": { + "fields": { + "branch": { + "description": "Branch that the local version of the repo is checked out to.", + "launch_stage": "GA" + }, + "sparse_checkout": { + "description": "If specified, update the sparse checkout settings. The update will fail if sparse checkout is\nnot enabled for the repo.", + "ref": "workspace.SparseCheckoutUpdate", + "launch_stage": "GA" + }, + "tag": { + "description": "Tag that the local version of the repo is checked out to. Updating the repo to a tag puts\nthe repo in a detached HEAD state. Before committing new changes, you must update the repo to\na branch instead of the detached HEAD.", + "launch_stage": "GA" + } + } + }, + "workspace.UpdateRepoResponse": {}, + "workspace.WorkspaceObjectAccessControlRequest": { + "fields": { + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.WorkspaceObjectPermissionLevel", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "application ID of a service principal", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "workspace.WorkspaceObjectAccessControlResponse": { + "fields": { + "all_permissions": { + "description": "All permissions.", + "launch_stage": "GA" + }, + "display_name": { + "description": "Display name of the user or service principal.", + "launch_stage": "GA" + }, + "group_name": { + "description": "name of the group", + "launch_stage": "GA" + }, + "service_principal_name": { + "description": "Name of the service principal.", + "launch_stage": "GA" + }, + "user_name": { + "description": "name of the user", + "launch_stage": "GA" + } + } + }, + "workspace.WorkspaceObjectPermission": { + "fields": { + "inherited": { + "launch_stage": "GA" + }, + "inherited_from_object": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.WorkspaceObjectPermissionLevel", + "launch_stage": "GA" + } + } + }, + "workspace.WorkspaceObjectPermissionLevel": { + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_EDIT", + "CAN_RUN", + "CAN_READ" + ] + }, + "workspace.WorkspaceObjectPermissions": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + }, + "object_id": { + "launch_stage": "GA" + }, + "object_type": { + "launch_stage": "GA" + } + } + }, + "workspace.WorkspaceObjectPermissionsDescription": { + "fields": { + "description": { + "launch_stage": "GA" + }, + "permission_level": { + "ref": "workspace.WorkspaceObjectPermissionLevel", + "launch_stage": "GA" + } + } + }, + "workspace.WorkspaceObjectPermissionsRequest": { + "fields": { + "access_control_list": { + "launch_stage": "GA" + } + } + }, + "workspace.exportFormat": { + "description": "The format for workspace import and export.", + "enum": [ + "SOURCE", + "HTML", + "JUPYTER", + "DBC", + "R_MARKDOWN", + "AUTO", + "RAW" + ], + "enum_launch_stages": { + "AUTO": "GA", + "DBC": "GA", + "HTML": "GA", + "JUPYTER": "GA", + "RAW": "GA", + "R_MARKDOWN": "GA", + "SOURCE": "GA" + } + } + }, + "commands": { + "services": [ + { + "id": "iam.AccessControl", + "name": "AccessControl", + "description": "Rule based Access Control for Databricks Resources.", + "package": { + "name": "iam" + }, + "is_hidden_cli": true, + "docs_group": "iam", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "CheckPolicy", + "description": "Check access policy to a resource.", + "summary": "Check access policy to a resource.", + "path": "/api/2.0/access-control/check-policy-v2", + "can_use_json": true, + "must_use_json": true, + "is_crud_read": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CheckPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "actor", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "Actor", + "is_object": true + } + }, + { + "name": "permission", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource", + "description": "Ex: (servicePrincipal/use, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e)\nEx: (servicePrincipal.ruleSet/update, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e/ruleSets/default)", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "consistency_token", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ConsistencyToken", + "is_object": true + } + }, + { + "name": "authz_identity", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "RequestAuthzIdentity", + "enum": [ + { + "content": "REQUEST_AUTHZ_IDENTITY_SERVICE_IDENTITY" + }, + { + "content": "REQUEST_AUTHZ_IDENTITY_USER_CONTEXT" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "actor", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "Actor", + "is_object": true + } + }, + { + "name": "permission", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource", + "description": "Ex: (servicePrincipal/use, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e)\nEx: (servicePrincipal.ruleSet/update, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e/ruleSets/default)", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "consistency_token", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ConsistencyToken", + "is_object": true + } + }, + { + "name": "authz_identity", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "RequestAuthzIdentity", + "enum": [ + { + "content": "REQUEST_AUTHZ_IDENTITY_SERVICE_IDENTITY" + }, + { + "content": "REQUEST_AUTHZ_IDENTITY_USER_CONTEXT" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "CheckPolicyResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "consistency_token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConsistencyToken", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "consistency_token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConsistencyToken", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "actor", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "Actor", + "is_object": true + } + }, + { + "name": "authz_identity", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "RequestAuthzIdentity", + "enum": [ + { + "content": "REQUEST_AUTHZ_IDENTITY_SERVICE_IDENTITY" + }, + { + "content": "REQUEST_AUTHZ_IDENTITY_USER_CONTEXT" + } + ] + } + }, + { + "name": "consistency_token", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ConsistencyToken", + "is_object": true + } + }, + { + "name": "permission", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource", + "description": "Ex: (servicePrincipal/use, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e)\nEx: (servicePrincipal.ruleSet/update, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e/ruleSets/default)", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_info", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ResourceInfo", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "iam.AccountAccessControl", + "name": "AccountAccessControl", + "description": "These APIs manage access rules on resources in an account. Currently, only grant rules are\nsupported. A grant rule specifies a role assigned to a set of principals. A list of rules\nattached to a resource is called a rule set.", + "package": { + "name": "iam" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "GetAssignableRolesForResource", + "description": "Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the\nresource can contain an access rule of the role.", + "summary": "Get assignable roles for a resource.", + "path": "/api/2.0/preview/accounts/{account_id}/access-control/assignable-roles", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAssignableRolesForResourceRequest", + "is_object": true, + "required_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetAssignableRolesForResourceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRuleSet", + "description": "Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the\nsaid resource. Currently only a default rule set for each resource is supported.", + "summary": "Get a rule set.", + "path": "/api/2.0/preview/accounts/{account_id}/access-control/rule-sets", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetRuleSetRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RuleSetResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateRuleSet", + "description": "Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it.\nThis pattern helps prevent conflicts between concurrent updates.", + "summary": "Update a rule set.", + "path": "/api/2.0/preview/accounts/{account_id}/access-control/rule-sets", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateRuleSetRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "RuleSetResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "iam.AccountAccessControlProxy", + "name": "AccountAccessControlProxy", + "description": "These APIs manage access rules on resources in an account. Currently, only grant rules are\nsupported. A grant rule specifies a role assigned to a set of principals. A list of rules\nattached to a resource is called a rule set. A workspace must belong to an account for these\nAPIs to work", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "GetAssignableRolesForResource", + "description": "Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the\nresource can contain an access rule of the role.", + "summary": "Get assignable roles for a resource.", + "path": "/api/2.0/preview/accounts/access-control/assignable-roles", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAssignableRolesForResourceRequest", + "is_object": true, + "required_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetAssignableRolesForResourceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "resource", + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRuleSet", + "description": "Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the\nsaid resource. Currently only a default rule set for each resource is supported.", + "summary": "Get a rule set.", + "path": "/api/2.0/preview/accounts/access-control/rule-sets", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetRuleSetRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RuleSetResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateRuleSet", + "description": "Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it.\nThis pattern helps prevent conflicts between concurrent updates.", + "summary": "Update a rule set.", + "path": "/api/2.0/preview/accounts/access-control/rule-sets", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateRuleSetRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "RuleSetResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Identifies the version of the rule set returned.\nEtag used for versioning. The response is at least as fresh as the eTag provided.\nEtag is used for optimistic concurrency control as a way to help prevent simultaneous\nupdates of a rule set from overwriting each other. It is strongly suggested that systems\nmake use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set updates in\norder to avoid race conditions that is get an etag from a GET rule set request, and pass it\nwith the PUT update request to identify the rule set version you are updating.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the rule set.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_set", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RuleSetUpdateRequest", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "agentbricks.AgentBricks", + "name": "AgentBricks", + "description": "The Custom LLMs service manages state and powers the UI for the Custom LLM product.", + "package": { + "name": "agentbricks" + }, + "is_hidden_cli": true, + "docs_group": "agentbricks", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "CancelOptimize", + "description": "Cancel a Custom LLM Optimization Run.", + "summary": "Cancel a Custom LLM Optimization Run.", + "path": "/api/2.0/custom-llms/{id}/optimize/cancel", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CancelCustomLlmOptimizationRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateCustomLlm", + "description": "Create a Custom LLM.", + "summary": "Create a Custom LLM.", + "path": "/api/2.0/custom-llms", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateCustomLlmRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the custom LLM. Only alphanumeric characters and dashes allowed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the custom LLM. Only alphanumeric characters and dashes allowed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomLlm", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "agent_artifact_path", + "description": "This will soon be deprecated!!\nOptional: UC path for agent artifacts. If you are using a dataset that you only have read permissions,\nplease provide a destination path where you have write permissions. Please provide this in catalog.schema format.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "datasets", + "description": "Datasets used for training and evaluating the model, not for inference.\nCurrently, only 1 dataset is accepted.", + "is_request_body_field": true, + "entity": { + "pascal_name": "DatasetList", + "array_value": { + "pascal_name": "Dataset", + "is_object": true + } + } + }, + { + "name": "guidelines", + "description": "Guidelines for the custom LLM to adhere to", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the custom LLM. Only alphanumeric characters and dashes allowed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the custom LLM. Only alphanumeric characters and dashes allowed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteCustomLlm", + "description": "Delete a Custom LLM.", + "summary": "Delete a Custom LLM.", + "path": "/api/2.0/custom-llms/{id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteCustomLlmRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCustomLlm", + "description": "Get a Custom LLM.", + "summary": "Get a Custom LLM.", + "path": "/api/2.0/custom-llms/{id}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetCustomLlmRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomLlm", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "StartOptimize", + "description": "Start a Custom LLM Optimization Run.", + "summary": "Start a Custom LLM Optimization Run.", + "path": "/api/2.0/custom-llms/{id}/optimize", + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "StartCustomLlmOptimizationRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "The Id of the tile.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "The Id of the tile.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomLlm", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "id", + "description": "The Id of the tile.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "The Id of the tile.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateCustomLlm", + "description": "Update a Custom LLM.", + "summary": "Update a Custom LLM.", + "path": "/api/2.0/custom-llms/{id}", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateCustomLlmRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_llm", + "description": "The CustomLlm containing the fields which should be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomLlm", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "custom_llm", + "description": "The CustomLlm containing the fields which should be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomLlm", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomLlm", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the custom LLM", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Instructions for the custom LLM to follow", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "custom_llm", + "description": "The CustomLlm containing the fields which should be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomLlm", + "is_object": true + } + }, + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "The id of the custom llm", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.AibiDashboardEmbeddingAccessPolicy", + "name": "AibiDashboardEmbeddingAccessPolicy", + "description": "Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level.\nBy default, this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS).", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Delete the AI/BI dashboard embedding access policy, reverting back to the default.", + "summary": "Delete the AI/BI dashboard embedding access policy.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteAibiDashboardEmbeddingAccessPolicySettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteAibiDashboardEmbeddingAccessPolicySettingResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves the AI/BI dashboard embedding access policy.\nThe default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains.", + "summary": "Retrieve the AI/BI dashboard embedding access policy.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAibiDashboardEmbeddingAccessPolicySettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicySetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "aibi_dashboard_embedding_access_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "aibi_dashboard_embedding_access_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the AI/BI dashboard embedding access policy at the workspace level.", + "summary": "Update the AI/BI dashboard embedding access policy.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_acc_policy/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateAibiDashboardEmbeddingAccessPolicySettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicySetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicySetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicySetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "aibi_dashboard_embedding_access_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "aibi_dashboard_embedding_access_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicySetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.AibiDashboardEmbeddingApprovedDomains", + "name": "AibiDashboardEmbeddingApprovedDomains", + "description": "Controls the list of domains approved to host the embedded AI/BI dashboards.\nThe approved domains list can't be mutated when the current access policy is not set to ALLOW_APPROVED_DOMAINS.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list.", + "summary": "Delete AI/BI dashboard embedding approved domains.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_apprvd_domains/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves the list of domains approved to host embedded AI/BI dashboards.", + "summary": "Retrieve the list of domains approved to host embedded AI/BI dashboards.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_apprvd_domains/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAibiDashboardEmbeddingApprovedDomainsSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomainsSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "aibi_dashboard_embedding_approved_domains", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "aibi_dashboard_embedding_approved_domains", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the list of domains approved to host embedded AI/BI dashboards.\nThis update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS.", + "summary": "Update the list of domains approved to host embedded AI/BI dashboards.", + "path": "/api/2.0/settings/types/aibi_dash_embed_ws_apprvd_domains/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomainsSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomainsSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomainsSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "aibi_dashboard_embedding_approved_domains", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "aibi_dashboard_embedding_approved_domains", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomainsSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "sql.Alerts", + "name": "Alerts", + "description": "The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL\nobject that periodically runs a query, evaluates a condition of its result, and notifies one\nor more users and/or notification destinations if the condition was met.\nAlerts can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ListAlertsResponseAlertDisplayNameToIdMap" + }, + "request": { + "pascal_name": "ListAlertsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates an alert.", + "summary": "Create an alert.", + "path": "/api/2.0/sql/alerts", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAlertRequest", + "is_object": true + }, + "response": { + "pascal_name": "Alert", + "is_object": true + }, + "all_fields": [ + { + "name": "alert", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateAlertRequestAlert", + "is_object": true + } + }, + { + "name": "auto_resolve_display_name", + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "Delete", + "description": "Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.", + "summary": "Delete an alert.", + "path": "/api/2.0/sql/alerts/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TrashAlertRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Empty", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets an alert.", + "summary": "Get an alert.", + "path": "/api/2.0/sql/alerts/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAlertRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Alert", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of alerts accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.", + "summary": "List alerts.", + "path": "/api/2.0/sql/alerts", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAlertsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAlertsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates an alert.", + "summary": "Update an alert.", + "path": "/api/2.0/sql/alerts/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAlertRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Alert", + "is_object": true + }, + "all_fields": [ + { + "name": "alert", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateAlertRequestAlert", + "is_object": true + } + }, + { + "name": "auto_resolve_display_name", + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.AlertsLegacy", + "name": "AlertsLegacy", + "description": "The alerts API can be used to perform CRUD operations on alerts. An alert is a Databricks SQL\nobject that periodically runs a query, evaluates a condition of its result, and notifies one\nor more users and/or notification destinations if the condition was met.\nAlerts can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.\n\n**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Create", + "description": "Creates an alert.\nAn alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result,\nand notifies users or notification destinations if the condition was met.\n\n**Warning**: This API is deprecated. Please use :method:alerts/create instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Create an alert.", + "path": "/api/2.0/preview/sql/alerts", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateAlert", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LegacyAlert", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "parent", + "description": "The identifier of the workspace folder containing the object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rearm", + "description": "Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes an alert. Deleted alerts are no longer accessible and cannot be restored.\n**Note**: Unlike queries and dashboards, alerts cannot be moved to the trash.\n\n**Warning**: This API is deprecated. Please use :method:alerts/delete instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Delete an alert.", + "path": "/api/2.0/preview/sql/alerts/{alert_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteAlertsLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets an alert.\n\n**Warning**: This API is deprecated. Please use :method:alerts/get instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get an alert.", + "path": "/api/2.0/preview/sql/alerts/{alert_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAlertsLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LegacyAlert", + "is_object": true + }, + "all_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of alerts.\n\n**Warning**: This API is deprecated. Please use :method:alerts/list instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get alerts.", + "path": "/api/2.0/preview/sql/alerts", + "is_legacy_empty_request": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListRequest", + "is_object": true + }, + "response": { + "pascal_name": "LegacyAlertList", + "array_value": { + "pascal_name": "LegacyAlert", + "is_object": true + } + } + }, + { + "name": "Update", + "description": "Updates an alert.\n\n**Warning**: This API is deprecated. Please use :method:alerts/update instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Update an alert.", + "path": "/api/2.0/preview/sql/alerts/{alert_id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "EditAlert", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Alert configuration options.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertOptions", + "is_object": true + } + }, + { + "name": "query_id", + "description": "Query ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rearm", + "description": "Number of seconds after being triggered before the alert rearms itself and can be triggered again. If `null`, alert will never be triggered again.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "alert_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.AlertsV2", + "name": "AlertsV2", + "description": "New version of SQL Alerts", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "AlertV2DisplayNameToIdMap" + }, + "request": { + "pascal_name": "ListAlertsV2Request" + } + }, + "methods": [ + { + "name": "CreateAlert", + "description": "Create Alert", + "summary": "Create an alert.", + "path": "/api/2.0/alerts", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateAlertV2Request", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "The timestamp indicating when the alert was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_description", + "description": "Custom description for the alert. support mustache template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_summary", + "description": "Custom summary for the alert. support mustache template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_run_as", + "description": "The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AlertV2RunAs", + "is_object": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "id", + "description": "UUID identifying the alert.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifecycle_state", + "description": "Indicates whether the query is trashed.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertLifecycleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DELETED" + } + ] + } + }, + { + "name": "owner_user_name", + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_path", + "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as", + "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AlertV2RunAs", + "is_object": true + } + }, + { + "name": "run_as_user_name", + "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "update_time", + "description": "The timestamp indicating when the alert was updated.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + { + "name": "GetAlert", + "description": "Gets an alert.", + "summary": "Get an alert.", + "path": "/api/2.0/alerts/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAlertV2Request", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListAlerts", + "description": "Gets a list of alerts accessible to the user, ordered by creation time.", + "summary": "List alerts.", + "path": "/api/2.0/alerts", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListAlertsV2Request", + "is_object": true + }, + "response": { + "pascal_name": "ListAlertsV2Response", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "TrashAlert", + "description": "Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.", + "summary": "Delete an alert (legacy TrashAlert).", + "path": "/api/2.0/alerts/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "TrashAlertV2Request", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Empty", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge", + "description": "Whether to permanently delete the alert. If not set, the alert will only be soft deleted.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateAlert", + "description": "Update alert", + "summary": "Update an alert.", + "path": "/api/2.0/alerts/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateAlertV2Request", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "UUID identifying the alert.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "UUID identifying the alert.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "alert", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + { + "name": "id", + "description": "UUID identifying the alert.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "The timestamp indicating when the alert was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_description", + "description": "Custom description for the alert. support mustache template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_summary", + "description": "Custom summary for the alert. support mustache template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_run_as", + "description": "The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AlertV2RunAs", + "is_object": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "id", + "description": "UUID identifying the alert.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifecycle_state", + "description": "Indicates whether the query is trashed.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertLifecycleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DELETED" + } + ] + } + }, + { + "name": "owner_user_name", + "description": "The owner's username. This field is set to \"Unavailable\" if the user has been deleted.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_path", + "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as", + "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AlertV2RunAs", + "is_object": true + } + }, + { + "name": "run_as_user_name", + "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "update_time", + "description": "The timestamp indicating when the alert was updated.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "UUID identifying the alert.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_text", + "description": "Text of the query to be run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "ID of the SQL warehouse attached to the alert.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "evaluation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AlertV2Evaluation", + "is_object": true + } + }, + { + "name": "schedule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "apps.Apps", + "name": "Apps", + "description": "Apps run directly on a customer's Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on.", + "package": { + "name": "apps" + }, + "docs_group": "apps", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAppsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new app.", + "summary": "Create an app.", + "path": "/api/2.0/apps", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAppRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "no_compute", + "description": "If true, the app will not be started after creation.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "active_deployment", + "description": "The active deployment of the app. A deployment is considered active when it has been deployed\nto the app compute.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + { + "name": "app_status", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ApplicationStatus", + "is_object": true + } + }, + { + "name": "budget_policy_id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "compute_max_instances", + "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "compute_min_instances", + "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "compute_size", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComputeSize", + "enum": [ + { + "content": "LARGE" + }, + { + "content": "MEDIUM" + } + ] + } + }, + { + "name": "compute_status", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ComputeStatus", + "is_object": true + } + }, + { + "name": "create_time", + "description": "The creation time of the app. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the user that created the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_source_code_path", + "description": "The default workspace file system path of the source code from which app deployment are\ncreated. This field tracks the workspace source code path of the last active deployment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the app.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_budget_policy_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_usage_policy_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_user_api_scopes", + "description": "The effective api scopes granted to the user access token.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "git_repository", + "description": "Git repository configuration for app deployments. When specified, deployments can\nreference code from this repository by providing only the git reference (branch, tag, or commit).", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GitRepository", + "is_object": true + } + }, + { + "name": "id", + "description": "The unique identifier of the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oauth2_app_client_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oauth2_app_integration_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pending_deployment", + "description": "The pending deployment of the app. A deployment is considered pending when it is being prepared\nfor deployment to the app compute.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + { + "name": "resources", + "description": "Resources for the app.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, + { + "name": "service_principal_client_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "service_principal_name", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space", + "description": "Name of the space this app belongs to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "telemetry_export_destinations", + "is_request_body_field": true, + "entity": { + "pascal_name": "TelemetryExportDestinationList", + "array_value": { + "pascal_name": "TelemetryExportDestination", + "is_object": true + } + } + }, + { + "name": "thumbnail_url", + "description": "The URL of the thumbnail image for the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The update time of the app. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updater", + "description": "The email of the user that last updated the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "The URL of the app once it is deployed.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_api_scopes", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "ACTIVE" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "App" + } + }, + "status_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "ComputeStatus" + } + } + }, + { + "name": "CreateSpace", + "description": "Creates a new app space.", + "summary": "Create an app space.", + "path": "/api/2.0/app-spaces", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateSpaceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "The creation time of the app space. Formatted timestamp in ISO 6801.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The email of the user that created the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the app space.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_usage_policy_id", + "description": "The effective usage policy ID used by apps in the space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_user_api_scopes", + "description": "The effective api scopes granted to the user access token.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "id", + "description": "The unique identifier of the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resources", + "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, + { + "name": "service_principal_client_id", + "description": "The service principal client ID for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "service_principal_name", + "description": "The service principal name for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "The status of the app space.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SpaceStatus", + "is_object": true + } + }, + { + "name": "update_time", + "description": "The update time of the app space. Formatted timestamp in ISO 6801.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updater", + "description": "The email of the user that last updated the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "description": "The usage policy ID for managing cost at the space level.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_api_scopes", + "description": "OAuth scopes for apps in the space.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-space-operation", + "pascal_name": "GetSpaceOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateUpdate", + "description": "Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.", + "summary": "Create an app update.", + "path": "/api/2.0/apps/{app_name}/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AsyncUpdateAppRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "app_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppUpdate", + "is_object": true + }, + "all_fields": [ + { + "name": "app", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + }, + { + "name": "app_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "SUCCEEDED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "AppUpdate" + } + }, + "status_path": [ + { + "pascal_name": "Status" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Status" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "Status" + } + } + }, + { + "name": "Delete", + "description": "Deletes an app.", + "summary": "Delete an app.", + "path": "/api/2.0/apps/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAppRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteAppThumbnail", + "description": "Deletes the thumbnail for an app.", + "summary": "Delete an app thumbnail.", + "path": "/api/2.0/apps/{name}/thumbnail", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAppThumbnailRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSpace", + "description": "Deletes an app space.", + "summary": "Delete an app space.", + "path": "/api/2.0/app-spaces/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteSpaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-space-operation", + "pascal_name": "GetSpaceOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "Deploy", + "description": "Creates an app deployment for the app with the supplied name.", + "summary": "Create an app deployment.", + "path": "/api/2.0/apps/{app_name}/deployments", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAppDeploymentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "app_deployment", + "description": "The app deployment configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "app_deployment", + "description": "The app deployment configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "app_deployment", + "description": "The app deployment configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + "response": { + "pascal_name": "AppDeployment", + "is_object": true + }, + "all_fields": [ + { + "name": "app_deployment", + "description": "The app deployment configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "command", + "description": "The command with which to run the app. This will override the command specified in the app.yaml file.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "create_time", + "description": "The creation time of the deployment. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the user creates the deployment.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_artifacts", + "description": "The deployment artifacts for an app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeploymentArtifacts", + "is_object": true + } + }, + { + "name": "deployment_id", + "description": "The unique id of the deployment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "env_vars", + "description": "The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EnvVarList", + "array_value": { + "pascal_name": "EnvVar", + "is_object": true + } + } + }, + { + "name": "git_source", + "description": "Git repository to use as the source for the app deployment.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GitSource", + "is_object": true + } + }, + { + "name": "mode", + "description": "The mode of which the deployment will manage the source code.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppDeploymentMode", + "enum": [ + { + "content": "AUTO_SYNC" + }, + { + "content": "SNAPSHOT" + } + ] + } + }, + { + "name": "source_code_path", + "description": "The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status and status message of the deployment", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeploymentStatus", + "is_object": true + } + }, + { + "name": "update_time", + "description": "The update time of the deployment. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "SUCCEEDED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "AppDeployment" + } + }, + "status_path": [ + { + "pascal_name": "Status" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Status" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "Status" + } + } + }, + { + "name": "Get", + "description": "Retrieves information for the app with the supplied name.", + "summary": "Get an app.", + "path": "/api/2.0/apps/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAppRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDeployment", + "description": "Retrieves information for the app deployment with the supplied name and deployment id.", + "summary": "Get an app deployment.", + "path": "/api/2.0/apps/{app_name}/deployments/{deployment_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAppDeploymentRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_id", + "description": "The unique id of the deployment.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_id", + "description": "The unique id of the deployment.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppDeployment", + "is_object": true + }, + "all_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_id", + "description": "The unique id of the deployment.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_id", + "description": "The unique id of the deployment.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get app permission levels.", + "path": "/api/2.0/permissions/apps/{app_name}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAppPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetAppPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of an app. Apps can inherit permissions from their root object.", + "summary": "Get app permissions.", + "path": "/api/2.0/permissions/apps/{app_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAppPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSpace", + "description": "Retrieves information for the app space with the supplied name.", + "summary": "Get an app space.", + "path": "/api/2.0/app-spaces/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetSpaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Space", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSpaceOperation", + "description": "Gets the status of an app space update operation.", + "summary": "Get the status of an app space operation.", + "path": "/api/2.0/app-spaces/{name}/operation", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetOperationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetUpdate", + "description": "Gets the status of an app update.", + "summary": "Get an app update.", + "path": "/api/2.0/apps/{app_name}/update", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAppUpdateRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppUpdate", + "is_object": true + }, + "all_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists all apps in the workspace.", + "summary": "List apps.", + "path": "/api/2.0/apps", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAppsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAppsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space", + "description": "Filter apps by app space name. When specified, only apps belonging to this space are returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListDeployments", + "description": "Lists all app deployments for the app with the supplied name.", + "summary": "List app deployments.", + "path": "/api/2.0/apps/{app_name}/deployments", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAppDeploymentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAppDeploymentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSpaces", + "description": "Lists all app spaces in the workspace.", + "summary": "List app spaces.", + "path": "/api/2.0/app-spaces", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListSpacesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListSpacesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of app spaces. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of app spaces. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set app permissions.", + "path": "/api/2.0/permissions/apps/{app_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AppPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppAccessControlRequestList", + "array_value": { + "pascal_name": "AppAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Start", + "description": "Start the last active deployment of the app in the workspace.", + "summary": "Start an app.", + "path": "/api/2.0/apps/{name}/start", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StartAppRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "ACTIVE" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "App" + } + }, + "status_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "ComputeStatus" + } + } + }, + { + "name": "Stop", + "description": "Stops the active deployment of the app in the workspace.", + "summary": "Stop an app.", + "path": "/api/2.0/apps/{name}/stop", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StopAppRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "STOPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "App" + } + }, + "status_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "ComputeStatus" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "ComputeStatus" + } + } + }, + { + "name": "Update", + "description": "Updates the app with the supplied name.", + "summary": "Update an app.", + "path": "/api/2.0/apps/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAppRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "app", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "App", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "active_deployment", + "description": "The active deployment of the app. A deployment is considered active when it has been deployed\nto the app compute.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + { + "name": "app_status", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ApplicationStatus", + "is_object": true + } + }, + { + "name": "budget_policy_id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "compute_max_instances", + "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "compute_min_instances", + "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "compute_size", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComputeSize", + "enum": [ + { + "content": "LARGE" + }, + { + "content": "MEDIUM" + } + ] + } + }, + { + "name": "compute_status", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ComputeStatus", + "is_object": true + } + }, + { + "name": "create_time", + "description": "The creation time of the app. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the user that created the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_source_code_path", + "description": "The default workspace file system path of the source code from which app deployment are\ncreated. This field tracks the workspace source code path of the last active deployment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the app.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_budget_policy_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_usage_policy_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_user_api_scopes", + "description": "The effective api scopes granted to the user access token.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "git_repository", + "description": "Git repository configuration for app deployments. When specified, deployments can\nreference code from this repository by providing only the git reference (branch, tag, or commit).", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GitRepository", + "is_object": true + } + }, + { + "name": "id", + "description": "The unique identifier of the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oauth2_app_client_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oauth2_app_integration_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pending_deployment", + "description": "The pending deployment of the app. A deployment is considered pending when it is being prepared\nfor deployment to the app compute.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppDeployment", + "is_object": true + } + }, + { + "name": "resources", + "description": "Resources for the app.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, + { + "name": "service_principal_client_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "service_principal_name", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space", + "description": "Name of the space this app belongs to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "telemetry_export_destinations", + "is_request_body_field": true, + "entity": { + "pascal_name": "TelemetryExportDestinationList", + "array_value": { + "pascal_name": "TelemetryExportDestination", + "is_object": true + } + } + }, + { + "name": "thumbnail_url", + "description": "The URL of the thumbnail image for the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The update time of the app. Formatted timestamp in ISO 6801.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updater", + "description": "The email of the user that last updated the app.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "The URL of the app once it is deployed.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_api_scopes", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateAppThumbnail", + "description": "Updates the thumbnail for an app.", + "summary": "Update an app thumbnail.", + "path": "/api/2.0/apps/{name}/thumbnail", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAppThumbnailRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppThumbnail", + "is_object": true + }, + "all_fields": [ + { + "name": "app_thumbnail", + "description": "The app thumbnail to set.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AppThumbnail", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on an app. Apps can inherit permissions from their root object.", + "summary": "Update app permissions.", + "path": "/api/2.0/permissions/apps/{app_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AppPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AppPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppAccessControlRequestList", + "array_value": { + "pascal_name": "AppAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "app_name", + "description": "The app for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSpace", + "description": "Updates an app space. The update process is asynchronous and the status of the update can be checked with the GetSpaceOperation method.", + "summary": "Update an app space.", + "path": "/api/2.0/app-spaces/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateSpaceRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Space", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "The creation time of the app space. Formatted timestamp in ISO 6801.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The email of the user that created the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the app space.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_usage_policy_id", + "description": "The effective usage policy ID used by apps in the space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_user_api_scopes", + "description": "The effective api scopes granted to the user access token.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "id", + "description": "The unique identifier of the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resources", + "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AppResourceList", + "array_value": { + "pascal_name": "AppResource", + "is_object": true + } + } + }, + { + "name": "service_principal_client_id", + "description": "The service principal client ID for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "service_principal_name", + "description": "The service principal name for the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "The status of the app space.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SpaceStatus", + "is_object": true + } + }, + { + "name": "update_time", + "description": "The update time of the app space. Formatted timestamp in ISO 6801.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updater", + "description": "The email of the user that last updated the app space.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "description": "The usage policy ID for managing cost at the space level.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_api_scopes", + "description": "OAuth scopes for apps in the space.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-space-operation", + "pascal_name": "GetSpaceOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + } + ] + }, + { + "id": "apps.AppsSettings", + "name": "AppsSettings", + "description": "Apps Settings manage the settings for the Apps service on a customer's Databricks instance.", + "package": { + "name": "apps" + }, + "is_hidden_cli": true, + "docs_group": "apps", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListCustomTemplatesRequest" + } + }, + "methods": [ + { + "name": "CreateCustomTemplate", + "description": "Creates a custom template.", + "summary": "Create a template.", + "path": "/api/2.0/apps-settings/templates", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateCustomTemplateRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "creator", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteCustomTemplate", + "description": "Deletes the custom template with the specified name.", + "summary": "Delete a template.", + "path": "/api/2.0/apps-settings/templates/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteCustomTemplateRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCustomTemplate", + "description": "Gets the custom template with the specified name.", + "summary": "Get a template.", + "path": "/api/2.0/apps-settings/templates/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetCustomTemplateRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the custom template.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListCustomTemplates", + "description": "Lists all custom templates in the workspace.", + "summary": "List templates.", + "path": "/api/2.0/apps-settings/templates", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListCustomTemplatesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListCustomTemplatesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of custom templates. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of custom templates. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateCustomTemplate", + "description": "Updates the custom template with the specified name. Note that the template name cannot be updated.", + "summary": "Update a template.", + "path": "/api/2.0/apps-settings/templates/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateCustomTemplateRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "template", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTemplate", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "creator", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the template.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_repo", + "description": "The Git repository URL that the template resides in.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The path to the template within the Git repository.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "manifest", + "description": "The manifest of the template. It defines fields and default values when installing the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AppManifest", + "is_object": true + } + }, + { + "name": "git_provider", + "description": "The Git provider of the template.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.ArtifactAllowlists", + "name": "ArtifactAllowlists", + "description": "In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the\n`allowlist` in UC so that users can leverage these artifacts on compute configured with\nshared access mode.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Get", + "description": "Get the artifact allowlist of a certain artifact type.\nThe caller must be a metastore admin or have the **MANAGE ALLOWLIST** privilege\non the metastore.", + "summary": "Get an artifact allowlist.", + "path": "/api/2.1/unity-catalog/artifact-allowlists/{artifact_type}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetArtifactAllowlistRequest", + "is_object": true, + "required_fields": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "ArtifactAllowlistInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ] + }, + { + "name": "Update", + "description": "Set the artifact allowlist of a certain artifact type.\nThe whole artifact allowlist is replaced with the new allowlist.\nThe caller must be a metastore admin or have the **MANAGE ALLOWLIST** privilege\non the metastore.", + "summary": "Set an artifact allowlist.", + "path": "/api/2.1/unity-catalog/artifact-allowlists/{artifact_type}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetArtifactAllowlist", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + }, + { + "name": "artifact_matchers", + "description": "A list of allowed artifact match patterns.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ArtifactMatcherList", + "array_value": { + "pascal_name": "ArtifactMatcher", + "is_object": true + } + } + } + ], + "required_in_url_fields": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "artifact_matchers", + "description": "A list of allowed artifact match patterns.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ArtifactMatcherList", + "array_value": { + "pascal_name": "ArtifactMatcher", + "is_object": true + } + } + } + ] + }, + "response": { + "pascal_name": "ArtifactAllowlistInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "artifact_matchers", + "description": "A list of allowed artifact match patterns.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ArtifactMatcherList", + "array_value": { + "pascal_name": "ArtifactMatcher", + "is_object": true + } + } + }, + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + }, + { + "name": "created_at", + "description": "Time at which this artifact allowlist was set, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "Username of the user who set the artifact allowlist.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "Unique identifier of parent metastore.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "artifact_type", + "description": "The artifact type of the allowlist.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ArtifactType", + "enum": [ + { + "content": "INIT_SCRIPT" + }, + { + "content": "LIBRARY_JAR" + }, + { + "content": "LIBRARY_MAVEN" + } + ] + } + } + ] + } + ] + }, + { + "id": "settings.AutomaticClusterUpdate", + "name": "AutomaticClusterUpdate", + "description": "Controls whether automatic cluster update is enabled for the current workspace.\nBy default, it is turned off.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Get", + "description": "Gets the automatic cluster update setting.", + "summary": "Get the automatic cluster update setting.", + "path": "/api/2.0/settings/types/automatic_cluster_update/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAutomaticClusterUpdateSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "AutomaticClusterUpdateSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "automatic_cluster_update_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "automatic_cluster_update_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in `PATCH`\nrequests (as part of the setting field). The etag can be retrieved by making a `GET` request before the `PATCH` request.\nIf the setting is updated concurrently, `PATCH` fails with 409 and the request must be retried by using the fresh etag in the 409 response.", + "summary": "Update the automatic cluster update setting.", + "path": "/api/2.0/settings/types/automatic_cluster_update/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateAutomaticClusterUpdateSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AutomaticClusterUpdateSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AutomaticClusterUpdateSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AutomaticClusterUpdateSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "automatic_cluster_update_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "automatic_cluster_update_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AutomaticClusterUpdateSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "billing.BillableUsage", + "name": "BillableUsage", + "description": "This API allows you to download billable usage logs for the specified account and date range. This feature works with all account types.", + "package": { + "name": "billing" + }, + "is_accounts": true, + "docs_group": "billing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Download", + "description": "Returns billable usage logs in CSV format for the specified account and date range.\nFor the data schema, see:\n\n- AWS: [CSV file schema](https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema).\n- GCP: [CSV file schema](https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema).\n\nNote that this method might take multiple minutes to complete.\n\n**Warning**: Depending on the queried date range, the number of workspaces\nin the account, the size of the response and the internet speed of the caller,\nthis API may hit a timeout after a few minutes. If you experience this, try to mitigate\nby calling the API with narrower date ranges.", + "summary": "Return billable usage logs.", + "path": "/api/2.0/accounts/{account_id}/usage/download", + "is_response_byte_stream": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DownloadRequest", + "is_object": true, + "required_fields": [ + { + "name": "start_month", + "description": "Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "end_month", + "description": "Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "start_month", + "description": "Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "end_month", + "description": "Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DownloadResponse", + "is_object": true + }, + "response_body_field": { + "pascal_name": "Contents" + }, + "all_fields": [ + { + "name": "end_month", + "description": "Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "personal_data", + "description": "Specify whether to include personally identifiable information in\nthe billable usage logs, for example the email addresses of cluster\ncreators. Handle this information with care. Defaults to false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "start_month", + "description": "Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "start_month", + "description": "Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "end_month", + "description": "Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "billing.BudgetPolicy", + "name": "BudgetPolicy", + "description": "A service serves REST API about Budget policies", + "package": { + "name": "billing" + }, + "is_accounts": true, + "docs_group": "billing", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListBudgetPoliciesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new policy.", + "summary": "Create a budget policy.", + "path": "/api/2.1/accounts/{account_id}/budget-policies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateBudgetPolicyRequest", + "is_object": true + }, + "response": { + "pascal_name": "BudgetPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "description": "The policy to create. `policy_id` needs to be empty as it will be generated\n`policy_name` must be provided, custom_tags may need to be provided\ndepending on the cloud provider. All other fields are optional.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BudgetPolicy", + "is_object": true + } + }, + { + "name": "request_id", + "description": "A unique identifier for this request. Restricted to 36 ASCII characters.\nA random UUID is recommended.\nThis request is only idempotent if a `request_id` is provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a policy", + "summary": "Delete a budget policy.", + "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteBudgetPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves a policy by it's ID.", + "summary": "Get a budget policy.", + "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetBudgetPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "BudgetPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The Id of the policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists all policies. Policies are returned in the alphabetically ascending order of their names.", + "summary": "List policies.", + "path": "/api/2.1/accounts/{account_id}/budget-policies", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListBudgetPoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListBudgetPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter_by", + "description": "A filter to apply to the list of policies.", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Filter", + "is_object": true + } + }, + { + "name": "page_size", + "description": "The maximum number of budget policies to return.\nIf unspecified, at most 100 budget policies will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sort_spec", + "description": "The sort specification.", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SortSpec", + "is_object": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates a policy", + "summary": "Update a budget policy.", + "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateBudgetPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy", + "description": "The policy to update. `creator_user_id` cannot be specified in the request. All other fields\nmust be specified even if not changed. The `policy_id` is used to identify the policy to\nupdate.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BudgetPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "description": "The policy to update. `creator_user_id` cannot be specified in the request. All other fields\nmust be specified even if not changed. The `policy_id` is used to identify the policy to\nupdate.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BudgetPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "description": "The policy to update. `creator_user_id` cannot be specified in the request. All other fields\nmust be specified even if not changed. The `policy_id` is used to identify the policy to\nupdate.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BudgetPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "BudgetPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "limit_config", + "description": "DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "LimitConfig", + "is_object": true + } + }, + { + "name": "policy", + "description": "The policy to update. `creator_user_id` cannot be specified in the request. All other fields\nmust be specified even if not changed. The `policy_id` is used to identify the policy to\nupdate.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BudgetPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "binding_workspace_ids", + "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_int64": true + } + } + }, + { + "name": "custom_tags", + "description": "A list of tags defined by the customer. At most 20 entries are allowed per policy.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomPolicyTagList", + "array_value": { + "pascal_name": "CustomPolicyTag", + "is_object": true + } + } + }, + { + "name": "policy_id", + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_name", + "description": "The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The Id of the policy. This field is generated by Databricks and globally unique.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "billing.Budgets", + "name": "Budgets", + "description": "These APIs manage budget configurations for this account. Budgets enable you to monitor usage across your account. You can set up budgets to either track account-wide spending, or apply filters to track the spending of specific teams, projects, or workspaces.", + "package": { + "name": "billing" + }, + "is_accounts": true, + "docs_group": "billing", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Create", + "description": "Create a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html.", + "summary": "Create new budget.", + "path": "/api/2.1/accounts/{account_id}/budgets", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateBudgetConfigurationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "budget", + "description": "Properties of the new budget configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateBudgetConfigurationBudget", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "budget", + "description": "Properties of the new budget configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateBudgetConfigurationBudget", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreateBudgetConfigurationResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "budget", + "description": "Properties of the new budget configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateBudgetConfigurationBudget", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone.", + "summary": "Delete budget.", + "path": "/api/2.1/accounts/{account_id}/budgets/{budget_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteBudgetConfigurationRequest", + "is_object": true, + "required_fields": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteBudgetConfigurationResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a budget configuration for an account. Both account and budget configuration are specified by ID.", + "summary": "Get budget.", + "path": "/api/2.1/accounts/{account_id}/budgets/{budget_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetBudgetConfigurationRequest", + "is_object": true, + "required_fields": [ + { + "name": "budget_id", + "description": "The budget configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "budget_id", + "description": "The budget configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetBudgetConfigurationResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "budget_id", + "description": "The budget configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "budget_id", + "description": "The budget configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all budgets associated with this account.", + "summary": "Get all budgets.", + "path": "/api/2.1/accounts/{account_id}/budgets", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListBudgetConfigurationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListBudgetConfigurationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_token", + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates a budget configuration for an account. Both account and budget configuration are specified by ID.", + "summary": "Modify budget.", + "path": "/api/2.1/accounts/{account_id}/budgets/{budget_id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateBudgetConfigurationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "budget", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateBudgetConfigurationBudget", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "budget", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateBudgetConfigurationBudget", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateBudgetConfigurationResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "budget", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateBudgetConfigurationBudget", + "is_object": true + } + }, + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "budget_id", + "description": "The Databricks budget configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "bundle.Bundle", + "name": "Bundle", + "description": "Service for managing bundle deployment metadata.", + "package": { + "name": "bundle" + }, + "is_hidden_cli": true, + "docs_group": "bundle", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListDeploymentsRequest" + } + }, + "methods": [ + { + "name": "CompleteVersion", + "description": "Marks a version as complete and releases the deployment lock.\n\nThe server atomically:\n1. Sets the version status to the provided terminal status.\n2. Sets `complete_time` to the current server timestamp.\n3. Releases the lock on the parent deployment.\n4. Updates the parent deployment's `status` and `last_version_id`.", + "summary": "Complete a version.", + "path": "/api/2.0/bundle/{name=deployments/*/versions/*}/complete", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CompleteVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the version to complete.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "completion_reason", + "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionComplete", + "enum": [ + { + "content": "VERSION_COMPLETE_FAILURE" + }, + { + "content": "VERSION_COMPLETE_FORCE_ABORT" + }, + { + "content": "VERSION_COMPLETE_LEASE_EXPIRED" + }, + { + "content": "VERSION_COMPLETE_SUCCESS" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the version to complete.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "completion_reason", + "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionComplete", + "enum": [ + { + "content": "VERSION_COMPLETE_FAILURE" + }, + { + "content": "VERSION_COMPLETE_FORCE_ABORT" + }, + { + "content": "VERSION_COMPLETE_LEASE_EXPIRED" + }, + { + "content": "VERSION_COMPLETE_SUCCESS" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "Version", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "completion_reason", + "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionComplete", + "enum": [ + { + "content": "VERSION_COMPLETE_FAILURE" + }, + { + "content": "VERSION_COMPLETE_FORCE_ABORT" + }, + { + "content": "VERSION_COMPLETE_LEASE_EXPIRED" + }, + { + "content": "VERSION_COMPLETE_SUCCESS" + } + ] + } + }, + { + "name": "force", + "description": "If true, force-completes the version even if the caller is not the\noriginal creator. The completion_reason must be\nVERSION_COMPLETE_FORCE_ABORT when force is true.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the version to complete.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the version to complete.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "completion_reason", + "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionComplete", + "enum": [ + { + "content": "VERSION_COMPLETE_FAILURE" + }, + { + "content": "VERSION_COMPLETE_FORCE_ABORT" + }, + { + "content": "VERSION_COMPLETE_LEASE_EXPIRED" + }, + { + "content": "VERSION_COMPLETE_SUCCESS" + } + ] + } + } + ] + }, + { + "name": "CreateDeployment", + "description": "Creates a new deployment in the workspace.\n\nThe caller must provide a `deployment_id` which becomes the final\ncomponent of the deployment's resource name. If a deployment with the\nsame ID already exists, the server returns `ALREADY_EXISTS`.", + "summary": "Create a deployment.", + "path": "/api/2.0/bundle/deployments", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateDeploymentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "deployment", + "description": "The deployment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Deployment", + "is_object": true + } + }, + { + "name": "deployment_id", + "description": "The ID to use for the deployment, which will become the final\ncomponent of the deployment's resource name\n(i.e. `deployments/{deployment_id}`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "deployment_id", + "description": "The ID to use for the deployment, which will become the final\ncomponent of the deployment's resource name\n(i.e. `deployments/{deployment_id}`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "deployment", + "description": "The deployment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Deployment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "deployment", + "description": "The deployment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Deployment", + "is_object": true + } + }, + "response": { + "pascal_name": "Deployment", + "is_object": true + }, + "all_fields": [ + { + "name": "deployment", + "description": "The deployment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Deployment", + "is_object": true + } + }, + { + "name": "deployment_id", + "description": "The ID to use for the deployment, which will become the final\ncomponent of the deployment's resource name\n(i.e. `deployments/{deployment_id}`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "When the deployment was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The user who created the deployment (email or principal name).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_mode", + "description": "Bundle target deployment mode (development or production), derived from the\nmost recent version's mode.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentMode", + "enum": [ + { + "content": "DEPLOYMENT_MODE_DEVELOPMENT" + }, + { + "content": "DEPLOYMENT_MODE_PRODUCTION" + } + ] + } + }, + { + "name": "destroy_time", + "description": "When the deployment was destroyed (i.e. `bundle destroy` completed).\nUnset if the deployment has not been destroyed.\nNamed destroy_time (not delete_time) because this tracks the\n`databricks bundle destroy` command, not the API-level deletion.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "destroyed_by", + "description": "The user who destroyed the deployment (email or principal name).\nUnset if the deployment has not been destroyed.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable name for the deployment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "last_version_id", + "description": "The version_id of the most recent deployment version.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name of the deployment.\nFormat: deployments/{deployment_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Current status of the deployment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentStatus", + "enum": [ + { + "content": "DEPLOYMENT_STATUS_ACTIVE" + }, + { + "content": "DEPLOYMENT_STATUS_DELETED" + }, + { + "content": "DEPLOYMENT_STATUS_FAILED" + }, + { + "content": "DEPLOYMENT_STATUS_IN_PROGRESS" + } + ] + } + }, + { + "name": "target_name", + "description": "The bundle target name associated with this deployment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "When the deployment was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "deployment_id", + "description": "The ID to use for the deployment, which will become the final\ncomponent of the deployment's resource name\n(i.e. `deployments/{deployment_id}`).", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateOperation", + "description": "Creates a resource operation under a version.\n\nThe caller must provide a `resource_key` which becomes the final\ncomponent of the operation's name. If an operation with the same key\nalready exists under the version, the server returns `ALREADY_EXISTS`.\n\nOn success the server also updates the corresponding deployment-level\nResource (creating it if this is the first operation for that\nresource_key, or removing it if action_type is DELETE).", + "summary": "Create an operation.", + "path": "/api/2.0/bundle/{parent=deployments/*/versions/*}/operations", + "can_use_json": true, + "must_use_json": true, + "is_json_only": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateOperationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent version where this operation will be recorded.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "operation", + "description": "The resource operation to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Operation", + "is_object": true + } + }, + { + "name": "resource_key", + "description": "The key identifying the resource this operation applies to.\nBecomes the final component of the operation's name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent version where this operation will be recorded.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_key", + "description": "The key identifying the resource this operation applies to.\nBecomes the final component of the operation's name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "operation", + "description": "The resource operation to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Operation", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "operation", + "description": "The resource operation to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Operation", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "operation", + "description": "The resource operation to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Operation", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ] + } + }, + { + "name": "parent", + "description": "The parent version where this operation will be recorded.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_key", + "description": "The key identifying the resource this operation applies to.\nBecomes the final component of the operation's name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "create_time", + "description": "When the operation was recorded.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "error_message", + "description": "Error message if the operation failed. Set when status is\nOPERATION_STATUS_FAILED. Captures the error encountered while\napplying the resource to the workspace.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name of the operation.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_key", + "description": "Resource identifier within the bundle (e.g. \"jobs.foo\",\n\"pipelines.bar\", \"jobs.foo.permissions\", \"files.\u003crel-path\u003e\").\nCan be an arbitrary UTF-8 encoded string key. This key links the\noperation to the corresponding deployment-level Resource.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_type", + "description": "The type of the deployment resource this operation applies to. Derived\nfrom the `resource_key` prefix (e.g. \"jobs\" → JOB); the caller does not\nset this field.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentResourceType", + "enum": [ + { + "content": "DEPLOYMENT_RESOURCE_TYPE_ALERT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_APP" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CLUSTER" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DASHBOARD" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_JOB" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_PIPELINE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SCHEMA" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_VOLUME" + } + ] + } + }, + { + "name": "state", + "description": "Serialized local config state after the operation.\nShould be unset for delete operations.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": {} + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent version where this operation will be recorded.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateVersion", + "description": "Creates a new version under a deployment.\n\nCreating a version acquires an exclusive lock on the deployment,\npreventing concurrent deploys. The caller provides a `version_id`\nwhich the server validates equals `last_version_id + 1` on the\ndeployment.", + "summary": "Create a version.", + "path": "/api/2.0/bundle/{parent=deployments/*}/versions", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent deployment where this version will be created.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The version to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Version", + "is_object": true + } + }, + { + "name": "version_id", + "description": "The version ID the caller expects to create. The server validates\nthis equals `last_version_id + 1` on the deployment. If it doesn't\nmatch, the server returns `ABORTED`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent deployment where this version will be created.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_id", + "description": "The version ID the caller expects to create. The server validates\nthis equals `last_version_id + 1` on the deployment. If it doesn't\nmatch, the server returns `ABORTED`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "version", + "description": "The version to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Version", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "version", + "description": "The version to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Version", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "Version", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "parent", + "description": "The parent deployment where this version will be created.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The version to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Version", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + } + }, + { + "name": "version_id", + "description": "The version ID the caller expects to create. The server validates\nthis equals `last_version_id + 1` on the deployment. If it doesn't\nmatch, the server returns `ABORTED`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "complete_time", + "description": "When the version completed. Unset while the version is in progress.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "completed_by", + "description": "The user who completed the version (email or principal name).\nMay differ from `created_by` when another user force-completes\nthe version.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "completion_reason", + "description": "Why the version was completed. Unset while in progress.\nSet when status transitions to COMPLETED.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionComplete", + "enum": [ + { + "content": "VERSION_COMPLETE_FAILURE" + }, + { + "content": "VERSION_COMPLETE_FORCE_ABORT" + }, + { + "content": "VERSION_COMPLETE_LEASE_EXPIRED" + }, + { + "content": "VERSION_COMPLETE_SUCCESS" + } + ] + } + }, + { + "name": "create_time", + "description": "When the version was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The user who created the version (email or principal name).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "deployment_mode", + "description": "Bundle target deployment mode (development or production), captured at the\ntime of this version.", + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentMode", + "enum": [ + { + "content": "DEPLOYMENT_MODE_DEVELOPMENT" + }, + { + "content": "DEPLOYMENT_MODE_PRODUCTION" + } + ] + } + }, + { + "name": "display_name", + "description": "Display name for the deployment, captured at the time of this version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name of the version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of the version: IN_PROGRESS or COMPLETED.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionStatus", + "enum": [ + { + "content": "VERSION_STATUS_COMPLETED" + }, + { + "content": "VERSION_STATUS_IN_PROGRESS" + } + ] + } + }, + { + "name": "target_name", + "description": "Target name of the deployment, captured at the time of this version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_id", + "description": "Monotonically increasing version identifier within the parent\ndeployment. Assigned by the client on creation.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent deployment where this version will be created.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_id", + "description": "The version ID the caller expects to create. The server validates\nthis equals `last_version_id + 1` on the deployment. If it doesn't\nmatch, the server returns `ABORTED`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + }, + { + "name": "DeleteDeployment", + "description": "Deletes a deployment.\n\nThe deployment is marked as deleted. It and all its children (versions\nand their operations) will be permanently deleted after the retention\npolicy expires. If the deployment has an in-progress version, the\nserver returns `RESOURCE_CONFLICT`.", + "summary": "Delete a deployment.", + "path": "/api/2.0/bundle/{name=deployments/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteDeploymentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to delete.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to delete.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to delete.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the deployment to delete.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDeployment", + "description": "Retrieves a deployment by its resource name.", + "summary": "Get a deployment.", + "path": "/api/2.0/bundle/{name=deployments/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetDeploymentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to retrieve.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to retrieve.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Deployment", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the deployment to retrieve.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the deployment to retrieve.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetOperation", + "description": "Retrieves a resource operation by its resource name.", + "summary": "Get an operation.", + "path": "/api/2.0/bundle/{name=deployments/*/versions/*/operations/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetOperationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the resource operation to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the resource operation to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "action_type", + "description": "The type of operation performed on this resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationActionType", + "enum": [ + { + "content": "OPERATION_ACTION_TYPE_BIND" + }, + { + "content": "OPERATION_ACTION_TYPE_BIND_AND_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_CREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_DELETE" + }, + { + "content": "OPERATION_ACTION_TYPE_INITIAL_REGISTER" + }, + { + "content": "OPERATION_ACTION_TYPE_RECREATE" + }, + { + "content": "OPERATION_ACTION_TYPE_RESIZE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE" + }, + { + "content": "OPERATION_ACTION_TYPE_UPDATE_WITH_ID" + } + ] + } + }, + { + "name": "resource_id", + "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether the operation succeeded or failed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OperationStatus", + "enum": [ + { + "content": "OPERATION_STATUS_FAILED" + }, + { + "content": "OPERATION_STATUS_SUCCEEDED" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the resource operation to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the resource operation to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}/operations/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetResource", + "description": "Retrieves a deployment resource by its resource name.", + "summary": "Get a resource.", + "path": "/api/2.0/bundle/{name=deployments/*/resources/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetResourceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the resource to retrieve.\nFormat: deployments/{deployment_id}/resources/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the resource to retrieve.\nFormat: deployments/{deployment_id}/resources/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Resource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "resource_type", + "description": "The type of the deployment resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentResourceType", + "enum": [ + { + "content": "DEPLOYMENT_RESOURCE_TYPE_ALERT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_APP" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CLUSTER" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DASHBOARD" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_JOB" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_PIPELINE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SCHEMA" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "resource_type", + "description": "The type of the deployment resource.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DeploymentResourceType", + "enum": [ + { + "content": "DEPLOYMENT_RESOURCE_TYPE_ALERT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_APP" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_CLUSTER" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DASHBOARD" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_JOB" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_PIPELINE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SCHEMA" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE" + }, + { + "content": "DEPLOYMENT_RESOURCE_TYPE_VOLUME" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the resource to retrieve.\nFormat: deployments/{deployment_id}/resources/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the resource to retrieve.\nFormat: deployments/{deployment_id}/resources/{resource_key}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetVersion", + "description": "Retrieves a version by its resource name.", + "summary": "Get a version.", + "path": "/api/2.0/bundle/{name=deployments/*/versions/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the version to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the version to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Version", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "cli_version", + "description": "CLI version used to initiate the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_type", + "description": "Type of version (deploy or destroy).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VersionType", + "enum": [ + { + "content": "VERSION_TYPE_DEPLOY" + }, + { + "content": "VERSION_TYPE_DESTROY" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the version to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the version to retrieve.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Heartbeat", + "description": "Sends a heartbeat to renew the lock held by a version.\n\nThe server validates that the version is the active (non-terminal)\nversion on the parent deployment and resets the lock expiry. If the\nlock has already expired or the version is no longer active, the\nserver returns `ABORTED`.", + "summary": "Send a version heartbeat.", + "path": "/api/2.0/bundle/{name=deployments/*/versions/*}/heartbeat", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "HeartbeatRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The version whose lock to renew.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The version whose lock to renew.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "HeartbeatResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The version whose lock to renew.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The version whose lock to renew.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListDeployments", + "description": "Lists deployments in the workspace.", + "summary": "List deployments.", + "path": "/api/2.0/bundle/deployments", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListDeploymentsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListDeploymentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of deployments to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 deployments will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListDeployments` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListDeployments` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListOperations", + "description": "Lists resource operations under a version.", + "summary": "List operations.", + "path": "/api/2.0/bundle/{parent=deployments/*/versions/*}/operations", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListOperationsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListOperationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of operations to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 operations will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListOperations` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent version.\nFormat: deployments/{deployment_id}/versions/{version_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListOperations` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListResources", + "description": "Lists resources under a deployment.", + "summary": "List resources.", + "path": "/api/2.0/bundle/{parent=deployments/*}/resources", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListResourcesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListResourcesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of resources to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 resources will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListResources` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListResources` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListVersions", + "description": "Lists versions under a deployment, ordered by version_id descending\n(most recent first).", + "summary": "List versions.", + "path": "/api/2.0/bundle/{parent=deployments/*}/versions", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListVersionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of versions to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 versions will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListVersions` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent deployment.\nFormat: deployments/{deployment_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListVersions` call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "catalog.Catalogs", + "name": "Catalogs", + "description": "A catalog is the first layer of Unity Catalog’s three-level namespace. It’s used to organize\nyour data assets. Users can see all catalogs on which they have been assigned the USE_CATALOG\ndata permission.\n\nIn Unity Catalog, admins and data stewards manage users and their access to data centrally\nacross all of the workspaces in a Databricks account. Users in different workspaces can\nshare access to the same data, depending on privileges granted centrally in Unity Catalog.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCatalogsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege.", + "summary": "Create a catalog.", + "path": "/api/2.1/unity-catalog/catalogs", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CatalogInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "connection_name", + "description": "The name of the connection to an external data source.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "managed_encryption_settings", + "description": "Control CMK encryption for managed catalog data", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EncryptionSettings", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "provider_name", + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "share_name", + "description": "The name of the share under the share provider.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_root", + "description": "Storage root URL for managed tables within catalog.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog.", + "summary": "Delete a catalog.", + "path": "/api/2.1/unity-catalog/catalogs/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the catalog is not empty.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the specified catalog in a metastore.\nThe caller must be a metastore admin, the owner of the catalog, or a user that has the **USE_CATALOG** privilege set for their account.", + "summary": "Get a catalog.", + "path": "/api/2.1/unity-catalog/catalogs/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CatalogInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include catalogs in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of catalogs in the metastore.\nIf the caller is the metastore admin, all catalogs will be retrieved.\nOtherwise, only catalogs owned by the caller (or for which the caller has the **USE_CATALOG** privilege) will be retrieved.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List catalogs.", + "path": "/api/2.1/unity-catalog/catalogs", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCatalogsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListCatalogsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include catalogs in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_unbound", + "description": "Whether to include catalogs not bound to the workspace.\nEffective only if the user has permission to update the catalog–workspace binding.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of catalogs to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid catalogs are returned (not recommended).\n- Note: The number of returned catalogs might be less than the specified max_results size, even zero.\nThe only definitive indication that no further catalogs can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of catalogs to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid catalogs are returned (not recommended).\n- Note: The number of returned catalogs might be less than the specified max_results size, even zero.\nThe only definitive indication that no further catalogs can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates the catalog that matches the supplied name.\nThe caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog).", + "summary": "Update a catalog.", + "path": "/api/2.1/unity-catalog/catalogs/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCatalog", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CatalogInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_predictive_optimization", + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EnablePredictiveOptimization", + "enum": [ + { + "content": "DISABLE" + }, + { + "content": "ENABLE" + }, + { + "content": "INHERIT" + } + ] + } + }, + { + "name": "isolation_mode", + "description": "Whether the current securable is accessible from all workspaces or a specific set of workspaces.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogIsolationMode", + "enum": [ + { + "content": "ISOLATED" + }, + { + "content": "OPEN" + } + ] + } + }, + { + "name": "managed_encryption_settings", + "description": "Control CMK encryption for managed catalog data", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EncryptionSettings", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the catalog.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "owner", + "description": "Username of current owner of catalog.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "cleanrooms.CleanRoomAssetRevisions", + "name": "CleanRoomAssetRevisions", + "description": "Clean Room Asset Revisions denote new versions\nof uploaded assets (e.g. notebooks) in the clean room.", + "package": { + "name": "cleanrooms" + }, + "docs_group": "cleanrooms", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListCleanRoomAssetRevisionsRequest" + } + }, + "methods": [ + { + "name": "Get", + "description": "Get a specific revision of an asset", + "summary": "Get an asset revision.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}/revisions/{etag}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetCleanRoomAssetRevisionRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Revision etag to fetch. If not provided, the latest revision will be returned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Revision etag to fetch. If not provided, the latest revision will be returned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Revision etag to fetch. If not provided, the latest revision will be returned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Revision etag to fetch. If not provided, the latest revision will be returned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List revisions for an asset", + "summary": "List asset revisions.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}/revisions", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListCleanRoomAssetRevisionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListCleanRoomAssetRevisionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of asset revisions to return. Defaults to 10.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on the previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Only NOTEBOOK_FILE is supported.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on the previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "cleanrooms.CleanRoomAssets", + "name": "CleanRoomAssets", + "description": "Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared\nwith the clean room.", + "package": { + "name": "cleanrooms" + }, + "docs_group": "cleanrooms", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCleanRoomAssetsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a clean room asset —share an asset like a notebook or table into the clean room.\nFor each UC asset that is added through this method, the clean room owner must also have\nenough privilege on the asset to consume it.\nThe privilege must be maintained indefinitely for the clean room to be able to access the asset.\nTypically, you should use a group as the clean room owner.", + "summary": "Create an asset.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCleanRoomAssetRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "asset", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "asset", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "asset", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "added_at", + "description": "When the asset is added to the clean room, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "foreign_table", + "description": "Foreign table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetForeignTable", + "is_object": true + } + }, + { + "name": "foreign_table_local_details", + "description": "Local details for a foreign that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetForeignTableLocalDetails", + "is_object": true + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notebook", + "description": "Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetNotebook", + "is_object": true + } + }, + { + "name": "owner_collaborator_alias", + "description": "The alias of the collaborator who owns this asset", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of the asset", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetStatusEnum", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "PENDING" + }, + { + "content": "PERMISSION_DENIED" + } + ] + } + }, + { + "name": "table", + "description": "Table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetTable", + "is_object": true + } + }, + { + "name": "table_local_details", + "description": "Local details for a table that are only available to its owner.\nPresent if and only if **asset_type** is **TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetTableLocalDetails", + "is_object": true + } + }, + { + "name": "view", + "description": "View details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **VIEW**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetView", + "is_object": true + } + }, + { + "name": "view_local_details", + "description": "Local details for a view that are only available to its owner.\nPresent if and only if **asset_type** is **VIEW**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetViewLocalDetails", + "is_object": true + } + }, + { + "name": "volume_local_details", + "description": "Local details for a volume that are only available to its owner.\nPresent if and only if **asset_type** is **VOLUME**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetVolumeLocalDetails", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + }, + { + "name": "CreateCleanRoomAssetReview", + "description": "Submit an asset review", + "summary": "Create a review (e.g. approval) for an asset.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}/reviews", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateCleanRoomAssetReviewRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateCleanRoomAssetReviewResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "asset_type", + "description": "Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the asset", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "notebook_review", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NotebookVersionReview", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "Name of the asset", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a clean room asset - unshare/remove the asset from the clean room", + "summary": "Delete an asset.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCleanRoomAssetRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteCleanRoomAssetResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get the details of a clean room asset by its type and full name.", + "summary": "Get an asset.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCleanRoomAssetRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List assets.", + "summary": "List assets.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCleanRoomAssetsRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListCleanRoomAssetsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update a clean room asset. For example, updating the content of a notebook;\nchanging the shared partitions of a table; etc.", + "summary": "Update an asset.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCleanRoomAssetRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset", + "description": "The asset to update.\nThe asset's `name` and `asset_type` fields are used to identify the asset to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "asset", + "description": "The asset to update.\nThe asset's `name` and `asset_type` fields are used to identify the asset to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "asset", + "description": "The asset to update.\nThe asset's `name` and `asset_type` fields are used to identify the asset to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "asset", + "description": "The asset to update.\nThe asset's `name` and `asset_type` fields are used to identify the asset to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAsset", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + } + ] + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "added_at", + "description": "When the asset is added to the clean room, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "foreign_table", + "description": "Foreign table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetForeignTable", + "is_object": true + } + }, + { + "name": "foreign_table_local_details", + "description": "Local details for a foreign that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetForeignTableLocalDetails", + "is_object": true + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notebook", + "description": "Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetNotebook", + "is_object": true + } + }, + { + "name": "owner_collaborator_alias", + "description": "The alias of the collaborator who owns this asset", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of the asset", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAssetStatusEnum", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "PENDING" + }, + { + "content": "PERMISSION_DENIED" + } + ] + } + }, + { + "name": "table", + "description": "Table details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetTable", + "is_object": true + } + }, + { + "name": "table_local_details", + "description": "Local details for a table that are only available to its owner.\nPresent if and only if **asset_type** is **TABLE**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetTableLocalDetails", + "is_object": true + } + }, + { + "name": "view", + "description": "View details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **VIEW**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetView", + "is_object": true + } + }, + { + "name": "view_local_details", + "description": "Local details for a view that are only available to its owner.\nPresent if and only if **asset_type** is **VIEW**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetViewLocalDetails", + "is_object": true + } + }, + { + "name": "volume_local_details", + "description": "Local details for a volume that are only available to its owner.\nPresent if and only if **asset_type** is **VOLUME**", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomAssetVolumeLocalDetails", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "asset_type", + "description": "The type of the asset.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "CleanRoomAssetAssetType", + "enum": [ + { + "content": "FOREIGN_TABLE" + }, + { + "content": "NOTEBOOK_FILE" + }, + { + "content": "TABLE" + }, + { + "content": "VIEW" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "name", + "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "cleanrooms.CleanRoomAutoApprovalRules", + "name": "CleanRoomAutoApprovalRules", + "description": "Clean room auto-approval rules automatically create an approval on your behalf when an asset (e.g. notebook)\nmeeting specific criteria is shared in a clean room.", + "package": { + "name": "cleanrooms" + }, + "docs_group": "cleanrooms", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListCleanRoomAutoApprovalRulesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create an auto-approval rule", + "summary": "Create an auto-approval rule.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateCleanRoomAutoApprovalRuleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "auto_approval_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "auto_approval_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_approval_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a auto-approval rule by rule ID", + "summary": "Delete an auto-approval rule.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules/{rule_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteCleanRoomAutoApprovalRuleRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a auto-approval rule by rule ID", + "summary": "Get an auto-approval rule.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules/{rule_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetCleanRoomAutoApprovalRuleRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all auto-approval rules for the caller", + "summary": "List auto-approval rules.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListCleanRoomAutoApprovalRulesRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListCleanRoomAutoApprovalRulesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of auto-approval rules to return. Defaults to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update a auto-approval rule by rule ID", + "summary": "Update an auto-approval rule.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/auto-approval-rules/{rule_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateCleanRoomAutoApprovalRuleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "description": "A generated UUID identifying the rule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "auto_approval_rule", + "description": "The auto-approval rule to update. The rule_id field is used to identify the rule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "description": "A generated UUID identifying the rule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "auto_approval_rule", + "description": "The auto-approval rule to update. The rule_id field is used to identify the rule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "auto_approval_rule", + "description": "The auto-approval rule to update. The rule_id field is used to identify the rule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + }, + "response": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_approval_rule", + "description": "The auto-approval rule to update. The rule_id field is used to identify the rule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRule", + "is_object": true + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "description": "A generated UUID identifying the rule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "author_collaborator_alias", + "description": "Collaborator alias of the author covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "author_scope", + "description": "Scope of authors covered by the rule.\nOnly one of `author_collaborator_alias` and `author_scope` can be set.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAutoApprovalRuleAuthorScope", + "enum": [ + { + "content": "ANY_AUTHOR" + } + ] + } + }, + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Timestamp of when the rule was created, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "rule_id", + "description": "A generated UUID identifying the rule.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_owner_collaborator_alias", + "description": "The owner of the rule to whom the rule applies.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "runner_collaborator_alias", + "description": "Collaborator alias of the runner covered by the rule.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "The name of the clean room this auto-approval rule belongs to.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rule_id", + "description": "A generated UUID identifying the rule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "cleanrooms.CleanRoomTaskRuns", + "name": "CleanRoomTaskRuns", + "description": "Clean room task runs are the executions of notebooks in a clean room.", + "package": { + "name": "cleanrooms" + }, + "docs_group": "cleanrooms", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCleanRoomNotebookTaskRunsRequest" + } + }, + "methods": [ + { + "name": "List", + "description": "List all the historical notebook task runs in a clean room.", + "summary": "List notebook task runs.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/runs", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCleanRoomNotebookTaskRunsRequest", + "is_object": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListCleanRoomNotebookTaskRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "notebook_name", + "description": "Notebook name", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The maximum number of task runs to return. Currently ignored - all runs will be returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "cleanrooms.CleanRooms", + "name": "CleanRooms", + "description": "A clean room uses Delta Sharing and serverless compute to provide a secure\nand privacy-protecting environment where multiple parties can work together on\nsensitive enterprise data without direct access to each other's data.", + "package": { + "name": "cleanrooms" + }, + "docs_group": "cleanrooms", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCleanRoomsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a new clean room with the specified collaborators.\nThis method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status,\nusing the :method:cleanrooms/get method.\nWhen this method returns, the clean room will be in a PROVISIONING state, with only name, owner, comment, created_at and status populated.\nThe clean room will be usable once it enters an ACTIVE state.\n\nThe caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the\nmetastore.", + "summary": "Create a clean room.", + "path": "/api/2.0/clean-rooms", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCleanRoomRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoom", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "clean_room", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoom", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "clean_room", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoom", + "is_object": true + } + }, + "response": { + "pascal_name": "CleanRoom", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoom", + "is_object": true + } + }, + { + "name": "access_restricted", + "description": "Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html)", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomAccessRestricted", + "enum": [ + { + "content": "CSP_MISMATCH" + }, + { + "content": "NO_RESTRICTION" + } + ] + } + }, + { + "name": "comment", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "When the clean room was created, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "local_collaborator_alias", + "description": "The alias of the collaborator tied to the local clean room.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the clean room.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_catalog", + "description": "Output catalog of the clean room. It is an output only field. Output catalog is manipulated\nusing the separate CreateCleanRoomOutputCatalog API.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + }, + { + "name": "owner", + "description": "This is the Databricks username of the owner of the local clean room securable for permission management.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "remote_detailed_info", + "description": "Central clean room details. During creation, users need to specify\ncloud_vendor, region, and collaborators.global_metastore_id.\nThis field will not be filled in the ListCleanRooms call.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoomRemoteDetail", + "is_object": true + } + }, + { + "name": "status", + "description": "Clean room status.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomStatusEnum", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DELETED" + }, + { + "content": "FAILED" + }, + { + "content": "PROVISIONING" + } + ] + } + }, + { + "name": "updated_at", + "description": "When the clean room was last updated, in epoch milliseconds.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "ACTIVE" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "CleanRoom" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ] + } + }, + { + "name": "CreateOutputCatalog", + "description": "Create the output catalog of the clean room.", + "summary": "Create an output catalog.", + "path": "/api/2.0/clean-rooms/{clean_room_name}/output-catalogs", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCleanRoomOutputCatalogRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + }, + "response": { + "pascal_name": "CreateCleanRoomOutputCatalogResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalog", + "is_object": true + } + }, + { + "name": "catalog_name", + "description": "The name of the output catalog in UC.\nIt should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements).\nThe field will always exist if status is CREATED.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CleanRoomOutputCatalogOutputCatalogStatus", + "enum": [ + { + "content": "CREATED" + }, + { + "content": "NOT_CREATED" + }, + { + "content": "NOT_ELIGIBLE" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "clean_room_name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a clean room. After deletion, the clean room will be removed from the metastore.\nIf the other collaborators have not deleted the clean room, they will still have the clean room\nin their metastore, but it will be in a DELETED state\nand no operations other than deletion can be performed on it.", + "summary": "Delete a clean room.", + "path": "/api/2.0/clean-rooms/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCleanRoomRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get the details of a clean room given its name.", + "summary": "Get a clean room.", + "path": "/api/2.0/clean-rooms/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCleanRoomRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoom", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Get a list of all clean rooms of the metastore. Only clean rooms\nthe caller has access to are returned.", + "summary": "List clean rooms.", + "path": "/api/2.0/clean-rooms", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCleanRoomsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListCleanRoomsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of clean rooms to return (i.e., the page length). Defaults to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update a clean room.\nThe caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM** privilege, or\nbe metastore admin.\n\nWhen the caller is a metastore admin, only the __owner__ field can be updated.", + "summary": "Update a clean room.", + "path": "/api/2.0/clean-rooms/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCleanRoomRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CleanRoom", + "is_object": true + }, + "all_fields": [ + { + "name": "clean_room", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CleanRoom", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the clean room.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.ClusterPolicies", + "name": "ClusterPolicies", + "description": "You can use cluster policies to control users' ability to configure clusters based on a set of rules.\nThese rules specify which attributes or attribute values can be used during cluster creation.\nCluster policies have ACLs that limit their use to specific users and groups.\n\nWith cluster policies, you can:\n- Auto-install cluster libraries on the next restart by listing them in the policy's \"libraries\" field (Public Preview).\n- Limit users to creating clusters with the prescribed settings.\n- Simplify the user interface, enabling more users to create clusters, by fixing and hiding some fields.\n- Manage costs by setting limits on attributes that impact the hourly rate.\n\nCluster policy permissions limit which policies a user can select in the Policy drop-down when the user creates a cluster:\n- A user who has unrestricted cluster create permission can select the Unrestricted policy and create fully-configurable clusters.\n- A user who has both unrestricted cluster create permission and access to cluster policies can select the Unrestricted policy and policies they have access to.\n- A user that has access to only cluster policies, can select the policies they have access to.\n\nIf no policies exist in the workspace, the Policy drop-down doesn't appear.\nOnly admin users can create, edit, and delete policies. Admin users also have access to all policies.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "PolicyNameToPolicyIdMap" + }, + "request": { + "pascal_name": "ListClusterPoliciesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new policy with prescribed settings.", + "summary": "Create a new policy.", + "path": "/api/2.0/policies/clusters/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePolicy", + "is_object": true + }, + "response": { + "pascal_name": "CreatePolicyResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "definition", + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Additional human-readable description of the cluster policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + }, + { + "name": "max_clusters_per_user", + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "name", + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_family_definition_overrides", + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_family_id", + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.", + "summary": "Delete a cluster policy.", + "path": "/api/2.0/policies/clusters/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The ID of the policy to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy_id", + "description": "The ID of the policy to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeletePolicyResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The ID of the policy to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The ID of the policy to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Edit", + "description": "Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.", + "summary": "Update a cluster policy.", + "path": "/api/2.0/policies/clusters/edit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EditPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The ID of the policy to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy_id", + "description": "The ID of the policy to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditPolicyResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "definition", + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Additional human-readable description of the cluster policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + }, + { + "name": "max_clusters_per_user", + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "name", + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_family_definition_overrides", + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_family_id", + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_id", + "description": "The ID of the policy to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The ID of the policy to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a cluster policy entity. Creation and editing is available to admins only.", + "summary": "Get a cluster policy.", + "path": "/api/2.0/policies/clusters/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the Cluster Policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the Cluster Policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Policy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the Cluster Policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the Cluster Policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get cluster policy permission levels.", + "path": "/api/2.0/permissions/cluster-policies/{cluster_policy_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterPolicyPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetClusterPolicyPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root object.", + "summary": "Get cluster policy permissions.", + "path": "/api/2.0/permissions/cluster-policies/{cluster_policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterPolicyPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPolicyPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Returns a list of policies accessible by the requesting user.", + "summary": "List cluster policies.", + "path": "/api/2.0/policies/clusters/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListClusterPoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "sort_column", + "description": "The cluster policy attribute to sort by.\n* `POLICY_CREATION_TIME` - Sort result list by policy creation time.\n* `POLICY_NAME` - Sort result list by policy name.", + "is_query": true, + "entity": { + "pascal_name": "ListSortColumn", + "enum": [ + { + "content": "POLICY_CREATION_TIME" + }, + { + "content": "POLICY_NAME" + } + ] + } + }, + { + "name": "sort_order", + "description": "The order in which the policies get listed.\n* `DESC` - Sort result list in descending order.\n* `ASC` - Sort result list in ascending order.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ASC" + }, + { + "content": "DESC" + } + ] + } + } + ], + "pagination": {} + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set cluster policy permissions.", + "path": "/api/2.0/permissions/cluster-policies/{cluster_policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClusterPolicyPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPolicyPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterPolicyAccessControlRequestList", + "array_value": { + "pascal_name": "ClusterPolicyAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root object.", + "summary": "Update cluster policy permissions.", + "path": "/api/2.0/permissions/cluster-policies/{cluster_policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClusterPolicyPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPolicyPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterPolicyAccessControlRequestList", + "array_value": { + "pascal_name": "ClusterPolicyAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_policy_id", + "description": "The cluster policy for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.Clusters", + "name": "Clusters", + "description": "The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.\n\nDatabricks maps cluster node instance types to compute units known as DBUs. See the instance\ntype pricing page for a list of the supported instance types and their corresponding DBUs.\n\nA Databricks cluster is a set of computation resources and configurations on which you run\ndata engineering, data science, and data analytics workloads, such as production\nETL pipelines, streaming analytics, ad-hoc analytics, and machine learning.\n\nYou run these workloads as a set of commands in a notebook or as an automated job.\nDatabricks makes a distinction between all-purpose clusters and job clusters. You use\nall-purpose clusters to analyze data collaboratively using interactive notebooks. You use\njob clusters to run fast and robust automated jobs.\n\nYou can create an all-purpose cluster using the UI, CLI, or REST API. You can manually\nterminate and restart an all-purpose cluster. Multiple users can share such clusters to do\ncollaborative interactive analysis.\n\nIMPORTANT: Databricks retains cluster configuration information for terminated clusters for 30 days. To keep an all-purpose cluster configuration even after it has been\nterminated for more than 30 days, an administrator can pin a cluster to the cluster list.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ClusterDetailsClusterNameToClusterIdMap" + }, + "request": { + "pascal_name": "ListClustersRequest" + } + }, + "methods": [ + { + "name": "ChangeOwner", + "description": "Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform this operation. The service principal application ID can be supplied as an argument to `owner_username`.", + "summary": "Change cluster owner.", + "path": "/api/2.1/clusters/change-owner", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ChangeClusterOwner", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner_username", + "description": "New owner of the cluster_id after this RPC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner_username", + "description": "New owner of the cluster_id after this RPC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ChangeClusterOwnerResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner_username", + "description": "New owner of the cluster_id after this RPC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner_username", + "description": "New owner of the cluster_id after this RPC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Creates a new Spark cluster. This method will acquire new instances from the cloud provider\nif necessary. This method is asynchronous; the returned ``cluster_id`` can be used to poll the\ncluster status. When this method returns, the cluster will be in\na ``PENDING`` state. The cluster will be usable once it enters a ``RUNNING`` state.\nNote: Databricks may not be able to acquire some of the requested nodes, due to cloud provider\nlimitations (account limits, spot price, etc.) or transient network issues.\n\nIf Databricks acquires at least 85% of the requested on-demand nodes, cluster creation will succeed.\nOtherwise the cluster will terminate with an informative error message.\n\nRather than authoring the cluster's JSON definition from scratch, Databricks recommends filling out the\n[create compute UI](https://docs.databricks.com/compute/configure.html) and then copying the generated JSON definition from the UI.", + "summary": "Create new cluster.", + "path": "/api/2.1/clusters/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateClusterResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "apply_policy_default_values", + "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted.\nWhen set to false, only fixed values from the policy will be applied.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "autoscale", + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AutoScale", + "is_object": true + } + }, + { + "name": "autotermination_minutes", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "aws_attributes", + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsAttributes", + "is_object": true + } + }, + { + "name": "azure_attributes", + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureAttributes", + "is_object": true + } + }, + { + "name": "clone_from", + "description": "When specified, this clones libraries from a source cluster during the creation of a new cluster.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloneCluster", + "is_object": true + } + }, + { + "name": "cluster_log_conf", + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterLogConf", + "is_object": true + } + }, + { + "name": "cluster_name", + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "data_security_mode", + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSecurityMode", + "enum": [ + { + "content": "DATA_SECURITY_MODE_AUTO" + }, + { + "content": "DATA_SECURITY_MODE_DEDICATED" + }, + { + "content": "DATA_SECURITY_MODE_STANDARD" + }, + { + "content": "LEGACY_PASSTHROUGH" + }, + { + "content": "LEGACY_SINGLE_USER" + }, + { + "content": "LEGACY_SINGLE_USER_STANDARD" + }, + { + "content": "LEGACY_TABLE_ACL" + }, + { + "content": "NONE" + }, + { + "content": "SINGLE_USER" + }, + { + "content": "USER_ISOLATION" + } + ] + } + }, + { + "name": "docker_image", + "description": "Custom docker image BYOC", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DockerImage", + "is_object": true + } + }, + { + "name": "driver_instance_pool_id", + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "driver_node_type_flexibility", + "description": "Flexible node type configuration for the driver node.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NodeTypeFlexibility", + "is_object": true + } + }, + { + "name": "driver_node_type_id", + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_elastic_disk", + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_local_disk_encryption", + "description": "Whether to enable LUKS on cluster VMs' local disks", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "gcp_attributes", + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpAttributes", + "is_object": true + } + }, + { + "name": "init_scripts", + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "InitScriptInfoList", + "array_value": { + "pascal_name": "InitScriptInfo", + "is_object": true + } + } + }, + { + "name": "instance_pool_id", + "description": "The optional ID of the instance pool to which the cluster belongs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_single_node", + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "kind", + "is_request_body_field": true, + "entity": { + "pascal_name": "Kind", + "enum": [ + { + "content": "CLASSIC_PREVIEW" + } + ] + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "num_workers", + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "policy_id", + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "remote_disk_throughput", + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "runtime_engine", + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RuntimeEngine", + "enum": [ + { + "content": "NULL" + }, + { + "content": "PHOTON" + }, + { + "content": "STANDARD" + } + ] + } + }, + { + "name": "single_user_name", + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spark_conf", + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "spark_env_vars", + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ssh_public_keys", + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "total_initial_remote_disk_size", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "use_ml_runtime", + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "worker_node_type_flexibility", + "description": "Flexible node type configuration for worker nodes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NodeTypeFlexibility", + "is_object": true + } + }, + { + "name": "workload_type", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "WorkloadType", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "Delete", + "description": "Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously.\nOnce the termination has completed, the cluster will be in a `TERMINATED` state.\nIf the cluster is already in a `TERMINATING` or `TERMINATED` state, nothing will happen.", + "summary": "Terminate cluster.", + "path": "/api/2.1/clusters/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "TERMINATED" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "Edit", + "description": "Updates the configuration of a cluster to match the provided attributes and size.\nA cluster can be updated if it is in a `RUNNING` or `TERMINATED` state.\n\nIf a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes can take effect.\n\nIf a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`.\nThe next time it is started using the `clusters/start` API, the new attributes will take effect.\nAny attempt to update a cluster in any other state will be rejected with an `INVALID_STATE` error code.\n\nClusters created by the Databricks Jobs service cannot be edited.", + "summary": "Update cluster configuration.", + "path": "/api/2.1/clusters/edit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EditCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "ID of the cluster", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "ID of the cluster", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "apply_policy_default_values", + "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "autoscale", + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AutoScale", + "is_object": true + } + }, + { + "name": "autotermination_minutes", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "aws_attributes", + "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsAttributes", + "is_object": true + } + }, + { + "name": "azure_attributes", + "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureAttributes", + "is_object": true + } + }, + { + "name": "cluster_id", + "description": "ID of the cluster", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cluster_log_conf", + "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterLogConf", + "is_object": true + } + }, + { + "name": "cluster_name", + "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "data_security_mode", + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSecurityMode", + "enum": [ + { + "content": "DATA_SECURITY_MODE_AUTO" + }, + { + "content": "DATA_SECURITY_MODE_DEDICATED" + }, + { + "content": "DATA_SECURITY_MODE_STANDARD" + }, + { + "content": "LEGACY_PASSTHROUGH" + }, + { + "content": "LEGACY_SINGLE_USER" + }, + { + "content": "LEGACY_SINGLE_USER_STANDARD" + }, + { + "content": "LEGACY_TABLE_ACL" + }, + { + "content": "NONE" + }, + { + "content": "SINGLE_USER" + }, + { + "content": "USER_ISOLATION" + } + ] + } + }, + { + "name": "docker_image", + "description": "Custom docker image BYOC", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DockerImage", + "is_object": true + } + }, + { + "name": "driver_instance_pool_id", + "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "driver_node_type_flexibility", + "description": "Flexible node type configuration for the driver node.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NodeTypeFlexibility", + "is_object": true + } + }, + { + "name": "driver_node_type_id", + "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_elastic_disk", + "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_local_disk_encryption", + "description": "Whether to enable LUKS on cluster VMs' local disks", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "gcp_attributes", + "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpAttributes", + "is_object": true + } + }, + { + "name": "init_scripts", + "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "InitScriptInfoList", + "array_value": { + "pascal_name": "InitScriptInfo", + "is_object": true + } + } + }, + { + "name": "instance_pool_id", + "description": "The optional ID of the instance pool to which the cluster belongs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_single_node", + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "kind", + "is_request_body_field": true, + "entity": { + "pascal_name": "Kind", + "enum": [ + { + "content": "CLASSIC_PREVIEW" + } + ] + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "num_workers", + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "policy_id", + "description": "The ID of the cluster policy used to create the cluster if applicable.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "remote_disk_throughput", + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "runtime_engine", + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RuntimeEngine", + "enum": [ + { + "content": "NULL" + }, + { + "content": "PHOTON" + }, + { + "content": "STANDARD" + } + ] + } + }, + { + "name": "single_user_name", + "description": "Single user name if data_security_mode is `SINGLE_USER`", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spark_conf", + "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "spark_env_vars", + "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ssh_public_keys", + "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "total_initial_remote_disk_size", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "use_ml_runtime", + "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "worker_node_type_flexibility", + "description": "Flexible node type configuration for worker nodes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NodeTypeFlexibility", + "is_object": true + } + }, + { + "name": "workload_type", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "WorkloadType", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "ID of the cluster", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spark_version", + "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "Events", + "description": "Retrieves a list of events about the activity of a cluster.\nThis API is paginated. If there are more events to read, the response includes all the\nparameters necessary to request the next page of events.", + "summary": "List cluster activity events.", + "path": "/api/2.1/clusters/events", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetEvents", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to retrieve events about.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to retrieve events about.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetEventsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to retrieve events about.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "end_time", + "description": "The end time in epoch milliseconds.\nIf empty, returns events up to the current time.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "event_types", + "description": "An optional set of event types to filter on.\nIf empty, all event types are returned.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EventTypeList", + "array_value": { + "pascal_name": "EventType", + "enum": [ + { + "content": "ADD_NODES_FAILED" + }, + { + "content": "AUTOMATIC_CLUSTER_UPDATE" + }, + { + "content": "AUTOSCALING_BACKOFF" + }, + { + "content": "AUTOSCALING_FAILED" + }, + { + "content": "AUTOSCALING_STATS_REPORT" + }, + { + "content": "CLUSTER_MIGRATED" + }, + { + "content": "CREATING" + }, + { + "content": "DBFS_DOWN" + }, + { + "content": "DECOMMISSION_ENDED" + }, + { + "content": "DECOMMISSION_STARTED" + }, + { + "content": "DID_NOT_EXPAND_DISK" + }, + { + "content": "DRIVER_HEALTHY" + }, + { + "content": "DRIVER_NOT_RESPONDING" + }, + { + "content": "DRIVER_UNAVAILABLE" + }, + { + "content": "EDITED" + }, + { + "content": "EXPANDED_DISK" + }, + { + "content": "FAILED_TO_EXPAND_DISK" + }, + { + "content": "INIT_SCRIPTS_FINISHED" + }, + { + "content": "INIT_SCRIPTS_STARTED" + }, + { + "content": "METASTORE_DOWN" + }, + { + "content": "NODES_LOST" + }, + { + "content": "NODE_BLACKLISTED" + }, + { + "content": "NODE_EXCLUDED_DECOMMISSIONED" + }, + { + "content": "PINNED" + }, + { + "content": "RESIZING" + }, + { + "content": "RESTARTING" + }, + { + "content": "RUNNING" + }, + { + "content": "SPARK_EXCEPTION" + }, + { + "content": "STARTING" + }, + { + "content": "TERMINATING" + }, + { + "content": "UC_VOLUME_MISCONFIGURED" + }, + { + "content": "UNPINNED" + }, + { + "content": "UPSIZE_COMPLETED" + } + ] + } + } + }, + { + "name": "limit", + "description": "Deprecated: use page_token in combination with page_size instead.\n\nThe maximum number of events to include in a page of events.\nDefaults to 50, and maximum allowed value is 500.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "offset", + "description": "Deprecated: use page_token in combination with page_size instead.\n\nThe offset in the result set. Defaults to 0 (no offset). When an offset is specified\nand the results are requested in descending order, the end_time field is required.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "order", + "description": "The order to list events in; either \"ASC\" or \"DESC\". Defaults to \"DESC\".", + "is_request_body_field": true, + "entity": { + "pascal_name": "GetEventsOrder", + "enum": [ + { + "content": "ASC" + }, + { + "content": "DESC" + } + ] + } + }, + { + "name": "page_size", + "description": "The maximum number of events to include in a page of events.\nThe server may further constrain the maximum number of results returned in a single page.\nIf the page_size is empty or 0, the server will decide the number of results to be returned.\nThe field has to be in the range [0,500]. If the value is outside the range, the server enforces 0 or 500.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively.\nIf page_token is empty, the first page is returned.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "start_time", + "description": "The start time in epoch milliseconds.\nIf empty, returns events starting from the beginning of time.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to retrieve events about.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of events respectively.\nIf page_token is empty, the first page is returned.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Get", + "description": "Retrieves the information for a cluster given its identifier.\nClusters can be described while they are running, or up to 60 days after they are terminated.", + "summary": "Get cluster info.", + "path": "/api/2.1/clusters/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster about which to retrieve information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The cluster about which to retrieve information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterDetails", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster about which to retrieve information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster about which to retrieve information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get cluster permission levels.", + "path": "/api/2.0/permissions/clusters/{cluster_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetClusterPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a cluster. Clusters can inherit permissions from their root object.", + "summary": "Get cluster permissions.", + "path": "/api/2.0/permissions/clusters/{cluster_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Return information about all pinned and active clusters, and all clusters terminated within the last 30 days. Clusters terminated prior to this period are not included.", + "summary": "List clusters.", + "path": "/api/2.1/clusters/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListClustersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListClustersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter_by", + "description": "Filters to apply to the list of clusters.", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ListClustersFilterBy", + "is_object": true + } + }, + { + "name": "page_size", + "description": "Use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sort_by", + "description": "Sort the list of clusters by a specific criteria.", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ListClustersSortBy", + "is_object": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListNodeTypes", + "description": "Returns a list of supported Spark node types. These node types can be used to launch a cluster.", + "summary": "List node types.", + "path": "/api/2.1/clusters/list-node-types", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListNodeTypesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListNodeTypesResponse", + "is_object": true + } + }, + { + "name": "ListZones", + "description": "Returns a list of availability zones where clusters can be created in (For example, us-west-2a).\nThese zones can be used to launch a cluster.", + "summary": "List availability zones.", + "path": "/api/2.1/clusters/list-zones", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListZonesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAvailableZonesResponse", + "is_object": true + } + }, + { + "name": "PermanentDelete", + "description": "Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously removed.\n\nIn addition, users will no longer see permanently deleted clusters in the cluster list, and API users can no longer\nperform any action on permanently deleted clusters.", + "summary": "Permanently delete cluster.", + "path": "/api/2.1/clusters/permanent-delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PermanentDeleteCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PermanentDeleteClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster to be deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Pin", + "description": "Pinning a cluster ensures that the cluster will always be returned by the ListClusters API.\nPinning a cluster that is already pinned will have no effect.\nThis API can only be called by workspace admins.", + "summary": "Pin cluster.", + "path": "/api/2.1/clusters/pin", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PinCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PinClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Resize", + "description": "Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a `RUNNING` state.", + "summary": "Resize cluster.", + "path": "/api/2.1/clusters/resize", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ResizeCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be resized.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be resized.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResizeClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "autoscale", + "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AutoScale", + "is_object": true + } + }, + { + "name": "cluster_id", + "description": "The cluster to be resized.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "num_workers", + "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster to be resized.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "Restart", + "description": "Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a `RUNNING` state, nothing will happen.", + "summary": "Restart cluster.", + "path": "/api/2.1/clusters/restart", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestartCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestartClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "restart_user", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set cluster permissions.", + "path": "/api/2.0/permissions/clusters/{cluster_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClusterPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAccessControlRequestList", + "array_value": { + "pascal_name": "ClusterAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SparkVersions", + "description": "Returns the list of available Spark versions. These versions can be used to launch a cluster.", + "summary": "List available Spark versions.", + "path": "/api/2.1/clusters/spark-versions", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SparkVersionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetSparkVersionsResponse", + "is_object": true + } + }, + { + "name": "Start", + "description": "Starts a terminated Spark cluster with the supplied ID. This works similar to `createCluster` except:\n- The previous cluster id and attributes are preserved.\n- The cluster starts with the last specified cluster size.\n- If the previous cluster was an autoscaling cluster, the current cluster starts with\nthe minimum number of nodes.\n- If the cluster is not currently in a ``TERMINATED`` state, nothing will happen.\n- Clusters launched to run a job cannot be started.", + "summary": "Start terminated cluster.", + "path": "/api/2.1/clusters/start", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StartCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StartClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster to be started.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "Unpin", + "description": "Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API.\nUnpinning a cluster that is not pinned will have no effect.\nThis API can only be called by workspace admins.", + "summary": "Unpin cluster.", + "path": "/api/2.1/clusters/unpin", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UnpinCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UnpinClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the configuration of a cluster to match the partial set of attributes and size.\nDenote which fields to update using the `update_mask` field in the request body.\nA cluster can be updated if it is in a `RUNNING` or `TERMINATED` state.\nIf a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes can take effect.\nIf a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`.\nThe updated attributes will take effect the next time the cluster is started using the `clusters/start` API.\nAttempts to update a cluster in any other state will be rejected with an `INVALID_STATE` error code.\nClusters created by the Databricks Jobs service cannot be updated.", + "summary": "Update cluster configuration (partial).", + "path": "/api/2.1/clusters/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCluster", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "ID of the cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "ID of the cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateClusterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster", + "description": "The cluster to be updated.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateClusterResource", + "is_object": true + } + }, + { + "name": "cluster_id", + "description": "ID of the cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "ID of the cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details.\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ClusterDetails" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "StateMessage" + } + } + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a cluster. Clusters can inherit permissions from their root object.", + "summary": "Update cluster permissions.", + "path": "/api/2.0/permissions/clusters/{cluster_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClusterPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ClusterAccessControlRequestList", + "array_value": { + "pascal_name": "ClusterAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The cluster for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.CommandExecution", + "name": "CommandExecution", + "description": "This API allows execution of Python, Scala, SQL, or R commands on running\nDatabricks Clusters. This API only supports (classic) all-purpose clusters.\nServerless compute is not supported.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Cancel", + "description": "Cancels a currently running command within an execution context.\n\nThe command ID is obtained from a prior successful call to __execute__.", + "summary": "Cancel a command.", + "path": "/api/1.2/commands/cancel", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CancelCommand", + "is_object": true + }, + "response": { + "pascal_name": "CancelResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "clusterId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "commandId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "Cancelled" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "CommandStatusResponse" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ], + "message_path": [ + { + "pascal_name": "Results" + }, + { + "pascal_name": "Cause" + } + ], + "message_path_head": { + "pascal_name": "Results" + } + } + }, + { + "name": "CommandStatus", + "description": "Gets the status of and, if available, the results from a currently executing command.\n\nThe command ID is obtained from a prior successful call to __execute__.", + "summary": "Get command info.", + "path": "/api/1.2/commands/status", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CommandStatusRequest", + "is_object": true, + "required_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "commandId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "commandId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CommandStatusResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "commandId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "commandId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ContextStatus", + "description": "Gets the status for an execution context.", + "summary": "Get status.", + "path": "/api/1.2/contexts/status", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ContextStatusRequest", + "is_object": true, + "required_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ContextStatusResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clusterId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Creates an execution context for running cluster commands.\n\nIf successful, this method returns the ID of the new execution context.", + "summary": "Create an execution context.", + "path": "/api/1.2/contexts/create", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateContext", + "is_object": true + }, + "response": { + "pascal_name": "Created", + "is_object": true + }, + "all_fields": [ + { + "name": "clusterId", + "description": "Running cluster id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "language", + "is_request_body_field": true, + "entity": { + "pascal_name": "Language", + "enum": [ + { + "content": "python" + }, + { + "content": "r" + }, + { + "content": "scala" + }, + { + "content": "sql" + } + ] + } + } + ], + "wait": { + "success": [ + { + "content": "Running" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ContextStatusResponse" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ] + } + }, + { + "name": "Destroy", + "description": "Deletes an execution context.", + "summary": "Delete an execution context.", + "path": "/api/1.2/contexts/destroy", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DestroyContext", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "clusterId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "clusterId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DestroyResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "clusterId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "clusterId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Execute", + "description": "Runs a cluster command in the given execution context, using the provided language.\n\nIf successful, it returns an ID for tracking the status of the command's execution.", + "summary": "Run a command.", + "path": "/api/1.2/commands/execute", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Command", + "is_object": true + }, + "response": { + "pascal_name": "Created", + "is_object": true + }, + "all_fields": [ + { + "name": "clusterId", + "description": "Running cluster id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "command", + "description": "Executable code", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "contextId", + "description": "Running context id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "language", + "is_request_body_field": true, + "entity": { + "pascal_name": "Language", + "enum": [ + { + "content": "python" + }, + { + "content": "r" + }, + { + "content": "scala" + }, + { + "content": "sql" + } + ] + } + } + ], + "wait": { + "success": [ + { + "content": "Finished" + }, + { + "content": "Error" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "CommandStatusResponse" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ] + } + } + ] + }, + { + "id": "settings.ComplianceSecurityProfile", + "name": "ComplianceSecurityProfile", + "description": "Controls whether to enable the compliance security profile for the current workspace. Enabling it on a workspace is permanent.\nBy default, it is turned off.\n\nThis settings can NOT be disabled once it is enabled.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Get", + "description": "Gets the compliance security profile setting.", + "summary": "Get the compliance security profile setting.", + "path": "/api/2.0/settings/types/shield_csp_enablement_ws_db/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetComplianceSecurityProfileSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "ComplianceSecurityProfileSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "compliance_security_profile_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfile", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "compliance_security_profile_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfile", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the compliance security profile setting for the workspace. A fresh etag needs\nto be provided in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`\nrequest before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the\nrequest must be retried by using the fresh etag in the 409 response.", + "summary": "Update the compliance security profile setting.", + "path": "/api/2.0/settings/types/shield_csp_enablement_ws_db/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateComplianceSecurityProfileSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfileSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfileSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ComplianceSecurityProfileSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "compliance_security_profile_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfile", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "compliance_security_profile_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfile", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplianceSecurityProfileSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "catalog.Connections", + "name": "Connections", + "description": "Connections allow for creating a connection to an external data source.\n\nA connection is an abstraction of an external data source that can be connected from Databricks Compute.\nCreating a connection object is the first step to managing external data sources within Unity Catalog, with\nthe second step being creating a data object (catalog, schema, or table) using the connection. Data objects\nderived from a connection can be written to or read from similar to other Unity Catalog data objects based on\ncloud storage. Users may create different types of connections with each connection having a unique set of\nconfiguration options to support credential management and other settings.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ConnectionInfoNameToFullNameMap" + }, + "request": { + "pascal_name": "ListConnectionsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new connection\n\nCreates a new connection to an external data source. It allows users to specify connection details and\nconfigurations for interaction with the external server.", + "summary": "Create a connection.", + "path": "/api/2.1/unity-catalog/connections", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateConnection", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "connection_type", + "description": "The type of connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConnectionType", + "enum": [ + { + "content": "BIGQUERY" + }, + { + "content": "CONFLUENCE" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GA4_RAW_DATA" + }, + { + "content": "GITHUB" + }, + { + "content": "GLUE" + }, + { + "content": "HIVE_METASTORE" + }, + { + "content": "HTTP" + }, + { + "content": "HUBSPOT" + }, + { + "content": "META_MARKETING" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OUTLOOK" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "REDSHIFT" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SALESFORCE_DATA_CLOUD" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SMARTSHEET" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "SQLDW" + }, + { + "content": "SQLSERVER" + }, + { + "content": "TERADATA" + }, + { + "content": "UNKNOWN_CONNECTION_TYPE" + }, + { + "content": "WORKDAY_RAAS" + }, + { + "content": "ZENDESK" + } + ] + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "connection_type", + "description": "The type of connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConnectionType", + "enum": [ + { + "content": "BIGQUERY" + }, + { + "content": "CONFLUENCE" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GA4_RAW_DATA" + }, + { + "content": "GITHUB" + }, + { + "content": "GLUE" + }, + { + "content": "HIVE_METASTORE" + }, + { + "content": "HTTP" + }, + { + "content": "HUBSPOT" + }, + { + "content": "META_MARKETING" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OUTLOOK" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "REDSHIFT" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SALESFORCE_DATA_CLOUD" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SMARTSHEET" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "SQLDW" + }, + { + "content": "SQLSERVER" + }, + { + "content": "TERADATA" + }, + { + "content": "UNKNOWN_CONNECTION_TYPE" + }, + { + "content": "WORKDAY_RAAS" + }, + { + "content": "ZENDESK" + } + ] + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ] + }, + "response": { + "pascal_name": "ConnectionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "connection_type", + "description": "The type of connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConnectionType", + "enum": [ + { + "content": "BIGQUERY" + }, + { + "content": "CONFLUENCE" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GA4_RAW_DATA" + }, + { + "content": "GITHUB" + }, + { + "content": "GLUE" + }, + { + "content": "HIVE_METASTORE" + }, + { + "content": "HTTP" + }, + { + "content": "HUBSPOT" + }, + { + "content": "META_MARKETING" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OUTLOOK" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "REDSHIFT" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SALESFORCE_DATA_CLOUD" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SMARTSHEET" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "SQLDW" + }, + { + "content": "SQLSERVER" + }, + { + "content": "TERADATA" + }, + { + "content": "UNKNOWN_CONNECTION_TYPE" + }, + { + "content": "WORKDAY_RAAS" + }, + { + "content": "ZENDESK" + } + ] + } + }, + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "read_only", + "description": "If the connection is read only.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the connection that matches the supplied name.", + "summary": "Delete a connection.", + "path": "/api/2.1/unity-catalog/connections/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteConnectionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the connection to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the connection to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the connection to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the connection to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a connection from it's name.", + "summary": "Get a connection.", + "path": "/api/2.1/unity-catalog/connections/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetConnectionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ConnectionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all connections.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List connections.", + "path": "/api/2.1/unity-catalog/connections", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListConnectionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListConnectionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of connections to return.\n- If not set, all connections are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of connections to return.\n- If not set, all connections are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates the connection that matches the supplied name.", + "summary": "Update a connection.", + "path": "/api/2.1/unity-catalog/connections/{name}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateConnection", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ] + }, + "response": { + "pascal_name": "ConnectionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the connection.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "A map of key-value properties attached to the securable.", + "required": true, + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "owner", + "description": "Username of current owner of the connection.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the connection.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ConsumerFulfillments", + "name": "ConsumerFulfillments", + "description": "Fulfillments are entities that allow consumers to preview installations.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "GetListingContentMetadataRequest" + } + }, + "methods": [ + { + "name": "Get", + "description": "Get a high level preview of the metadata of listing installable content.", + "summary": "Get listing content metadata.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/content", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetListingContentMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetListingContentMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "List", + "description": "Get all listings fulfillments associated with a listing. A _fulfillment_ is a potential installation.\nStandard installations contain metadata about the attached share or git repo. Only one of these fields will be present.\nPersonalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.", + "summary": "List all listing fulfillments.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/fulfillments", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListFulfillmentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFulfillmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "marketplace.ConsumerInstallations", + "name": "ConsumerInstallations", + "description": "Installations are entities that allow consumers to interact with Databricks Marketplace listings.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListAllInstallationsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Install payload associated with a Databricks Marketplace listing.", + "summary": "Install from a listing.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/installations", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateInstallationRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Installation", + "is_object": true + }, + "all_fields": [ + { + "name": "accepted_consumer_terms", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ConsumerTerms", + "is_object": true + } + }, + { + "name": "catalog_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_type", + "is_request_body_field": true, + "entity": { + "pascal_name": "DeltaSharingRecipientType", + "enum": [ + { + "content": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS" + }, + { + "content": "DELTA_SHARING_RECIPIENT_TYPE_OPEN" + } + ] + } + }, + { + "name": "repo_detail", + "description": "for git repo installations", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RepoInstallation", + "is_object": true + } + }, + { + "name": "share_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Uninstall an installation associated with a Databricks Marketplace listing.", + "summary": "Uninstall from a listing.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/installations/{installation_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteInstallationRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteInstallationResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all installations across all listings.", + "summary": "List all installations.", + "path": "/api/2.1/marketplace-consumer/installations", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListAllInstallationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAllInstallationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListListingInstallations", + "description": "List all installations for a particular listing.", + "summary": "List installations for a listing.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/installations", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListInstallationsRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListInstallationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "This is a update API that will update the part of the fields defined in the installation table as well\nas interact with external services according to the fields not included in the installation table\n1. the token will be rotate if the rotateToken flag is true\n2. the token will be forcibly rotate if the rotateToken flag is true and the tokenInfo field is empty", + "summary": "Update an installation.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/installations/{installation_id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateInstallationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "InstallationDetail", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "installation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "InstallationDetail", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateInstallationResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "installation", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "InstallationDetail", + "is_object": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rotate_token", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "installation_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ConsumerListings", + "name": "ConsumerListings", + "description": "Listings are the core entities in the Marketplace. They represent the products that are available for consumption.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ListingSummaryNameToIdMap" + }, + "request": { + "pascal_name": "ListListingsRequest" + } + }, + "methods": [ + { + "name": "BatchGet", + "description": "Batch get a published listing in the Databricks Marketplace that the consumer has access to.", + "summary": "Get one batch of listings. One may specify up to 50 IDs per request.", + "path": "/api/2.1/marketplace-consumer/listings:batchGet", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "BatchGetListingsRequest", + "is_object": true + }, + "response": { + "pascal_name": "BatchGetListingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ids", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "Get", + "description": "Get a published listing in the Databricks Marketplace that the consumer has access to.", + "summary": "Get listing.", + "path": "/api/2.1/marketplace-consumer/listings/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetListingRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all published listings in the Databricks Marketplace that the consumer has access to.", + "summary": "List listings.", + "path": "/api/2.1/marketplace-consumer/listings", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListListingsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListListingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "assets", + "description": "Matches any of the following asset types", + "is_query": true, + "entity": { + "pascal_name": "AssetTypeList", + "array_value": { + "pascal_name": "AssetType", + "enum": [ + { + "content": "ASSET_TYPE_APP" + }, + { + "content": "ASSET_TYPE_DATA_TABLE" + }, + { + "content": "ASSET_TYPE_GIT_REPO" + }, + { + "content": "ASSET_TYPE_MCP" + }, + { + "content": "ASSET_TYPE_MEDIA" + }, + { + "content": "ASSET_TYPE_MODEL" + }, + { + "content": "ASSET_TYPE_NOTEBOOK" + }, + { + "content": "ASSET_TYPE_PARTNER_INTEGRATION" + } + ] + } + } + }, + { + "name": "categories", + "description": "Matches any of the following categories", + "is_query": true, + "entity": { + "pascal_name": "CategoryList", + "array_value": { + "pascal_name": "Category", + "enum": [ + { + "content": "ADVERTISING_AND_MARKETING" + }, + { + "content": "CLIMATE_AND_ENVIRONMENT" + }, + { + "content": "COMMERCE" + }, + { + "content": "DEMOGRAPHICS" + }, + { + "content": "ECONOMICS" + }, + { + "content": "EDUCATION" + }, + { + "content": "ENERGY" + }, + { + "content": "FINANCIAL" + }, + { + "content": "GAMING" + }, + { + "content": "GEOSPATIAL" + }, + { + "content": "HEALTH" + }, + { + "content": "LOOKUP_TABLES" + }, + { + "content": "MANUFACTURING" + }, + { + "content": "MEDIA" + }, + { + "content": "OTHER" + }, + { + "content": "PUBLIC_SECTOR" + }, + { + "content": "RETAIL" + }, + { + "content": "SCIENCE_AND_RESEARCH" + }, + { + "content": "SECURITY" + }, + { + "content": "SPORTS" + }, + { + "content": "TRANSPORTATION_AND_LOGISTICS" + }, + { + "content": "TRAVEL_AND_TOURISM" + } + ] + } + } + }, + { + "name": "is_free", + "description": "Filters each listing based on if it is free.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "is_private_exchange", + "description": "Filters each listing based on if it is a private exchange.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "is_staff_pick", + "description": "Filters each listing based on whether it is a staff pick.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider_ids", + "description": "Matches any of the following provider ids", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "tags", + "description": "Matches listings with this tag", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ListingTag", + "is_object": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Search", + "description": "Search published listings in the Databricks Marketplace that the consumer has access to.\nThis query supports a variety of different search parameters and performs fuzzy matching.", + "summary": "Search listings.", + "path": "/api/2.1/marketplace-consumer/search-listings", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "SearchListingsRequest", + "is_object": true, + "required_fields": [ + { + "name": "query", + "description": "Fuzzy matches query", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "query", + "description": "Fuzzy matches query", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SearchListingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "assets", + "description": "Matches any of the following asset types", + "is_query": true, + "entity": { + "pascal_name": "AssetTypeList", + "array_value": { + "pascal_name": "AssetType", + "enum": [ + { + "content": "ASSET_TYPE_APP" + }, + { + "content": "ASSET_TYPE_DATA_TABLE" + }, + { + "content": "ASSET_TYPE_GIT_REPO" + }, + { + "content": "ASSET_TYPE_MCP" + }, + { + "content": "ASSET_TYPE_MEDIA" + }, + { + "content": "ASSET_TYPE_MODEL" + }, + { + "content": "ASSET_TYPE_NOTEBOOK" + }, + { + "content": "ASSET_TYPE_PARTNER_INTEGRATION" + } + ] + } + } + }, + { + "name": "categories", + "description": "Matches any of the following categories", + "is_query": true, + "entity": { + "pascal_name": "CategoryList", + "array_value": { + "pascal_name": "Category", + "enum": [ + { + "content": "ADVERTISING_AND_MARKETING" + }, + { + "content": "CLIMATE_AND_ENVIRONMENT" + }, + { + "content": "COMMERCE" + }, + { + "content": "DEMOGRAPHICS" + }, + { + "content": "ECONOMICS" + }, + { + "content": "EDUCATION" + }, + { + "content": "ENERGY" + }, + { + "content": "FINANCIAL" + }, + { + "content": "GAMING" + }, + { + "content": "GEOSPATIAL" + }, + { + "content": "HEALTH" + }, + { + "content": "LOOKUP_TABLES" + }, + { + "content": "MANUFACTURING" + }, + { + "content": "MEDIA" + }, + { + "content": "OTHER" + }, + { + "content": "PUBLIC_SECTOR" + }, + { + "content": "RETAIL" + }, + { + "content": "SCIENCE_AND_RESEARCH" + }, + { + "content": "SECURITY" + }, + { + "content": "SPORTS" + }, + { + "content": "TRANSPORTATION_AND_LOGISTICS" + }, + { + "content": "TRAVEL_AND_TOURISM" + } + ] + } + } + }, + { + "name": "is_free", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "is_private_exchange", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider_ids", + "description": "Matches any of the following provider ids", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "query", + "description": "Fuzzy matches query", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "query", + "description": "Fuzzy matches query", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "marketplace.ConsumerPersonalizationRequests", + "name": "ConsumerPersonalizationRequests", + "description": "Personalization Requests allow customers to interact with the individualized Marketplace listing flow.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListAllPersonalizationRequestsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a personalization request for a listing.", + "summary": "Create a personalization request.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/personalization-requests", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreatePersonalizationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "intended_use", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "accepted_consumer_terms", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConsumerTerms", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "intended_use", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "accepted_consumer_terms", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConsumerTerms", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreatePersonalizationRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "accepted_consumer_terms", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ConsumerTerms", + "is_object": true + } + }, + { + "name": "comment", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "company", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "first_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "intended_use", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_from_lighthouse", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "last_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_type", + "is_request_body_field": true, + "entity": { + "pascal_name": "DeltaSharingRecipientType", + "enum": [ + { + "content": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS" + }, + { + "content": "DELTA_SHARING_RECIPIENT_TYPE_OPEN" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get the personalization request for a listing. Each consumer can make at *most* one personalization request for a listing.", + "summary": "Get the personalization request for a listing.", + "path": "/api/2.1/marketplace-consumer/listings/{listing_id}/personalization-requests", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPersonalizationRequestRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPersonalizationRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List personalization requests for a consumer across all listings.", + "summary": "List all personalization requests.", + "path": "/api/2.1/marketplace-consumer/personalization-requests", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListAllPersonalizationRequestsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAllPersonalizationRequestsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "marketplace.ConsumerProviders", + "name": "ConsumerProviders", + "description": "Providers are the entities that publish listings to the Marketplace.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ProviderInfoNameToIdMap" + }, + "request": { + "pascal_name": "ListConsumerProvidersRequest" + } + }, + "methods": [ + { + "name": "BatchGet", + "description": "Batch get a provider in the Databricks Marketplace with at least one visible listing.", + "summary": "Get one batch of providers. One may specify up to 50 IDs per request.", + "path": "/api/2.1/marketplace-consumer/providers:batchGet", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "BatchGetProvidersRequest", + "is_object": true + }, + "response": { + "pascal_name": "BatchGetProvidersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ids", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "Get", + "description": "Get a provider in the Databricks Marketplace with at least one visible listing.", + "summary": "Get a provider.", + "path": "/api/2.1/marketplace-consumer/providers/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetProviderRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetProviderResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all providers in the Databricks Marketplace with at least one visible listing.", + "summary": "List providers.", + "path": "/api/2.1/marketplace-consumer/providers", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListConsumerProvidersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListProvidersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "is_featured", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "catalog.Credentials", + "name": "Credentials", + "description": "A credential represents an authentication and authorization mechanism for accessing services on your cloud tenant. Each credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential.\n\nTo create credentials, you must be a Databricks account admin or have the `CREATE SERVICE CREDENTIAL` privilege. The user who creates the credential can delegate ownership to another user or group to manage permissions on it.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCredentialsRequest" + } + }, + "methods": [ + { + "name": "CreateCredential", + "description": "Creates a new credential. The type of credential to be created is determined by the **purpose** field,\nwhich should be either **SERVICE** or **STORAGE**.\n\nThe caller must be a metastore admin or have the metastore privilege **CREATE_STORAGE_CREDENTIAL** for storage\ncredentials, or **CREATE_SERVICE_CREDENTIAL** for service credentials.", + "summary": "Create a credential.", + "path": "/api/2.1/unity-catalog/credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCredentialRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "description": "The AWS IAM role configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRole", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "description": "The Azure managed identity configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentity", + "is_object": true + } + }, + { + "name": "azure_service_principal", + "description": "The Azure service principal configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureServicePrincipal", + "is_object": true + } + }, + { + "name": "comment", + "description": "Comment associated with the credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "databricks_gcp_service_account", + "description": "The Databricks managed GCP service account configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccount", + "is_object": true + } + }, + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purpose", + "description": "Indicates the purpose of the credential.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CredentialPurpose", + "enum": [ + { + "content": "SERVICE" + }, + { + "content": "STORAGE" + } + ] + } + }, + { + "name": "read_only", + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Optional. Supplying true to this argument skips validation of the created\nset of credentials.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteCredential", + "description": "Deletes a service or storage credential from the metastore. The caller must be an owner of the credential.", + "summary": "Delete a credential.", + "path": "/api/2.1/unity-catalog/credentials/{name_arg}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteCredentialResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**).", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenerateTemporaryServiceCredential", + "description": "Returns a set of temporary credentials generated using the specified service credential.\nThe caller must be a metastore admin or have the metastore privilege **ACCESS** on the service credential.", + "summary": "Generate a temporary service credential.", + "path": "/api/2.1/unity-catalog/temporary-service-credentials", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenerateTemporaryServiceCredentialRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "credential_name", + "description": "The name of the service credential used to generate a temporary credential", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "credential_name", + "description": "The name of the service credential used to generate a temporary credential", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TemporaryCredentials", + "is_object": true + }, + "all_fields": [ + { + "name": "azure_options", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GenerateTemporaryServiceCredentialAzureOptions", + "is_object": true + } + }, + { + "name": "credential_name", + "description": "The name of the service credential used to generate a temporary credential", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gcp_options", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GenerateTemporaryServiceCredentialGcpOptions", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credential_name", + "description": "The name of the service credential used to generate a temporary credential", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCredential", + "description": "Gets a service or storage credential from the metastore.\nThe caller must be a metastore admin, the owner of the credential, or have any permission on the credential.", + "summary": "Get a credential.", + "path": "/api/2.1/unity-catalog/credentials/{name_arg}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListCredentials", + "description": "Gets an array of credentials (as __CredentialInfo__ objects).\n\nThe array is limited to only the credentials that the caller has permission to access.\nIf the caller is a metastore admin, retrieval of credentials is unrestricted.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List credentials.", + "path": "/api/2.1/unity-catalog/credentials", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCredentialsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListCredentialsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_unbound", + "description": "Whether to include credentials not bound to the workspace.\nEffective only if the user has permission to update the credential–workspace binding.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of credentials to return.\n- If not set, the default max page size is used.\n- When set to a value greater than 0, the page length is the minimum of\nthis value and a server-configured value.\n- When set to 0, the page length is set to a server-configured value\n(recommended).\n- When set to a value less than 0, an invalid parameter error is\nreturned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token to retrieve the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "purpose", + "description": "Return only credentials for the specified purpose.", + "is_query": true, + "entity": { + "pascal_name": "CredentialPurpose", + "enum": [ + { + "content": "SERVICE" + }, + { + "content": "STORAGE" + } + ] + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque token to retrieve the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateCredential", + "description": "Updates a service or storage credential on the metastore.\n\nThe caller must be the owner of the credential or a metastore admin or have the `MANAGE` permission. If the caller is\na metastore admin, only the __owner__ field can be changed.", + "summary": "Update a credential.", + "path": "/api/2.1/unity-catalog/credentials/{name_arg}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "description": "The AWS IAM role configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRole", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "description": "The Azure managed identity configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentity", + "is_object": true + } + }, + { + "name": "azure_service_principal", + "description": "The Azure service principal configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureServicePrincipal", + "is_object": true + } + }, + { + "name": "comment", + "description": "Comment associated with the credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "databricks_gcp_service_account", + "description": "The Databricks managed GCP service account configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccount", + "is_object": true + } + }, + { + "name": "force", + "description": "Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**).", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "isolation_mode", + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "is_request_body_field": true, + "entity": { + "pascal_name": "IsolationMode", + "enum": [ + { + "content": "ISOLATION_MODE_ISOLATED" + }, + { + "content": "ISOLATION_MODE_OPEN" + } + ] + } + }, + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name of credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Supply true to this argument to skip validation of the updated credential.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name_arg", + "description": "Name of the credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ValidateCredential", + "description": "Validates a credential.\n\nFor service credentials (purpose is **SERVICE**), either the __credential_name__ or the cloud-specific credential\nmust be provided.\n\nFor storage credentials (purpose is **STORAGE**), at least one of __external_location_name__ and __url__ need to be\nprovided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__\nwill be used for validation, and __external_location_name__ will be ignored when checking overlapping urls. Either\nthe __credential_name__ or the cloud-specific credential must be provided.\n\nThe caller must be a metastore admin or the credential owner or have the required permission on the metastore and\nthe credential (e.g., **CREATE_EXTERNAL_LOCATION** when purpose is **STORAGE**).", + "summary": "Validate a credential.", + "path": "/api/2.1/unity-catalog/validate-credentials", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ValidateCredentialRequest", + "is_object": true + }, + "response": { + "pascal_name": "ValidateCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRole", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentity", + "is_object": true + } + }, + { + "name": "credential_name", + "description": "Required. The name of an existing credential or long-lived cloud\ncredential to validate.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "databricks_gcp_service_account", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccount", + "is_object": true + } + }, + { + "name": "external_location_name", + "description": "The name of an existing external location to validate. Only applicable for\nstorage credentials (purpose is\n**STORAGE**.)", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purpose", + "description": "The purpose of the credential. This should only be used when the credential\nis specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CredentialPurpose", + "enum": [ + { + "content": "SERVICE" + }, + { + "content": "STORAGE" + } + ] + } + }, + { + "name": "read_only", + "description": "Whether the credential is only usable for read operations. Only applicable\nfor storage credentials (purpose is\n**STORAGE**.)", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "url", + "description": "The external location url to validate. Only applicable when purpose is\n**STORAGE**.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "provisioning.Credentials", + "name": "Credentials", + "description": "These APIs manage credential configurations for this workspace. Databricks needs access to\na cross-account service IAM role in your AWS account so that Databricks can deploy clusters\nin the appropriate VPC for the new workspace. A credential configuration encapsulates this\nrole information, and its ID is used when creating a new workspace.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a Databricks credential configuration that represents cloud cross-account credentials for a specified account. Databricks uses this to set up network infrastructure properly to host Databricks clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account ID) in the returned credential object, and configure the required access policy.\n\nSave the response's `credentials_id` field, which is the ID for your new credential configuration object.\n\nFor information about how to create a new workspace with this API, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html)", + "summary": "Create credential configuration.", + "path": "/api/2.0/accounts/{account_id}/credentials", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCredentialRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "credentials_name", + "description": "The human-readable name of the credential configuration object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "aws_credentials", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateCredentialAwsCredentials", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "credentials_name", + "description": "The human-readable name of the credential configuration object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "aws_credentials", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateCredentialAwsCredentials", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "Credential", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_credentials", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateCredentialAwsCredentials", + "is_object": true + } + }, + { + "name": "credentials_name", + "description": "The human-readable name of the credential configuration object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace.", + "summary": "Delete credential configuration.", + "path": "/api/2.0/accounts/{account_id}/credentials/{credentials_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "credentials_id", + "description": "Databricks Account API credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "credentials_id", + "description": "Databricks Account API credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Credential", + "is_object": true + }, + "all_fields": [ + { + "name": "credentials_id", + "description": "Databricks Account API credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credentials_id", + "description": "Databricks Account API credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Databricks credential configuration object for an account, both specified by ID.", + "summary": "Get credential configuration.", + "path": "/api/2.0/accounts/{account_id}/credentials/{credentials_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "credentials_id", + "description": "Credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "credentials_id", + "description": "Credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Credential", + "is_object": true + }, + "all_fields": [ + { + "name": "credentials_id", + "description": "Credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credentials_id", + "description": "Credential configuration ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List Databricks credential configuration objects for an account, specified by ID.", + "summary": "List credential configuration.", + "path": "/api/2.0/accounts/{account_id}/credentials", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCredentialsRequest", + "is_object": true + }, + "response": { + "pascal_name": "CredentialList", + "array_value": { + "pascal_name": "Credential", + "is_object": true + } + } + } + ] + }, + { + "id": "settings.CredentialsManager", + "name": "CredentialsManager", + "description": "Credentials manager interacts with with Identity Providers to to perform token exchanges\nusing stored credentials and refresh tokens.", + "package": { + "name": "settings" + }, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "ExchangeToken", + "description": "Exchange tokens with an Identity Provider to get a new access token. It allows\nspecifying scopes to determine token permissions.\n\nPOST /exchange-tokens/token is the documented public form, expressed via\n`google.api.http` below. GET /exchange-tokens/$exchange is a legacy alias\nused by the Spark driver's OAuth refresh path (DBHttpClient#get sends a body\nvia HttpGetWithEntity) and stays on the legacy `option (rpc).endpoints`\nannotation: its path contains a literal `$`, which `google.api.http`'s\nLITERAL grammar does not allow, and `HttpPathParser` does not percent-decode\ntemplate segments (so encoding as `%24exchange` would not match the literal\n`$exchange` path the Spark driver sends). Per-endpoint\n`visibility: PUBLIC_UNDOCUMENTED` preserves the DECO-7732 intent of\nsuppressing the GET alias from the public API spec.", + "summary": "Exchange token.", + "path": "/api/2.0/credentials-manager/exchange-tokens/token", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ExchangeTokenRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "partitionId", + "description": "The partition of Credentials store", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PartitionId", + "is_object": true + } + }, + { + "name": "tokenType", + "description": "A list of token types being requested", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenTypeList", + "array_value": { + "pascal_name": "TokenType", + "enum": [ + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "AZURE_ACTIVE_DIRECTORY_TOKEN" + } + ] + } + } + }, + { + "name": "scopes", + "description": "Array of scopes for the token request.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "partitionId", + "description": "The partition of Credentials store", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PartitionId", + "is_object": true + } + }, + { + "name": "tokenType", + "description": "A list of token types being requested", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenTypeList", + "array_value": { + "pascal_name": "TokenType", + "enum": [ + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "AZURE_ACTIVE_DIRECTORY_TOKEN" + } + ] + } + } + }, + { + "name": "scopes", + "description": "Array of scopes for the token request.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "response": { + "pascal_name": "ExchangeTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "partitionId", + "description": "The partition of Credentials store", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PartitionId", + "is_object": true + } + }, + { + "name": "scopes", + "description": "Array of scopes for the token request.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "tokenType", + "description": "A list of token types being requested", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenTypeList", + "array_value": { + "pascal_name": "TokenType", + "enum": [ + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN" + }, + { + "content": "ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY" + }, + { + "content": "AZURE_ACTIVE_DIRECTORY_TOKEN" + } + ] + } + } + } + ] + } + ] + }, + { + "id": "settings.CspEnablementAccount", + "name": "CspEnablementAccount", + "description": "The compliance security profile settings at the account level control whether to enable it for new workspaces.\nBy default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable the compliance security profile individually for each workspace.\n\nThis settings can be disabled so that new workspaces do not have compliance security profile enabled by default.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Get", + "description": "Gets the compliance security profile setting for new workspaces.", + "summary": "Get the compliance security profile setting for new workspaces.", + "path": "/api/2.0/accounts/{account_id}/settings/types/shield_csp_enablement_ac/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetCspEnablementAccountSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "CspEnablementAccountSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "csp_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccount", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "csp_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccount", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the value of the compliance security profile setting for new workspaces.", + "summary": "Update the compliance security profile setting for new workspaces.", + "path": "/api/2.0/accounts/{account_id}/settings/types/shield_csp_enablement_ac/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateCspEnablementAccountSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccountSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccountSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CspEnablementAccountSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "csp_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccount", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "csp_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccount", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CspEnablementAccountSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "iam.CurrentUser", + "name": "CurrentUser", + "description": "This API allows retrieving information about currently authenticated user or\nservice principal.", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Me", + "description": "Get details about the current method caller's identity.", + "summary": "Get current user info.", + "path": "/api/2.0/preview/scim/v2/Me", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "MeRequest", + "is_object": true + }, + "response": { + "pascal_name": "User", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.CustomAppIntegration", + "name": "CustomAppIntegration", + "description": "These APIs enable administrators to manage custom OAuth app integrations, which is required for\nadding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListCustomAppIntegrationsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create Custom OAuth App Integration.\n\nYou can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.", + "summary": "Create Custom OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/custom-app-integrations", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCustomAppIntegration", + "is_object": true + }, + "response": { + "pascal_name": "CreateCustomAppIntegrationOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "confidential", + "description": "This field indicates whether an OAuth client secret is required to authenticate this client.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Name of the custom OAuth app", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "redirect_urls", + "description": "List of OAuth redirect urls", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "scopes", + "description": "OAuth scopes granted to the application.\nSupported scopes: all-apis, sql, offline_access, openid, profile, email.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "token_access_policy", + "description": "Token access policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TokenAccessPolicy", + "is_object": true + } + }, + { + "name": "user_authorized_scopes", + "description": "Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "Delete", + "description": "Delete an existing Custom OAuth App Integration.\nYou can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.", + "summary": "Delete Custom OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/custom-app-integrations/{integration_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCustomAppIntegrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteCustomAppIntegrationOutput", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the Custom OAuth App Integration for the given integration id.", + "summary": "Get OAuth Custom App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/custom-app-integrations/{integration_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCustomAppIntegrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "description": "The OAuth app integration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "description": "The OAuth app integration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetCustomAppIntegrationOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "integration_id", + "description": "The OAuth app integration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "description": "The OAuth app integration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Get the list of custom OAuth app integrations for the specified Databricks account", + "summary": "Get custom oauth app integrations.", + "path": "/api/2.0/accounts/{account_id}/oauth2/custom-app-integrations", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCustomAppIntegrationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetCustomAppIntegrationsOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "include_creator_username", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates an existing custom OAuth App Integration.\nYou can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.", + "summary": "Updates Custom OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/custom-app-integrations/{integration_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCustomAppIntegration", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateCustomAppIntegrationOutput", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "redirect_urls", + "description": "List of OAuth redirect urls to be updated in the custom OAuth app integration", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "scopes", + "description": "List of OAuth scopes to be updated in the custom OAuth app integration, similar to redirect URIs this will fully\nreplace the existing values instead of appending", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "token_access_policy", + "description": "Token access policy to be updated in the custom OAuth app integration", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TokenAccessPolicy", + "is_object": true + } + }, + { + "name": "user_authorized_scopes", + "description": "Scopes that will need to be consented by end user to mint the access token. If the user does\nnot authorize the access token will not be minted.\nMust be a subset of scopes.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.DashboardEmailSubscriptions", + "name": "DashboardEmailSubscriptions", + "description": "Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard. By default, this setting is enabled (set to `true`)", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the Dashboard Email Subscriptions setting to its default value.", + "summary": "Delete the Dashboard Email Subscriptions setting.", + "path": "/api/2.0/settings/types/dashboard_email_subscriptions/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDashboardEmailSubscriptionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDashboardEmailSubscriptionsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the Dashboard Email Subscriptions setting.", + "summary": "Get the Dashboard Email Subscriptions setting.", + "path": "/api/2.0/settings/types/dashboard_email_subscriptions/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDashboardEmailSubscriptionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "DashboardEmailSubscriptions", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the Dashboard Email Subscriptions setting.", + "summary": "Update the Dashboard Email Subscriptions setting.", + "path": "/api/2.0/settings/types/dashboard_email_subscriptions/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateDashboardEmailSubscriptionsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DashboardEmailSubscriptions", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DashboardEmailSubscriptions", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DashboardEmailSubscriptions", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DashboardEmailSubscriptions", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "sql.DashboardWidgets", + "name": "DashboardWidgets", + "description": "This is an evolving API that facilitates the addition and removal of widgets from existing\ndashboards within the Databricks Workspace. Data structures may change over time.", + "package": { + "name": "sql" + }, + "is_hidden_cli": true, + "docs_group": "sql", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "Create", + "description": "Adds a widget to a dashboard", + "summary": "Add widget to a dashboard.", + "path": "/api/2.0/preview/sql/widgets", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateWidget", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_request_body_fields": [ + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "Widget", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "text", + "description": "If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the `visualization` field.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "visualization_id", + "description": "Query Vizualization ID returned by :method:queryvisualizations/create.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + { + "name": "Delete", + "description": "Removes a widget from a dashboard", + "summary": "Remove widget.", + "path": "/api/2.0/preview/sql/widgets/{id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteDashboardWidgetRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates an existing widget", + "summary": "Update existing widget.", + "path": "/api/2.0/preview/sql/widgets/{id}", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateWidgetRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "Widget", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "Dashboard ID returned by :method:dashboards/create.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WidgetOptions", + "is_object": true + } + }, + { + "name": "text", + "description": "If this is a textbox widget, the application displays this text. This field is ignored if the widget contains a visualization in the `visualization` field.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "visualization_id", + "description": "Query Vizualization ID returned by :method:queryvisualizations/create.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "width", + "description": "Width of a widget", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Widget ID returned by :method:dashboardwidgets/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.Dashboards", + "name": "Dashboards", + "description": "In general, there is little need to modify dashboards using the API. However, it can be\nuseful to use dashboard objects to look-up a collection of related query IDs. The API can\nalso be used to duplicate multiple dashboards at once since you can get a dashboard\ndefinition with a GET request and then POST it to create a new one.\nDashboards can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Delete", + "description": "Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "summary": "Remove a dashboard.", + "path": "/api/2.0/preview/sql/dashboards/{dashboard_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Returns a JSON representation of a dashboard object, including its visualization and query objects.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "summary": "Retrieve a definition.", + "path": "/api/2.0/preview/sql/dashboards/{dashboard_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Fetch a paginated list of dashboard objects.\n\n**Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "summary": "Get dashboard objects.", + "path": "/api/2.0/preview/sql/dashboards", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListDashboardsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "order", + "description": "Name of dashboard attribute to order by.", + "is_query": true, + "entity": { + "pascal_name": "ListOrder", + "enum": [ + { + "content": "created_at" + }, + { + "content": "name" + } + ] + } + }, + { + "name": "page", + "description": "Page number to retrieve.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_size", + "description": "Number of dashboards to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "q", + "description": "Full text search term.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "offset": { + "name": "page", + "description": "Page number to retrieve.", + "is_query": true, + "entity": { + "is_int": true + } + }, + "limit": { + "name": "page_size", + "description": "Number of dashboards to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Restore", + "description": "A restored dashboard appears in list views and searches and can be shared.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "summary": "Restore a dashboard.", + "path": "/api/2.0/preview/sql/dashboards/trash/{dashboard_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestoreDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestoreResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Modify this dashboard definition. This operation only affects attributes of the dashboard object. It does not add, modify, or remove widgets.\n\n**Note**: You cannot undo this operation.\n\n**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more](https://docs.databricks.com/en/dashboards/)", + "summary": "Change a dashboard definition.", + "path": "/api/2.0/preview/sql/dashboards/{dashboard_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DashboardEditContent", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The title of this dashboard that appears in list views and at the top of the dashboard page.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as_role", + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "is_request_body_field": true, + "entity": { + "pascal_name": "RunAsRole", + "enum": [ + { + "content": "owner" + }, + { + "content": "viewer" + } + ] + } + }, + { + "name": "tags", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "dataclassification.DataClassification", + "name": "DataClassification", + "description": "Manage data classification for Unity Catalog catalogs.\nData classification automatically identifies and tags sensitive data (PII) in Unity Catalog tables.\nEach catalog can have at most one configuration resource that controls scanning behavior and auto-tagging rules.", + "package": { + "name": "dataclassification" + }, + "docs_group": "dataclassification", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "methods": [ + { + "name": "CreateCatalogConfig", + "description": "Create Data Classification configuration for a catalog.\n\nCreates a new config resource, which enables Data Classification\nfor the specified catalog.\n- The config must not already exist for the catalog.", + "summary": "Create config for a catalog.", + "path": "/api/data-classification/v1/{parent=catalogs/*}/config", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateCatalogConfigRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource in the format: catalogs/{catalog_name}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_config", + "description": "The configuration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource in the format: catalogs/{catalog_name}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_config", + "description": "The configuration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "catalog_config", + "description": "The configuration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + }, + "response": { + "pascal_name": "CatalogConfig", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_config", + "description": "The configuration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + }, + { + "name": "parent", + "description": "Parent resource in the format: catalogs/{catalog_name}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "auto_tag_configs", + "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AutoTaggingConfigList", + "array_value": { + "pascal_name": "AutoTaggingConfig", + "is_object": true + } + } + }, + { + "name": "included_schemas", + "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If `included_schemas` is not set, all schemas are scanned.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CatalogConfigSchemaNames", + "is_object": true + } + }, + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource in the format: catalogs/{catalog_name}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteCatalogConfig", + "description": "Delete Data Classification configuration for a catalog.", + "summary": "Delete config for a catalog.", + "path": "/api/data-classification/v1/{name=catalogs/*/config}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteCatalogConfigRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCatalogConfig", + "description": "Get the Data Classification configuration for a catalog.", + "summary": "Get config for a catalog.", + "path": "/api/data-classification/v1/{name=catalogs/*/config}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetCatalogConfigRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CatalogConfig", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateCatalogConfig", + "description": "Update the Data Classification configuration for a catalog.\n- The config must already exist for the catalog.\n- Updates fields specified in the update_mask. Use update_mask field to perform partial updates of the configuration.", + "summary": "Update config for a catalog.", + "path": "/api/data-classification/v1/{name=catalogs/*/config}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateCatalogConfigRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_config", + "description": "The configuration to apply to the catalog.\nThe name field in catalog_config identifies which resource to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_config", + "description": "The configuration to apply to the catalog.\nThe name field in catalog_config identifies which resource to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "catalog_config", + "description": "The configuration to apply to the catalog.\nThe name field in catalog_config identifies which resource to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + }, + "response": { + "pascal_name": "CatalogConfig", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_config", + "description": "The configuration to apply to the catalog.\nThe name field in catalog_config identifies which resource to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CatalogConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "auto_tag_configs", + "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AutoTaggingConfigList", + "array_value": { + "pascal_name": "AutoTaggingConfig", + "is_object": true + } + } + }, + { + "name": "included_schemas", + "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If `included_schemas` is not set, all schemas are scanned.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CatalogConfigSchemaNames", + "is_object": true + } + }, + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name in the format: catalogs/{catalog_name}/config.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ] + } + ] + }, + { + "id": "dataquality.DataQuality", + "name": "DataQuality", + "description": "Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)", + "package": { + "name": "dataquality" + }, + "docs_group": "dataquality", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListMonitorRequest" + } + }, + "methods": [ + { + "name": "CancelRefresh", + "description": "Cancels a data quality monitor refresh. Currently only supported for the `table` `object_type`.\nThe call must be made in the same workspace as where the monitor was created.\n\nThe caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.", + "summary": "Cancel a refresh.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id}/cancel", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CancelRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "CancelRefreshResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "CreateMonitor", + "description": "Create a data quality monitor on a Unity Catalog object. The caller must provide either `anomaly_detection_config` for a schema monitor or `data_profiling_config` for a table monitor.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table\n2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and **SELECT** on the table.\n\nWorkspace assets, such as the dashboard, will be created in the workspace where this call was made.\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.", + "summary": "Create a monitor.", + "path": "/api/data-quality/v1/monitors", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateMonitorRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "monitor", + "description": "The monitor to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "monitor", + "description": "The monitor to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "monitor", + "description": "The monitor to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "monitor", + "description": "The monitor to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "anomaly_detection_config", + "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AnomalyDetectionConfig", + "is_object": true + } + }, + { + "name": "data_profiling_config", + "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DataProfilingConfig", + "is_object": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateRefresh", + "description": "Creates a refresh. Currently only supported for the `table` `object_type`.\nThe call must be made in the same workspace as where the monitor was created.\n\nThe caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.", + "summary": "Create a refresh.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateRefreshRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh", + "description": "The refresh to create", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "refresh", + "description": "The refresh to create", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "refresh", + "description": "The refresh to create", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh", + "description": "The refresh to create", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "end_time_ms", + "description": "Time when the refresh ended (milliseconds since 1/1/1970 UTC).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "message", + "description": "An optional message to give insight into the current state of the refresh (e.g. FAILURE messages).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "start_time_ms", + "description": "Time when the refresh started (milliseconds since 1/1/1970 UTC).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RefreshState", + "enum": [ + { + "content": "MONITOR_REFRESH_STATE_CANCELED" + }, + { + "content": "MONITOR_REFRESH_STATE_FAILED" + }, + { + "content": "MONITOR_REFRESH_STATE_PENDING" + }, + { + "content": "MONITOR_REFRESH_STATE_RUNNING" + }, + { + "content": "MONITOR_REFRESH_STATE_SUCCESS" + }, + { + "content": "MONITOR_REFRESH_STATE_UNKNOWN" + } + ] + } + }, + { + "name": "trigger", + "description": "What triggered the refresh.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RefreshTrigger", + "enum": [ + { + "content": "MONITOR_REFRESH_TRIGGER_DATA_CHANGE" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_MANUAL" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_SCHEDULE" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_UNKNOWN" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteMonitor", + "description": "Delete a data quality monitor on Unity Catalog object.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n**MANAGE** and **USE_CATALOG** on the table's parent catalog.\n**USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n**USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.\n\nNote that the metric tables and dashboard will not be deleted as part of this call; those\nassets must be manually cleaned up (if desired).\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.", + "summary": "Delete a monitor.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteRefresh", + "description": "(Unimplemented) Delete a refresh", + "summary": "Delete a refresh.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetMonitor", + "description": "Read a data quality monitor on a Unity Catalog object.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.\n\nThe returned information includes configuration values on the entity and parent entity as well as information on\nassets created by the monitor. Some information (e.g. dashboard) may be filtered out\nif the caller is in a different workspace than where the monitor was created.", + "summary": "Read a monitor.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRefresh", + "description": "Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was created.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.", + "summary": "Get a refresh.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ListMonitor", + "description": "(Unimplemented) List data quality monitors.", + "summary": "List monitors.", + "path": "/api/data-quality/v1/monitors", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListMonitorRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListMonitorResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListRefresh", + "description": "List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.", + "summary": "List refreshes.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListRefreshResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateMonitor", + "description": "Update a data quality monitor on Unity Catalog object.\n\nFor the `table` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the table's parent catalog.\n2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema.\n3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table.\n\nFor the `schema` `object_type`, the caller must have either of the following sets of permissions:\n1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog.\n2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and **USE_SCHEMA** on the schema.", + "summary": "Update a monitor.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateMonitorRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor", + "description": "The monitor to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update as a comma-separated list.\nExample value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update as a comma-separated list.\nExample value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "monitor", + "description": "The monitor to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "monitor", + "description": "The monitor to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "monitor", + "description": "The monitor to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Monitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update as a comma-separated list.\nExample value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "anomaly_detection_config", + "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AnomalyDetectionConfig", + "is_object": true + } + }, + { + "name": "data_profiling_config", + "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DataProfilingConfig", + "is_object": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update as a comma-separated list.\nExample value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateRefresh", + "description": "(Unimplemented) Update a refresh", + "summary": "Update a refresh.", + "path": "/api/data-quality/v1/monitors/{object_type}/{object_id}/refreshes/{refresh_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateRefreshRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "refresh", + "description": "The refresh to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "refresh", + "description": "The refresh to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "refresh", + "description": "The refresh to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh", + "description": "The refresh to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Refresh", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "end_time_ms", + "description": "Time when the refresh ended (milliseconds since 1/1/1970 UTC).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "message", + "description": "An optional message to give insight into the current state of the refresh (e.g. FAILURE messages).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "start_time_ms", + "description": "Time when the refresh started (milliseconds since 1/1/1970 UTC).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RefreshState", + "enum": [ + { + "content": "MONITOR_REFRESH_STATE_CANCELED" + }, + { + "content": "MONITOR_REFRESH_STATE_FAILED" + }, + { + "content": "MONITOR_REFRESH_STATE_PENDING" + }, + { + "content": "MONITOR_REFRESH_STATE_RUNNING" + }, + { + "content": "MONITOR_REFRESH_STATE_SUCCESS" + }, + { + "content": "MONITOR_REFRESH_STATE_UNKNOWN" + } + ] + } + }, + { + "name": "trigger", + "description": "What triggered the refresh.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RefreshTrigger", + "enum": [ + { + "content": "MONITOR_REFRESH_TRIGGER_DATA_CHANGE" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_MANUAL" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_SCHEDULE" + }, + { + "content": "MONITOR_REFRESH_TRIGGER_UNKNOWN" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "The field mask to specify which fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.DataSources", + "name": "DataSources", + "description": "This API is provided to assist you in making new query objects. When creating a query object,\nyou may optionally specify a `data_source_id` for the SQL warehouse against which it will run.\nIf you don't already know the `data_source_id` for your desired SQL warehouse, this API will\nhelp you find it.\n\nThis API does not support searches. It returns the full list of SQL warehouses in your\nworkspace. We advise you to use any text editor, REST client, or `grep` to search the\nresponse from this API for the name of your SQL warehouse as it appears in Databricks SQL.\n\n**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "List", + "description": "Retrieves a full list of SQL warehouses available in this workspace.\nAll fields that appear in this API response are enumerated for clarity.\nHowever, you need only a SQL warehouse's `id` to create new queries against it.\n\n**Warning**: This API is deprecated. Please use :method:warehouses/list instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get a list of SQL warehouses.", + "path": "/api/2.0/preview/sql/data_sources", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListRequest", + "is_object": true + }, + "response": { + "pascal_name": "DataSourceList", + "array_value": { + "pascal_name": "DataSource", + "is_object": true + } + } + } + ] + }, + { + "id": "database.Database", + "name": "Database", + "description": "Database Instances provide access to a database via REST API or direct SQL.", + "package": { + "name": "database" + }, + "docs_group": "database", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListDatabaseCatalogsRequest" + } + }, + "methods": [ + { + "name": "CreateDatabaseCatalog", + "description": "Create a Database Catalog.", + "summary": "Create a Database Catalog.", + "path": "/api/2.0/database/catalogs", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateDatabaseCatalogRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_database_if_not_exists", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "uid", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateDatabaseInstance", + "description": "Create a Database Instance.", + "summary": "Create a Database Instance.", + "path": "/api/2.0/database/instances", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateDatabaseInstanceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "database_instance", + "description": "Instance to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database_instance", + "description": "Instance to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database_instance", + "description": "Instance to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "database_instance", + "description": "Instance to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "capacity", + "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "child_instance_refs", + "description": "The refs of the child instances. This is only available if the instance is\nparent instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRefList", + "array_value": { + "pascal_name": "DatabaseInstanceRef", + "is_object": true + } + } + }, + { + "name": "creation_time", + "description": "The timestamp when the instance was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the creator of the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "Custom tags associated with the instance. This field is only included on create and update responses.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + }, + { + "name": "effective_capacity", + "description": "Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_custom_tags", + "description": "The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + }, + { + "name": "effective_enable_pg_native_login", + "description": "Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_enable_readable_secondaries", + "description": "Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "effective_stopped", + "description": "Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_usage_policy_id", + "description": "The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_pg_native_login", + "description": "Whether to enable PG native password login on the instance. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_readable_secondaries", + "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseInstanceRef", + "is_object": true + } + }, + { + "name": "pg_version", + "description": "The version of Postgres running on the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only_dns", + "description": "The DNS endpoint to connect to the instance for read only access. This is only available if\nenable_readable_secondaries is true.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_write_dns", + "description": "The DNS endpoint to connect to the instance for read+write access.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "state", + "description": "The current state of the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceState", + "enum": [ + { + "content": "AVAILABLE" + }, + { + "content": "DELETING" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "STARTING" + }, + { + "content": "STOPPED" + }, + { + "content": "UPDATING" + } + ] + } + }, + { + "name": "stopped", + "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "uid", + "description": "An immutable UUID identifier for the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "description": "The desired usage policy to associate with the instance.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "AVAILABLE" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "DatabaseInstance" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ] + } + }, + { + "name": "CreateDatabaseInstanceRole", + "description": "Create a role for a Database Instance.", + "summary": "Create a role for a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/roles", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateDatabaseInstanceRoleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_role", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database_instance_role", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database_instance_role", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "database_instance_name", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_role", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attributes", + "description": "The desired API-exposed Postgres role attribute to associate with the role. Optional.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseInstanceRoleAttributes", + "is_object": true + } + }, + { + "name": "effective_attributes", + "description": "The attributes that are applied to the role.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseInstanceRoleAttributes", + "is_object": true + } + }, + { + "name": "identity_type", + "description": "The type of the role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRoleIdentityType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "PG_ONLY" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "instance_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "membership_role", + "description": "An enum value for a standard role that this role is a member of.", + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRoleMembershipRole", + "enum": [ + { + "content": "DATABRICKS_SUPERUSER" + } + ] + } + }, + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateDatabaseTable", + "description": "Create a Database Table. Useful for registering pre-existing PG tables in UC.\nSee CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC.", + "summary": "Create a Database Table.", + "path": "/api/2.0/database/tables", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateDatabaseTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseTable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseTable", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "database_instance_name", + "description": "Name of the target database instance. This is required when creating database tables in standard catalogs.\nThis is optional when creating database tables in registered catalogs. If this field is specified\nwhen creating database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "logical_database_name", + "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\n\nRegistration of database tables via /database/tables is currently only supported in standard catalogs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateSyncedDatabaseTable", + "description": "Create a Synced Database Table.", + "summary": "Create a Synced Database Table.", + "path": "/api/2.0/database/synced_tables", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateSyncedDatabaseTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "data_synchronization_status", + "description": "Synced Table data synchronization status", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableStatus", + "is_object": true + } + }, + { + "name": "database_instance_name", + "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_database_instance_name", + "description": "The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_logical_database_name", + "description": "The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "logical_database_name", + "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableSpec", + "is_object": true + } + }, + { + "name": "unity_catalog_provisioning_state", + "description": "The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProvisioningInfoState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DEGRADED" + }, + { + "content": "DELETING" + }, + { + "content": "FAILED" + }, + { + "content": "PROVISIONING" + }, + { + "content": "UPDATING" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDatabaseCatalog", + "description": "Delete a Database Catalog.", + "summary": "Delete a Database Catalog.", + "path": "/api/2.0/database/catalogs/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDatabaseCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDatabaseInstance", + "description": "Delete a Database Instance.", + "summary": "Delete a Database Instance.", + "path": "/api/2.0/database/instances/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDatabaseInstanceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the instance to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the instance to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "By default, a instance cannot be deleted if it has descendant instances created via PITR. If\nthis flag is specified as true, all descendent instances will be deleted as well.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Name of the instance to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge", + "description": "Deprecated. Omitting the field or setting it to true will result in the field being hard deleted. Setting a value\nof false will throw a bad request.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the instance to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDatabaseInstanceRole", + "description": "Deletes a role for a Database Instance.", + "summary": "Delete a role for a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/roles/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteDatabaseInstanceRoleRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This is the AIP standard name for the equivalent of Postgres' `IF EXISTS` option", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "reassign_owned_to", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDatabaseTable", + "description": "Delete a Database Table.", + "summary": "Delete a Database Table.", + "path": "/api/2.0/database/tables/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDatabaseTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSyncedDatabaseTable", + "description": "Delete a Synced Database Table.", + "summary": "Delete a Synced Database Table.", + "path": "/api/2.0/database/synced_tables/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteSyncedDatabaseTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge_data", + "description": "Optional. When set to true, the actual PostgreSQL table will be dropped from the database.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "FindDatabaseInstanceByUid", + "description": "Find a Database Instance by uid.", + "summary": "Find a Database Instance by uid.", + "path": "/api/2.0/database/instances:findByUid", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "FindDatabaseInstanceByUidRequest", + "is_object": true + }, + "response": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "uid", + "description": "UID of the cluster to get.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenerateDatabaseCredential", + "description": "Generates a credential that can be used to access database instances.", + "summary": "Generates a credential that can be used to access database instances.", + "path": "/api/2.0/database/credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GenerateDatabaseCredentialRequest", + "is_object": true + }, + "response": { + "pascal_name": "DatabaseCredential", + "is_object": true + }, + "all_fields": [ + { + "name": "claims", + "description": "A set of UC permissions to add to the credential. We verify that the caller has the necessary\npermissions in UC and include a reference in the token. Postgres uses that token to give the\nconnecting user additional grants to the Postgres resources that correspond to the UC resources.\nThe UC resources need to be something that have a Postgres counterpart. For example, a synced table or\na table in a UC database catalog.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RequestedClaimsList", + "array_value": { + "pascal_name": "RequestedClaims", + "is_object": true + } + } + }, + { + "name": "instance_names", + "description": "Instances to request a credential for. At least one of instance_names or claims must be specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "request_id", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDatabaseCatalog", + "description": "Get a Database Catalog.", + "summary": "Get a Database Catalog.", + "path": "/api/2.0/database/catalogs/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDatabaseCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDatabaseInstance", + "description": "Get a Database Instance.", + "summary": "Get a Database Instance.", + "path": "/api/2.0/database/instances/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDatabaseInstanceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the cluster to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the cluster to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the cluster to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the cluster to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDatabaseInstanceRole", + "description": "Gets a role for a Database Instance.", + "summary": "Get a role for a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/roles/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetDatabaseInstanceRoleRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DatabaseInstanceRole", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the role. This is the unique identifier for the role in an instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDatabaseTable", + "description": "Get a Database Table.", + "summary": "Get a Database Table.", + "path": "/api/2.0/database/tables/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDatabaseTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSyncedDatabaseTable", + "description": "Get a Synced Database Table.", + "summary": "Get a Synced Database Table.", + "path": "/api/2.0/database/synced_tables/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetSyncedDatabaseTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListDatabaseCatalogs", + "description": "This API is currently unimplemented, but exposed for Terraform support.", + "summary": "List all Database Catalogs in a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/catalogs", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListDatabaseCatalogsRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get database catalogs for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get database catalogs for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListDatabaseCatalogsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get database catalogs for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "description": "Name of the instance to get database catalogs for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListDatabaseInstanceRoles", + "description": "START OF PG ROLE APIs Section\nThese APIs are marked a PUBLIC with stage \u003c PUBLIC_PREVIEW. With more recent Lakebase V2 plans, we don't plan to\never advance these to PUBLIC_PREVIEW. These APIs will remain effectively undocumented/UI-only and we'll aim for a\nnew public roles API as part of V2 PuPr.", + "summary": "List roles for a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/roles", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListDatabaseInstanceRolesRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListDatabaseInstanceRolesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListDatabaseInstances", + "description": "List Database Instances.", + "summary": "List Database Instances.", + "path": "/api/2.0/database/instances", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListDatabaseInstancesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListDatabaseInstancesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned. The maximum value is 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSyncedDatabaseTables", + "description": "This API is currently unimplemented, but exposed for Terraform support.", + "summary": "List all synced database tables in a Database Instance.", + "path": "/api/2.0/database/instances/{instance_name}/synced_tables", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListSyncedDatabaseTablesRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get synced tables for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get synced tables for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSyncedDatabaseTablesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "instance_name", + "description": "Name of the instance to get synced tables for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_name", + "description": "Name of the instance to get synced tables for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateDatabaseCatalog", + "description": "This API is currently unimplemented, but exposed for Terraform support.", + "summary": "Update a Database Catalog.", + "path": "/api/2.0/database/catalogs/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateDatabaseCatalogRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_catalog", + "description": "Note that updating a database catalog is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database_catalog", + "description": "Note that updating a database catalog is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database_catalog", + "description": "Note that updating a database catalog is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "database_catalog", + "description": "Note that updating a database catalog is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseCatalog", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_database_if_not_exists", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "uid", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog in UC.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance_name", + "description": "The name of the DatabaseInstance housing the database.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_name", + "description": "The name of the database (in a instance) associated with the catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateDatabaseInstance", + "description": "Update a Database Instance.", + "summary": "Update a Database Instance.", + "path": "/api/2.0/database/instances/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateDatabaseInstanceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_instance", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database_instance", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database_instance", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "database_instance", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstance", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "child_instance_refs", + "description": "The refs of the child instances. This is only available if the instance is\nparent instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceRefList", + "array_value": { + "pascal_name": "DatabaseInstanceRef", + "is_object": true + } + } + }, + { + "name": "creation_time", + "description": "The timestamp when the instance was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the creator of the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "Custom tags associated with the instance. This field is only included on create and update responses.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + }, + { + "name": "effective_capacity", + "description": "Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_custom_tags", + "description": "The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + }, + { + "name": "effective_enable_pg_native_login", + "description": "Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_enable_readable_secondaries", + "description": "Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "effective_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.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "effective_stopped", + "description": "Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_usage_policy_id", + "description": "The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_pg_native_login", + "description": "Whether to enable PG native password login on the instance. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_readable_secondaries", + "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseInstanceRef", + "is_object": true + } + }, + { + "name": "pg_version", + "description": "The version of Postgres running on the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only_dns", + "description": "The DNS endpoint to connect to the instance for read only access. This is only available if\nenable_readable_secondaries is true.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_write_dns", + "description": "The DNS endpoint to connect to the instance for read+write access.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "state", + "description": "The current state of the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseInstanceState", + "enum": [ + { + "content": "AVAILABLE" + }, + { + "content": "DELETING" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "STARTING" + }, + { + "content": "STOPPED" + }, + { + "content": "UPDATING" + } + ] + } + }, + { + "name": "stopped", + "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "uid", + "description": "An immutable UUID identifier for the instance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "usage_policy_id", + "description": "The desired usage policy to associate with the instance.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the instance. This is the unique identifier for the instance.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSyncedDatabaseTable", + "description": "This API is currently unimplemented, but exposed for Terraform support.", + "summary": "Update a Synced Database Table.", + "path": "/api/2.0/database/synced_tables/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateSyncedDatabaseTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "synced_table", + "description": "Note that updating a synced database table is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "synced_table", + "description": "Note that updating a synced database table is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "synced_table", + "description": "Note that updating a synced database table is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "synced_table", + "description": "Note that updating a synced database table is not yet supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedDatabaseTable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "data_synchronization_status", + "description": "Synced Table data synchronization status", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableStatus", + "is_object": true + } + }, + { + "name": "database_instance_name", + "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_database_instance_name", + "description": "The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_logical_database_name", + "description": "The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "logical_database_name", + "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableSpec", + "is_object": true + } + }, + { + "name": "unity_catalog_provisioning_state", + "description": "The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProvisioningInfoState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DEGRADED" + }, + { + "content": "DELETING" + }, + { + "content": "FAILED" + }, + { + "content": "PROVISIONING" + }, + { + "content": "UPDATING" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. Setting this field is not yet supported.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "files.Dbfs", + "name": "Dbfs", + "description": "DBFS API makes it simple to interact with various data sources without having to include\na users credentials every time to read a file.", + "package": { + "name": "files" + }, + "docs_group": "files", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListDbfsRequest" + } + }, + "methods": [ + { + "name": "AddBlock", + "description": "Appends a block of data to the stream specified by the input handle. If the handle does not\nexist, this call will throw an exception with ``RESOURCE_DOES_NOT_EXIST``.\n\nIf the block of data exceeds 1 MB, this call will throw an exception with ``MAX_BLOCK_SIZE_EXCEEDED``.", + "summary": "Append data block.", + "path": "/api/2.0/dbfs/add-block", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AddBlock", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "data", + "description": "The base64-encoded data to append to the stream. This has a limit of 1 MB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "data", + "description": "The base64-encoded data to append to the stream. This has a limit of 1 MB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AddBlockResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "data", + "description": "The base64-encoded data to append to the stream. This has a limit of 1 MB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "data", + "description": "The base64-encoded data to append to the stream. This has a limit of 1 MB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Close", + "description": "Closes the stream specified by the input handle. If the handle does not exist, this call\nthrows an exception with ``RESOURCE_DOES_NOT_EXIST``.", + "summary": "Close the stream.", + "path": "/api/2.0/dbfs/close", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Close", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "CloseResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "handle", + "description": "The handle on an open stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Create", + "description": "Opens a stream to write to a file and returns a handle to this stream.\nThere is a 10 minute idle timeout on this handle. If a file or directory already exists on the given path\nand __overwrite__ is set to false, this call will throw an exception with ``RESOURCE_ALREADY_EXISTS``.\n\nA typical workflow for file upload would be:\n\n1. Issue a ``create`` call and get a handle.\n2. Issue one or more ``add-block`` calls with the handle you have.\n3. Issue a ``close`` call with the handle you have.", + "summary": "Open a stream.", + "path": "/api/2.0/dbfs/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Create", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "overwrite", + "description": "The flag that specifies whether to overwrite existing file/files.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete the file or directory (optionally recursively delete all files in the directory).\nThis call throws an exception with `IO_ERROR` if the path is a non-empty directory and `recursive` is set to\n`false` or on other similar errors.\n\nWhen you delete a large number of files, the delete operation is done in increments. The call returns\na response after approximately 45 seconds with an error message (503 Service Unavailable) asking you to\nre-invoke the delete operation until the directory structure is fully deleted.\n\nFor operations that delete more than 10K files, we discourage using the DBFS REST API, but advise you to\nperform such operations in the context of a cluster, using\nthe [File system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs). `dbutils.fs`\ncovers the functional scope of the DBFS REST API, but from notebooks. Running such operations using notebooks\nprovides better control and manageability, such as selective deletes, and the possibility to automate periodic\ndelete jobs.", + "summary": "Delete a file/directory.", + "path": "/api/2.0/dbfs/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Delete", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the file or directory to delete. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The path of the file or directory to delete. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "path", + "description": "The path of the file or directory to delete. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "recursive", + "description": "Whether or not to recursively delete the directory's contents. Deleting empty directories can be done without providing the recursive flag.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the file or directory to delete. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStatus", + "description": "Gets the file information for a file or directory.\nIf the file or directory does not exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`.", + "summary": "Get the information of a file or directory.", + "path": "/api/2.0/dbfs/get-status", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStatusRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FileInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List the contents of a directory, or details of the file. If the file or directory does not exist, this call\nthrows an exception with `RESOURCE_DOES_NOT_EXIST`.\n\nWhen calling list on a large directory, the list operation will time out after approximately 60 seconds.\nWe strongly recommend using list only on directories containing less than 10K files and discourage using\nthe DBFS REST API for operations that list more than 10K files. Instead, we recommend that you perform such\noperations in the context of a cluster, using\nthe [File system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), which provides the same\nfunctionality without timing out.", + "summary": "List directory contents or file details.", + "path": "/api/2.0/dbfs/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListDbfsRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListStatusResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "Mkdirs", + "description": "Creates the given directory and necessary parent directories if they do not exist.\nIf a file (not a directory) exists at any prefix of the input path, this call throws an exception with `RESOURCE_ALREADY_EXISTS`.\n**Note**: If this operation fails, it might have succeeded in creating some of the necessary parent directories.", + "summary": "Create a directory.", + "path": "/api/2.0/dbfs/mkdirs", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "MkDirs", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the new directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The path of the new directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MkDirsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "path", + "description": "The path of the new directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the new directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Move", + "description": "Moves a file from one location to another location within DBFS.\nIf the source file does not exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`.\nIf a file already exists in the destination path, this call throws an exception with `RESOURCE_ALREADY_EXISTS`.\nIf the given source path is a directory, this call always recursively moves all files.", + "summary": "Move a file.", + "path": "/api/2.0/dbfs/move", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Move", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_path", + "description": "The source path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "destination_path", + "description": "The destination path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source_path", + "description": "The source path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "destination_path", + "description": "The destination path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MoveResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "destination_path", + "description": "The destination path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_path", + "description": "The source path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "source_path", + "description": "The source path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "destination_path", + "description": "The destination path of the file or directory. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Put", + "description": "Uploads a file through the use of multipart form post.\nIt is mainly used for streaming uploads, but can also be used as a convenient single call for data upload.\n\nAlternatively you can pass contents as base64 string.\n\nThe amount of data that can be passed (when not streaming) using the __contents__ parameter is limited to 1 MB.\n`MAX_BLOCK_SIZE_EXCEEDED` will be thrown if this limit is exceeded.\n\nIf you want to upload large files, use the streaming upload. For details, see :method:dbfs/create,\n:method:dbfs/addBlock, :method:dbfs/close.", + "summary": "Upload a file.", + "path": "/api/2.0/dbfs/put", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Put", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PutResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "contents", + "description": "This parameter might be absent, and instead a posted file will be used.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "overwrite", + "description": "The flag that specifies whether to overwrite existing file/files.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the new file. The path should be the absolute DBFS path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Read", + "description": "Returns the contents of a file. If the file does not exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`.\nIf the path is a directory, the read length is negative, or if the offset is negative, this call throws an exception with\n`INVALID_PARAMETER_VALUE`. If the read length exceeds 1 MB, this call throws an\nexception with `MAX_READ_SIZE_EXCEEDED`.\n\nIf `offset + length` exceeds the number of bytes in a file, it reads the contents until the end of file.", + "summary": "Get the contents of a file.", + "path": "/api/2.0/dbfs/read", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ReadDbfsRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The path of the file to read. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The path of the file to read. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ReadResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "length", + "description": "The number of bytes to read starting from the offset. This has a limit of 1 MB, and a default\nvalue of 0.5 MB.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "offset", + "description": "The offset to read from in bytes.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "path", + "description": "The path of the file to read. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The path of the file to read. The path should be the absolute DBFS path.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.DbsqlPermissions", + "name": "DbsqlPermissions", + "description": "The SQL Permissions API is similar to the endpoints of the :method:permissions/set. However, this\nexposes only one endpoint, which gets the Access Control List for a given object. You cannot\nmodify any permissions using this API.\n\nThere are three levels of permission:\n\n- `CAN_VIEW`: Allows read-only access\n\n- `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`)\n\n- `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify permissions (superset of `CAN_RUN`)\n\n**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Get", + "description": "Gets a JSON representation of the access control list (ACL) for a specified object.\n\n**Warning**: This API is deprecated. Please use :method:workspace/getpermissions instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get object ACL.", + "path": "/api/2.0/preview/sql/permissions/{objectType}/{objectId}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDbsqlPermissionRequest", + "is_object": true, + "required_fields": [ + { + "name": "objectType", + "description": "The type of object permissions to check.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. An ACL is returned for the object with this UUID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "objectType", + "description": "The type of object permissions to check.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. An ACL is returned for the object with this UUID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "objectId", + "description": "Object ID. An ACL is returned for the object with this UUID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "objectType", + "description": "The type of object permissions to check.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "objectType", + "description": "The type of object permissions to check.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. An ACL is returned for the object with this UUID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Set", + "description": "Sets the access control list (ACL) for a specified object. This operation will complete rewrite the ACL.\n\n**Warning**: This API is deprecated. Please use :method:workspace/setpermissions instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Set object ACL.", + "path": "/api/2.0/preview/sql/permissions/{objectType}/{objectId}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetRequest", + "is_object": true, + "required_fields": [ + { + "name": "objectType", + "description": "The type of object permission to set.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. The ACL for the object with this UUID is overwritten by this request's POST content.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "objectType", + "description": "The type of object permission to set.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. The ACL for the object with this UUID is overwritten by this request's POST content.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessControlList", + "array_value": { + "pascal_name": "AccessControl", + "is_object": true + } + } + }, + { + "name": "objectId", + "description": "Object ID. The ACL for the object with this UUID is overwritten by this request's POST content.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "objectType", + "description": "The type of object permission to set.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "objectType", + "description": "The type of object permission to set.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "ObjectTypePlural", + "enum": [ + { + "content": "alerts" + }, + { + "content": "dashboards" + }, + { + "content": "data_sources" + }, + { + "content": "queries" + } + ] + } + }, + { + "name": "objectId", + "description": "Object ID. The ACL for the object with this UUID is overwritten by this request's POST content.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "TransferOwnership", + "description": "Transfers ownership of a dashboard, query, or alert to an active user. Requires an admin API key.\n\n**Warning**: This API is deprecated. For queries and alerts, please use :method:queries/update and :method:alerts/update respectively instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Transfer object ownership.", + "path": "/api/2.0/preview/sql/permissions/{objectType}/{objectId}/transfer", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TransferOwnershipRequest", + "is_object": true, + "required_fields": [ + { + "name": "objectType", + "description": "The type of object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "OwnableObjectType", + "enum": [ + { + "content": "alert" + }, + { + "content": "dashboard" + }, + { + "content": "query" + } + ] + } + }, + { + "name": "objectId", + "description": "The ID of the object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "TransferOwnershipObjectId", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "objectType", + "description": "The type of object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "OwnableObjectType", + "enum": [ + { + "content": "alert" + }, + { + "content": "dashboard" + }, + { + "content": "query" + } + ] + } + }, + { + "name": "objectId", + "description": "The ID of the object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "TransferOwnershipObjectId", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "Success", + "is_object": true + }, + "all_fields": [ + { + "name": "new_owner", + "description": "Email address for the new owner, who must exist in the workspace.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "objectId", + "description": "The ID of the object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "TransferOwnershipObjectId", + "is_object": true + } + }, + { + "name": "objectType", + "description": "The type of object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "OwnableObjectType", + "enum": [ + { + "content": "alert" + }, + { + "content": "dashboard" + }, + { + "content": "query" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "objectType", + "description": "The type of object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "OwnableObjectType", + "enum": [ + { + "content": "alert" + }, + { + "content": "dashboard" + }, + { + "content": "query" + } + ] + } + }, + { + "name": "objectId", + "description": "The ID of the object on which to change ownership.", + "required": true, + "is_path": true, + "entity": { + "pascal_name": "TransferOwnershipObjectId", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.DefaultNamespace", + "name": "DefaultNamespace", + "description": "The default namespace setting API allows users to configure the default namespace for a Databricks workspace.\n\nThrough this API, users can retrieve, set, or modify the default namespace used when queries do not reference\na fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query\n'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed).\n\nThis setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in `DELETE`\nrequests (as a query parameter). The etag can be retrieved by making a `GET` request before the `DELETE` request.\nIf the setting is updated/deleted concurrently, `DELETE` fails with 409 and the\nrequest must be retried by using the fresh etag in the 409 response.", + "summary": "Delete the default namespace setting.", + "path": "/api/2.0/settings/types/default_namespace_ws/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDefaultNamespaceSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDefaultNamespaceSettingResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the default namespace setting.", + "summary": "Get the default namespace setting.", + "path": "/api/2.0/settings/types/default_namespace_ws/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDefaultNamespaceSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DefaultNamespaceSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "namespace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "namespace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the default namespace setting for the workspace. A fresh etag needs to be provided in `PATCH`\nrequests (as part of the setting field). The etag can be retrieved by making a `GET` request before the `PATCH` request.\nNote that if the setting does not exist, `GET` returns a NOT_FOUND error and the etag is present in the error response,\nwhich should be set in the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the request\nmust be retried by using the fresh etag in the 409 response.", + "summary": "Update the default namespace setting.", + "path": "/api/2.0/settings/types/default_namespace_ws/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateDefaultNamespaceSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultNamespaceSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultNamespaceSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DefaultNamespaceSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "namespace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "namespace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultNamespaceSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.DefaultWarehouseId", + "name": "DefaultWarehouseId", + "description": "Warehouse to be selected by default for users in this workspace. Covers SQL workloads only and can be overridden by users.", + "package": { + "name": "settings" + }, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the Default Warehouse Id setting to its default value.", + "summary": "Delete the Default Warehouse Id setting.", + "path": "/api/2.0/settings/types/default_warehouse_id/names/default", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteDefaultWarehouseIdRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDefaultWarehouseIdResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the Default Warehouse Id setting.", + "summary": "Get the Default Warehouse Id setting.", + "path": "/api/2.0/settings/types/default_warehouse_id/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetDefaultWarehouseIdRequest", + "is_object": true + }, + "response": { + "pascal_name": "DefaultWarehouseId", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "string_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "string_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the Default Warehouse Id setting.", + "summary": "Update the Default Warehouse Id setting.", + "path": "/api/2.0/settings/types/default_warehouse_id/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateDefaultWarehouseIdRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseId", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseId", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DefaultWarehouseId", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "string_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "string_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseId", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.DisableLegacyAccess", + "name": "DisableLegacyAccess", + "description": "'Disabling legacy access' has the following impacts:\n\n1. Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation.\n2. Disables fallback mode on external location access from the workspace.\n3. Disables Databricks Runtime versions prior to 13.3LTS.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Deletes legacy access disablement status.", + "summary": "Delete Legacy Access Disablement Status.", + "path": "/api/2.0/settings/types/disable_legacy_access/names/default", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteDisableLegacyAccessRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDisableLegacyAccessResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves legacy access disablement Status.", + "summary": "Retrieve Legacy Access Disablement Status.", + "path": "/api/2.0/settings/types/disable_legacy_access/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDisableLegacyAccessRequest", + "is_object": true + }, + "response": { + "pascal_name": "DisableLegacyAccess", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_access", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_access", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates legacy access disablement status.", + "summary": "Update Legacy Access Disablement Status.", + "path": "/api/2.0/settings/types/disable_legacy_access/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateDisableLegacyAccessRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyAccess", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyAccess", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DisableLegacyAccess", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_access", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_access", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyAccess", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.DisableLegacyDbfs", + "name": "DisableLegacyDbfs", + "description": "Disabling legacy DBFS has the following implications:\n\n1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts).\n2. Disables Databricks Runtime versions prior to 13.3LTS.\n\nWhen the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions.\nThis setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute clusters and SQL warehouses.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.", + "summary": "Delete the disable legacy DBFS setting.", + "path": "/api/2.0/settings/types/disable_legacy_dbfs/names/default", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteDisableLegacyDbfsRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDisableLegacyDbfsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the disable legacy DBFS setting.", + "summary": "Get the disable legacy DBFS setting.", + "path": "/api/2.0/settings/types/disable_legacy_dbfs/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDisableLegacyDbfsRequest", + "is_object": true + }, + "response": { + "pascal_name": "DisableLegacyDbfs", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_dbfs", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_dbfs", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the disable legacy DBFS setting for the workspace.", + "summary": "Update the disable legacy DBFS setting.", + "path": "/api/2.0/settings/types/disable_legacy_dbfs/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateDisableLegacyDbfsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyDbfs", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyDbfs", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DisableLegacyDbfs", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_dbfs", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_dbfs", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyDbfs", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.DisableLegacyFeatures", + "name": "DisableLegacyFeatures", + "description": "Disable legacy features for new Databricks workspaces.\n\nFor newly created workspaces:\n1. Disables the use of DBFS root and mounts.\n2. Hive Metastore will not be provisioned.\n3. Disables the use of ‘No-isolation clusters’.\n4. Disables Databricks Runtime versions prior to 13.3LTS.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Delete", + "description": "Deletes the disable legacy features setting.", + "summary": "Delete the disable legacy features setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/disable_legacy_features/names/default", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteDisableLegacyFeaturesRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteDisableLegacyFeaturesResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the value of the disable legacy features setting.", + "summary": "Get the disable legacy features setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/disable_legacy_features/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDisableLegacyFeaturesRequest", + "is_object": true + }, + "response": { + "pascal_name": "DisableLegacyFeatures", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_features", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_features", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the value of the disable legacy features setting.", + "summary": "Update the disable legacy features setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/disable_legacy_features/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateDisableLegacyFeaturesRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyFeatures", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyFeatures", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DisableLegacyFeatures", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "disable_legacy_features", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "disable_legacy_features", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DisableLegacyFeatures", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "disasterrecovery.DisasterRecovery", + "name": "DisasterRecovery", + "description": "Manage disaster recovery configurations and execute failover operations.", + "package": { + "name": "disasterrecovery" + }, + "is_accounts": true, + "is_hidden_cli": true, + "docs_group": "disasterrecovery", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListFailoverGroupsRequest" + } + }, + "methods": [ + { + "name": "CreateFailoverGroup", + "description": "Create a new failover group.", + "summary": "Create a Failover Group.", + "path": "/api/disaster-recovery/v1/{parent=accounts/*}/failover-groups", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateFailoverGroupRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_group", + "description": "The failover group to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true + } + }, + { + "name": "failover_group_id", + "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_group_id", + "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "failover_group", + "description": "The failover group to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "failover_group", + "description": "The failover group to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "failover_group", + "description": "The failover group to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "failover_group_id", + "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "validate_only", + "description": "When true, validates the request without creating the failover group.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "create_time", + "description": "Time at which this failover group was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "effective_primary_region", + "description": "Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "replication_point", + "description": "The latest point in time to which data has been replicated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "state", + "description": "Aggregate state of the failover group.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroupState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "CREATING" + }, + { + "content": "CREATION_FAILED" + }, + { + "content": "DELETING" + }, + { + "content": "DELETION_FAILED" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "FAILOVER_FAILED" + }, + { + "content": "INITIAL_REPLICATION" + } + ] + } + }, + { + "name": "unity_catalog_assets", + "description": "Unity Catalog replication configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcReplicationConfig", + "is_object": true + } + }, + { + "name": "update_time", + "description": "Time at which this failover group was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_group_id", + "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateStableUrl", + "description": "Create a new stable URL.", + "summary": "Create a Stable URL.", + "path": "/api/disaster-recovery/v1/{parent=accounts/*}/stable-urls", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateStableUrlRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stable_url", + "description": "The stable URL to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StableUrl", + "is_object": true + } + }, + { + "name": "stable_url_id", + "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stable_url_id", + "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "stable_url", + "description": "The stable URL to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StableUrl", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "stable_url", + "description": "The stable URL to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StableUrl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "StableUrl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stable_url", + "description": "The stable URL to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StableUrl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "stable_url_id", + "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "validate_only", + "description": "When true, validates the request without creating the stable URL.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "failover_group_name", + "description": "Fully qualified resource name of the FailoverGroup this stable URL is\ncurrently linked to, in the format\n`accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when\nthe stable URL is not attached to any failover group. Server-controlled:\nwritten by CreateFailoverGroup / UpdateFailoverGroup on link, cleared by\nDeleteFailoverGroup / UpdateFailoverGroup on unlink.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stable_url_id", + "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteFailoverGroup", + "description": "Delete a failover group.", + "summary": "Delete a Failover Group.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteFailoverGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to delete.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to delete.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "etag", + "description": "Opaque version string for optimistic locking. If provided, must match the\ncurrent etag. If omitted, the delete proceeds without an etag check.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The fully qualified resource name of the failover group to delete.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to delete.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteStableUrl", + "description": "Delete a stable URL.", + "summary": "Delete a Stable URL.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteStableUrlRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "FailoverFailoverGroup", + "description": "Initiate a failover to a new primary region.", + "summary": "Failover a Failover Group to a new primary region.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}/failover", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "FailoverFailoverGroupRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to failover.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_primary_region", + "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_type", + "description": "The type of failover to perform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverFailoverGroupRequestFailoverType", + "enum": [ + { + "content": "FORCED" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to failover.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "target_primary_region", + "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_type", + "description": "The type of failover to perform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverFailoverGroupRequestFailoverType", + "enum": [ + { + "content": "FORCED" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "Opaque version string for optimistic locking. If provided, must match the\ncurrent etag. If omitted, the failover proceeds regardless of current state.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_type", + "description": "The type of failover to perform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverFailoverGroupRequestFailoverType", + "enum": [ + { + "content": "FORCED" + } + ] + } + }, + { + "name": "name", + "description": "The fully qualified resource name of the failover group to failover.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_primary_region", + "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group to failover.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_primary_region", + "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_type", + "description": "The type of failover to perform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverFailoverGroupRequestFailoverType", + "enum": [ + { + "content": "FORCED" + } + ] + } + } + ] + }, + { + "name": "GetFailoverGroup", + "description": "Get a failover group.", + "summary": "Get a Failover Group.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetFailoverGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully qualified resource name of the failover group.\nFormat: accounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStableUrl", + "description": "Get a stable URL.", + "summary": "Get a Stable URL.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetStableUrlRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StableUrl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "initial_workspace_id", + "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListFailoverGroups", + "description": "List failover groups.", + "summary": "List Failover Groups.", + "path": "/api/disaster-recovery/v1/{parent=accounts/*}/failover-groups", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListFailoverGroupsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFailoverGroupsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of failover groups to return per page:\n- when set to a value greater than 0, the page length is the minimum of this value\nand a server configured value;\n- when set to 0 or unset, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token received from a previous ListFailoverGroups call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token received from a previous ListFailoverGroups call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListStableUrls", + "description": "List stable URLs for an account.", + "summary": "List Stable URLs.", + "path": "/api/disaster-recovery/v1/{parent=accounts/*}/stable-urls", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListStableUrlsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListStableUrlsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of stable URLs to return per page:\n- when set to a value greater than 0, the page length is the minimum of this value\nand a server configured value;\n- when set to 0 or unset, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token received from a previous ListStableUrls call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource. Format: accounts/{account_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token received from a previous ListStableUrls call.\nProvide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateFailoverGroup", + "description": "Update a failover group.", + "summary": "Update a Failover Group.", + "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateFailoverGroupRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "failover_group", + "description": "The failover group with updated fields. The name field identifies the resource\nand is populated from the URL path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Comma-separated list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-separated list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "failover_group", + "description": "The failover group with updated fields. The name field identifies the resource\nand is populated from the URL path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "failover_group", + "description": "The failover group with updated fields. The name field identifies the resource\nand is populated from the URL path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "failover_group", + "description": "The failover group with updated fields. The name field identifies the resource\nand is populated from the URL path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroup", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-separated list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Time at which this failover group was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "effective_primary_region", + "description": "Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "replication_point", + "description": "The latest point in time to which data has been replicated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "state", + "description": "Aggregate state of the failover group.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FailoverGroupState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "CREATING" + }, + { + "content": "CREATION_FAILED" + }, + { + "content": "DELETING" + }, + { + "content": "DELETION_FAILED" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "FAILOVER_FAILED" + }, + { + "content": "INITIAL_REPLICATION" + } + ] + } + }, + { + "name": "unity_catalog_assets", + "description": "Unity Catalog replication configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcReplicationConfig", + "is_object": true + } + }, + { + "name": "update_time", + "description": "Time at which this failover group was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-separated list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "regions", + "description": "List of all regions participating in this failover group.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "workspace_sets", + "description": "Workspace sets, each containing workspaces that replicate to each other.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceSetList", + "array_value": { + "pascal_name": "WorkspaceSet", + "is_object": true + } + } + }, + { + "name": "initial_primary_region", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.EnableExportNotebook", + "name": "EnableExportNotebook", + "description": "Controls whether users can export notebooks and files from the Workspace UI. By default, this setting is enabled.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "GetEnableExportNotebook", + "description": "Gets the Notebook and File exporting setting.", + "summary": "Get the Notebook and File exporting setting.", + "path": "/api/2.0/settings/types/enable-export-notebook/names/default", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEnableExportNotebookRequest", + "is_object": true + }, + "response": { + "pascal_name": "EnableExportNotebook", + "is_object": true + } + }, + { + "name": "PatchEnableExportNotebook", + "description": "Updates the Notebook and File exporting setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.", + "summary": "Update the Notebook and File exporting setting.", + "path": "/api/2.0/settings/types/enable-export-notebook/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateEnableExportNotebookRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableExportNotebook", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableExportNotebook", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnableExportNotebook", + "is_object": true + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableExportNotebook", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.EnableIpAccessLists", + "name": "EnableIpAccessLists", + "description": "Controls the enforcement of IP access lists for accessing the account console.\nAllowing you to enable or disable restricted access based on IP addresses.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the value of the account IP access toggle setting to default (ON)", + "summary": "Delete the account IP access toggle setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/acct_ip_acl_enable/names/default", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteAccountIpAccessEnableRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteAccountIpAccessEnableResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the value of the account IP access toggle setting.", + "summary": "Get the account IP access toggle setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/acct_ip_acl_enable/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetAccountIpAccessEnableRequest", + "is_object": true + }, + "response": { + "pascal_name": "AccountIpAccessEnable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "acct_ip_acl_enable", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "acct_ip_acl_enable", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the value of the account IP access toggle setting.", + "summary": "Update the account IP access toggle setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/acct_ip_acl_enable/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateAccountIpAccessEnableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountIpAccessEnable", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountIpAccessEnable", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountIpAccessEnable", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "acct_ip_acl_enable", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "acct_ip_acl_enable", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountIpAccessEnable", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.EnableNotebookTableClipboard", + "name": "EnableNotebookTableClipboard", + "description": "Controls whether users can copy tabular data to the clipboard via the UI. By default, this setting is enabled.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "GetEnableNotebookTableClipboard", + "description": "Gets the Results Table Clipboard features setting.", + "summary": "Get the Results Table Clipboard features setting.", + "path": "/api/2.0/settings/types/enable-notebook-table-clipboard/names/default", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEnableNotebookTableClipboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "EnableNotebookTableClipboard", + "is_object": true + } + }, + { + "name": "PatchEnableNotebookTableClipboard", + "description": "Updates the Results Table Clipboard features setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.", + "summary": "Update the Results Table Clipboard features setting.", + "path": "/api/2.0/settings/types/enable-notebook-table-clipboard/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateEnableNotebookTableClipboardRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableNotebookTableClipboard", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableNotebookTableClipboard", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnableNotebookTableClipboard", + "is_object": true + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableNotebookTableClipboard", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.EnableResultsDownloading", + "name": "EnableResultsDownloading", + "description": "Controls whether users can download notebook results. By default, this setting is enabled.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "GetEnableResultsDownloading", + "description": "Gets the Notebook results download setting.", + "summary": "Get the Notebook results download setting.", + "path": "/api/2.0/settings/types/enable-results-downloading/names/default", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEnableResultsDownloadingRequest", + "is_object": true + }, + "response": { + "pascal_name": "EnableResultsDownloading", + "is_object": true + } + }, + { + "name": "PatchEnableResultsDownloading", + "description": "Updates the Notebook results download setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.", + "summary": "Update the Notebook results download setting.", + "path": "/api/2.0/settings/types/enable-results-downloading/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateEnableResultsDownloadingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableResultsDownloading", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableResultsDownloading", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnableResultsDownloading", + "is_object": true + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnableResultsDownloading", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "provisioning.EncryptionKeys", + "name": "EncryptionKeys", + "description": "These APIs manage encryption key configurations for this workspace (optional). A key\nconfiguration encapsulates the AWS KMS key information and some information about how\nthe key configuration can be used. There are two possible uses for key configurations:\n\n* Managed services: A key configuration can be used to encrypt a workspace's notebook and\nsecret data in the control plane, as well as Databricks SQL queries and query history.\n* Storage: A key configuration can be used to encrypt a workspace's DBFS and EBS data in\nthe data plane.\n\nIn both of these cases, the key configuration's ID is used when creating a new workspace.\nThis Preview feature is available if your account is on the E2 version of the platform.\nUpdating a running workspace with workspace storage encryption requires that the workspace\nis on the E2 version of the platform. If you have an older workspace, it might not be on\nthe E2 version of the platform. If you are not sure, contact your Databricks representative.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a customer-managed key configuration object for an account, specified by ID.\nThis operation uploads a reference to a customer-managed key to Databricks.\nIf the key is assigned as a workspace's customer-managed key for managed services,\nDatabricks uses the key to encrypt the workspaces notebooks and secrets in the control plane,\nin addition to Databricks SQL queries and query history. If it is specified as a\nworkspace's customer-managed key for workspace storage, the key encrypts the\nworkspace's root S3 bucket (which contains the workspace's root DBFS and system data)\nand, optionally, cluster EBS volume data.\n\n**Important**: Customer-managed keys are supported only for some deployment types,\nsubscription types, and AWS regions that currently support creation of Databricks workspaces.\n\nThis operation is available only if your account is on the E2 version of the\nplatform or on a select custom plan that allows multiple workspaces per account.\n\n**GCP only**: To create a customer-managed key on GCP, you must include the\n`X-Databricks-GCP-SA-Access-Token` HTTP header in your request. This header must contain\na Google Cloud OAuth access token with the `cloud-platform` scope. The Google identity\nassociated with the token must also have the `setIamPermissions` and `getIamPermissions`\nIAM permissions on the key resource. For details on obtaining this token, see\n[Authenticate with Google ID tokens](https://docs.databricks.com/gcp/en/dev-tools/auth/authentication-google-id.html).", + "summary": "Create encryption key configuration.", + "path": "/api/2.0/accounts/{account_id}/customer-managed-keys", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCustomerManagedKeyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "use_cases", + "description": "The cases that the key can be used for.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KeyUseCaseList", + "array_value": { + "pascal_name": "KeyUseCase", + "enum": [ + { + "content": "MANAGED_SERVICES" + }, + { + "content": "STORAGE" + } + ] + } + } + } + ], + "required_request_body_fields": [ + { + "name": "use_cases", + "description": "The cases that the key can be used for.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KeyUseCaseList", + "array_value": { + "pascal_name": "KeyUseCase", + "enum": [ + { + "content": "MANAGED_SERVICES" + }, + { + "content": "STORAGE" + } + ] + } + } + } + ] + }, + "response": { + "pascal_name": "CustomerManagedKey", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_key_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateAwsKeyInfo", + "is_object": true + } + }, + { + "name": "azure_key_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateAzureKeyInfo", + "is_object": true + } + }, + { + "name": "gcp_key_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateGcpKeyInfo", + "is_object": true + } + }, + { + "name": "use_cases", + "description": "The cases that the key can be used for.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KeyUseCaseList", + "array_value": { + "pascal_name": "KeyUseCase", + "enum": [ + { + "content": "MANAGED_SERVICES" + }, + { + "content": "STORAGE" + } + ] + } + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a customer-managed key configuration object for an account. You cannot delete a configuration that is associated with a running workspace.", + "summary": "Delete encryption key configuration.", + "path": "/api/2.0/accounts/{account_id}/customer-managed-keys/{customer_managed_key_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteEncryptionKeyRequest", + "is_object": true, + "required_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomerManagedKey", + "is_object": true + }, + "all_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a customer-managed key configuration object for an account, specified by ID.\nThis operation uploads a reference to a customer-managed key to Databricks.\nIf assigned as a workspace's customer-managed key for managed services, Databricks uses the\nkey to encrypt the workspaces notebooks and secrets in the control plane, in addition to\nDatabricks SQL queries and query history. If it is specified as a workspace's\ncustomer-managed key for storage, the key encrypts the workspace's root S3 bucket\n(which contains the workspace's root DBFS and system data) and, optionally, cluster EBS volume data.\n\n**Important**: Customer-managed keys are supported only for some deployment types,\nsubscription types, and AWS regions.\n\nThis operation is available only if your account is on the E2 version of the platform.\",", + "summary": "Get encryption key configuration.", + "path": "/api/2.0/accounts/{account_id}/customer-managed-keys/{customer_managed_key_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetEncryptionKeyRequest", + "is_object": true, + "required_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CustomerManagedKey", + "is_object": true + }, + "all_fields": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "customer_managed_key_id", + "description": "Databricks encryption key configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks customer-managed key configurations for an account.", + "summary": "List encryption key configuration.", + "path": "/api/2.0/accounts/{account_id}/customer-managed-keys", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListEncryptionKeysRequest", + "is_object": true + }, + "response": { + "pascal_name": "CustomerManagedKeyList", + "array_value": { + "pascal_name": "CustomerManagedKey", + "is_object": true + } + } + } + ] + }, + { + "id": "networking.Endpoints", + "name": "Endpoints", + "description": "These APIs manage endpoint configurations for this account.", + "package": { + "name": "networking" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListEndpointsRequest" + } + }, + "methods": [ + { + "name": "CreateEndpoint", + "description": "Creates a new network connectivity endpoint that enables private connectivity\nbetween your network resources and Databricks services.\n\nAfter creation, the endpoint is initially in the PENDING state. The Databricks\nendpoint service automatically reviews and approves the endpoint within a few\nminutes. Use the GET method to retrieve the latest endpoint state.\n\nAn endpoint can be used only after it reaches the APPROVED state.", + "summary": "Create a network endpoint.", + "path": "/api/networking/v1/{parent=accounts/*}/endpoints", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateEndpointRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Endpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "parent", + "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "account_id", + "description": "The Databricks Account in which the endpoint object exists.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "azure_private_endpoint_info", + "description": "Info for an Azure private endpoint.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzurePrivateEndpointInfo", + "is_object": true + } + }, + { + "name": "create_time", + "description": "The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_id", + "description": "The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the endpoint, which uniquely identifies the endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "description": "The state of the endpoint. The endpoint can only be used if the state is `APPROVED`.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointState", + "enum": [ + { + "content": "APPROVED" + }, + { + "content": "DISCONNECTED" + }, + { + "content": "FAILED" + }, + { + "content": "PENDING" + } + ] + } + }, + { + "name": "use_case", + "description": "The use case that determines the type of network connectivity this endpoint provides.\nThis field is automatically determined based on the endpoint configuration and cloud-specific settings.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointUseCase", + "enum": [ + { + "content": "SERVICE_DIRECT" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteEndpoint", + "description": "Deletes a network endpoint. This will remove the endpoint configuration from Databricks.\nDepending on the endpoint type and use case, you may also need to delete corresponding network resources\nin your cloud provider account.", + "summary": "Delete a network endpoint.", + "path": "/api/networking/v1/{name=accounts/*/endpoints/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetEndpoint", + "description": "Gets details of a specific network endpoint.", + "summary": "Get a network endpoint.", + "path": "/api/networking/v1/{name=accounts/*/endpoints/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Endpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The cloud provider region where this endpoint is located.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListEndpoints", + "description": "Lists all network connectivity endpoints for the account.", + "summary": "List network endpoints.", + "path": "/api/networking/v1/{parent=accounts/*}/endpoints", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListEndpointsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The parent resource name of the account to list endpoints for.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The parent resource name of the account to list endpoints for.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListEndpointsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The parent resource name of the account to list endpoints for.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The parent resource name of the account to list endpoints for.\nFormat: `accounts/{account_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "settings.EnhancedSecurityMonitoring", + "name": "EnhancedSecurityMonitoring", + "description": "Controls whether enhanced security monitoring is enabled for the current workspace. If the compliance security profile is enabled, this is automatically enabled.\nBy default, it is disabled. However, if the compliance security profile is enabled, this is automatically enabled.\n\nIf the compliance security profile is disabled, you can enable or disable this setting and it is not permanent.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Get", + "description": "Gets the enhanced security monitoring setting.", + "summary": "Get the enhanced security monitoring setting.", + "path": "/api/2.0/settings/types/shield_esm_enablement_ws_db/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEnhancedSecurityMonitoringSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "EnhancedSecurityMonitoringSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "enhanced_security_monitoring_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoring", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "enhanced_security_monitoring_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoring", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the enhanced security monitoring setting for the workspace. A fresh etag needs\nto be provided in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a `GET`\nrequest before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the\nrequest must be retried by using the fresh etag in the 409 response.", + "summary": "Update the enhanced security monitoring setting.", + "path": "/api/2.0/settings/types/shield_esm_enablement_ws_db/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateEnhancedSecurityMonitoringSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoringSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoringSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnhancedSecurityMonitoringSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "enhanced_security_monitoring_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoring", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "enhanced_security_monitoring_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoring", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EnhancedSecurityMonitoringSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "catalog.EntityTagAssignments", + "name": "EntityTagAssignments", + "description": "Tags are attributes that include keys and optional values that you can use to organize and categorize entities in Unity Catalog. Entity tagging is currently supported on catalogs, schemas, tables (including views), columns, volumes.\nWith these APIs, users can create, update, delete, and list tag assignments across Unity Catalog entities", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListEntityTagAssignmentsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a tag assignment for an Unity Catalog entity.\n\nTo add tags to Unity Catalog entities, you must own the entity or have the following privileges:\n- **APPLY TAG** on the entity\n- **USE SCHEMA** on the entity's parent schema\n- **USE CATALOG** on the entity's parent catalog\n\nTo add a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions](https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions).", + "summary": "Create an entity tag assignment.", + "path": "/api/2.1/unity-catalog/entity-tag-assignments", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateEntityTagAssignmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The source type of the tag assignment, e.g., user-assigned or system-assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignmentSourceType", + "enum": [ + { + "content": "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION" + } + ] + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_value", + "description": "The value of the tag", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The timestamp when the tag assignment was last updated", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "The user or principal who updated the tag assignment", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a tag assignment for an Unity Catalog entity by its key.\n\nTo delete tags from Unity Catalog entities, you must own the entity or have the following privileges:\n- **APPLY TAG** on the entity\n- **USE_SCHEMA** on the entity's parent schema\n- **USE_CATALOG** on the entity's parent catalog\n\nTo delete a governed tag from Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions](https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions).", + "summary": "Delete an entity tag assignment.", + "path": "/api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteEntityTagAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a tag assignment for an Unity Catalog entity by tag key.", + "summary": "Get an entity tag assignment.", + "path": "/api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetEntityTagAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "Required. The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List tag assignments for an Unity Catalog entity\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List entity tag assignments.", + "path": "/api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListEntityTagAssignmentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListEntityTagAssignmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Optional. Maximum number of tag assignments to return in a single page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Optional. Pagination token to retrieve the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Optional. Pagination token to retrieve the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates an existing tag assignment for an Unity Catalog entity.\n\nTo update tags to Unity Catalog entities, you must own the entity or have the following privileges:\n- **APPLY TAG** on the entity\n- **USE SCHEMA** on the entity's parent schema\n- **USE CATALOG** on the entity's parent catalog\n\nTo update a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions](https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions).", + "summary": "Update an entity tag assignment.", + "path": "/api/2.1/unity-catalog/entity-tag-assignments/{entity_type}/{entity_name}/tags/{tag_key}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateEntityTagAssignmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityTagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The source type of the tag assignment, e.g., user-assigned or system-assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignmentSourceType", + "enum": [ + { + "content": "TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION" + } + ] + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_value", + "description": "The value of the tag", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The timestamp when the tag assignment was last updated", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "The user or principal who updated the tag assignment", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of the entity to which the tag is assigned.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_name", + "description": "The fully qualified name of the entity to which the tag is assigned", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "environments.Environments", + "name": "Environments", + "description": "APIs to manage environment resources.\n\nThe Environments API provides management capabilities for different types of environments\nincluding workspace-level base environments that define the environment version and\ndependencies to be used in serverless notebooks and jobs.", + "package": { + "name": "environments" + }, + "docs_group": "environments", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListWorkspaceBaseEnvironmentsRequest" + } + }, + "methods": [ + { + "name": "CreateWorkspaceBaseEnvironment", + "description": "Creates a new WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously generate a materialized environment\nto optimize dependency resolution and is only marked as done when the materialized environment has been\nsuccessfully generated or has failed.", + "summary": "Create a workspace base environment.", + "path": "/api/environments/v1/workspace-base-environments", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateWorkspaceBaseEnvironmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "request_id", + "description": "A unique identifier for this request. A random UUID is recommended.\nThis request is only idempotent if a request_id is provided.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "workspace_base_environment_id", + "description": "The ID to use for the workspace base environment, which will become the final component of\nthe resource name.\nThis value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "base_environment_type", + "description": "The type of base environment (CPU or GPU).", + "is_request_body_field": true, + "entity": { + "pascal_name": "BaseEnvironmentType", + "enum": [ + { + "content": "CPU" + }, + { + "content": "GPU" + } + ] + } + }, + { + "name": "create_time", + "description": "Timestamp when the environment was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator_user_id", + "description": "User ID of the creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "filepath", + "description": "The WSFS or UC Volumes path to the environment YAML file.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_default", + "description": "Whether this is the default environment for the workspace.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "last_updated_user_id", + "description": "User ID of the last user who updated the environment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message", + "description": "Status message providing additional details about the environment status.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "The status of the materialized workspace base environment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironmentCacheStatus", + "enum": [ + { + "content": "CREATED" + }, + { + "content": "EXPIRED" + }, + { + "content": "FAILED" + }, + { + "content": "INVALID" + }, + { + "content": "PENDING" + }, + { + "content": "REFRESHING" + } + ] + } + }, + { + "name": "update_time", + "description": "Timestamp when the environment was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "DeleteWorkspaceBaseEnvironment", + "description": "Deletes a WorkspaceBaseEnvironment.\nDeleting a base environment may impact linked notebooks and jobs.\nThis operation is irreversible and should be performed only when you are certain the environment is no longer needed.", + "summary": "Delete a workspace base environment.", + "path": "/api/environments/v1/{name=workspace-base-environments/*}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteWorkspaceBaseEnvironmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDefaultWorkspaceBaseEnvironment", + "description": "Gets the default WorkspaceBaseEnvironment configuration for the workspace.\nReturns the current default base environment settings for both CPU and GPU compute.", + "summary": "Get the default workspace base environment configuration.", + "path": "/api/environments/v1/{name=default-workspace-base-environment}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDefaultWorkspaceBaseEnvironmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "A static resource name of the default workspace base environment.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "A static resource name of the default workspace base environment.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "A static resource name of the default workspace base environment.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "A static resource name of the default workspace base environment.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetOperation", + "description": "Gets the status of a long-running operation.\nClients can use this method to poll the operation result.", + "summary": "Get the status of a long-running operation.", + "path": "/api/environments/v1/{name=operations/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetOperationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetWorkspaceBaseEnvironment", + "description": "Retrieves a WorkspaceBaseEnvironment by its name.", + "summary": "Get a workspace base environment.", + "path": "/api/environments/v1/{name=workspace-base-environments/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceBaseEnvironmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to retrieve.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to retrieve.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to retrieve.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to retrieve.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListWorkspaceBaseEnvironments", + "description": "Lists all WorkspaceBaseEnvironments in the workspace.\n\nDatabricks provides the following base environments:\n\n- `workspace-base-environments/databricks_ai_...`: includes popular AI and deep learning packages for serverless GPU compute.\n\n- `workspace-base-environments/databricks_ml_...`: includes popular ML packages for serverless compute.\n\nDatabricks-provided base environments are versioned. For example, `workspace-base-environments/databricks_ml_v5` corresponds to the ML environment built on environment version 5.", + "summary": "List workspace base environments.", + "path": "/api/environments/v1/workspace-base-environments", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWorkspaceBaseEnvironmentsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListWorkspaceBaseEnvironmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of environments to return per page.\nDefault is 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "RefreshWorkspaceBaseEnvironment", + "description": "Refreshes the materialized environment for a WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.", + "summary": "Refresh materialized workspace base environment.", + "path": "/api/environments/v1/{name=workspace-base-environments/*}/refresh", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RefreshWorkspaceBaseEnvironmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "UpdateDefaultWorkspaceBaseEnvironment", + "description": "Updates the default WorkspaceBaseEnvironment configuration for the workspace.\nSets the specified base environments as the workspace defaults for CPU and/or GPU compute.", + "summary": "Update the default workspace base environment configuration.", + "path": "/api/environments/v1/{name=default-workspace-base-environment}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateDefaultWorkspaceBaseEnvironmentRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_workspace_base_environment", + "description": "Required. The default workspace base environment configuration to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).\nThe special value '*' indicates that all fields should be updated (full replacement).\nValid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment\n\nTo unset one or both defaults, include the field path(s) in the mask and omit them from the request body.\nTo unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).\nThe special value '*' indicates that all fields should be updated (full replacement).\nValid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment\n\nTo unset one or both defaults, include the field path(s) in the mask and omit them from the request body.\nTo unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "default_workspace_base_environment", + "description": "Required. The default workspace base environment configuration to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "default_workspace_base_environment", + "description": "Required. The default workspace base environment configuration to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + } + }, + "response": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + }, + "all_fields": [ + { + "name": "default_workspace_base_environment", + "description": "Required. The default workspace base environment configuration to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWorkspaceBaseEnvironment", + "is_object": true + } + }, + { + "name": "name", + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).\nThe special value '*' indicates that all fields should be updated (full replacement).\nValid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment\n\nTo unset one or both defaults, include the field path(s) in the mask and omit them from the request body.\nTo unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "cpu_workspace_base_environment", + "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gpu_workspace_base_environment", + "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of this singleton resource.\nFormat: default-workspace-base-environment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).\nThe special value '*' indicates that all fields should be updated (full replacement).\nValid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment\n\nTo unset one or both defaults, include the field path(s) in the mask and omit them from the request body.\nTo unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ] + }, + { + "name": "UpdateWorkspaceBaseEnvironment", + "description": "Updates an existing WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.", + "summary": "Update a workspace base environment.", + "path": "/api/environments/v1/{name=workspace-base-environments/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceBaseEnvironmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_base_environment", + "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "base_environment_type", + "description": "The type of base environment (CPU or GPU).", + "is_request_body_field": true, + "entity": { + "pascal_name": "BaseEnvironmentType", + "enum": [ + { + "content": "CPU" + }, + { + "content": "GPU" + } + ] + } + }, + { + "name": "create_time", + "description": "Timestamp when the environment was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator_user_id", + "description": "User ID of the creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "filepath", + "description": "The WSFS or UC Volumes path to the environment YAML file.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_default", + "description": "Whether this is the default environment for the workspace.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "last_updated_user_id", + "description": "User ID of the last user who updated the environment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message", + "description": "Status message providing additional details about the environment status.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "The status of the materialized workspace base environment.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBaseEnvironmentCacheStatus", + "enum": [ + { + "content": "CREATED" + }, + { + "content": "EXPIRED" + }, + { + "content": "FAILED" + }, + { + "content": "INVALID" + }, + { + "content": "PENDING" + }, + { + "content": "REFRESHING" + } + ] + } + }, + { + "name": "update_time", + "description": "Timestamp when the environment was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name for the workspace base environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + } + ] + }, + { + "id": "settings.EsmEnablementAccount", + "name": "EsmEnablementAccount", + "description": "The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces.\nBy default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable enhanced security monitoring individually for each workspace.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Get", + "description": "Gets the enhanced security monitoring setting for new workspaces.", + "summary": "Get the enhanced security monitoring setting for new workspaces.", + "path": "/api/2.0/accounts/{account_id}/settings/types/shield_esm_enablement_ac/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetEsmEnablementAccountSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "EsmEnablementAccountSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "esm_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccount", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "esm_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccount", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the value of the enhanced security monitoring setting for new workspaces.", + "summary": "Update the enhanced security monitoring setting for new workspaces.", + "path": "/api/2.0/accounts/{account_id}/settings/types/shield_esm_enablement_ac/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateEsmEnablementAccountSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccountSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccountSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EsmEnablementAccountSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "esm_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccount", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "esm_enablement_account", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccount", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EsmEnablementAccountSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "ml.Experiments", + "name": "Experiments", + "description": "Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment. Each experiment lets you visualize, search, and compare runs, as well as download run artifacts or metadata for analysis in other tools. Experiments are maintained in a Databricks hosted MLflow tracking server.\n\nExperiments are located in the workspace file tree. You manage experiments using the same tools you use to manage other workspace objects such as folders, notebooks, and libraries.", + "package": { + "name": "ml" + }, + "docs_group": "ml", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "GetHistoryRequest" + } + }, + "methods": [ + { + "name": "CreateExperiment", + "description": "Creates an experiment with a name. Returns the ID of the newly created experiment.\nValidates that another experiment with the same name does not already exist and fails\nif another experiment with the same name already exists.\n\nThrows `RESOURCE_ALREADY_EXISTS` if an experiment with the given name exists.\nNote: In some contexts, this error may be remapped to `ALREADY_EXISTS`.\nTo be safe, clients should check for both error codes.", + "summary": "Create experiment.", + "path": "/api/2.0/mlflow/experiments/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateExperiment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Experiment name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Experiment name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateExperimentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "artifact_location", + "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Experiment name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ExperimentTagList", + "array_value": { + "pascal_name": "ExperimentTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Experiment name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateLoggedModel", + "description": "Create a logged model.", + "summary": "Create a logged model.", + "path": "/api/2.0/mlflow/logged-models", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateLoggedModelRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment that owns the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment that owns the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateLoggedModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment that owns the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "model_type", + "description": "The type of the model, such as ``\"Agent\"``, ``\"Classifier\"``, ``\"LLM\"``.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the model (optional). If not specified one will be generated.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "params", + "description": "Parameters attached to the model.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelParameterList", + "array_value": { + "pascal_name": "LoggedModelParameter", + "is_object": true + } + } + }, + { + "name": "source_run_id", + "description": "The ID of the run that created the model.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "Tags attached to the model.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelTagList", + "array_value": { + "pascal_name": "LoggedModelTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The ID of the experiment that owns the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateRun", + "description": "Creates a new run within an experiment. A run is usually a single execution of a\nmachine learning or data ETL pipeline. MLflow uses runs to track the `mlflowParam`,\n`mlflowMetric`, and `mlflowRunTag` associated with a single execution.", + "summary": "Create a run.", + "path": "/api/2.0/mlflow/runs/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateRun", + "is_object": true + }, + "response": { + "pascal_name": "CreateRunResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_name", + "description": "The name of the run.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "start_time", + "description": "Unix timestamp in milliseconds of when the run started.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "tags", + "description": "Additional metadata for run.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RunTagList", + "array_value": { + "pascal_name": "RunTag", + "is_object": true + } + } + }, + { + "name": "user_id", + "description": "ID of the user executing the run.\nThis field is deprecated as of MLflow 1.0, and will be removed in a future\nMLflow release. Use 'mlflow.user' tag instead.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteExperiment", + "description": "Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion.\nIf the experiment uses FileStore, artifacts associated with the experiment are also deleted.", + "summary": "Delete an experiment.", + "path": "/api/2.0/mlflow/experiments/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteExperiment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteExperimentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteLoggedModel", + "description": "Delete a logged model.", + "summary": "Delete a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteLoggedModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteLoggedModelResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteLoggedModelTag", + "description": "Delete a tag on a logged model.", + "summary": "Delete a tag on a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}/tags/{tag_key}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteLoggedModelTagRequest", + "is_object": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete the tag from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The tag key.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete the tag from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The tag key.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteLoggedModelTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete the tag from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The tag key.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to delete the tag from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The tag key.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteRun", + "description": "Marks a run for deletion.", + "summary": "Delete a run.", + "path": "/api/2.0/mlflow/runs/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRun", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteRunResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteRuns", + "description": "Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at most\nmax_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on", + "summary": "Delete runs by creation time.", + "path": "/api/2.0/mlflow/databricks/runs/delete-runs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRuns", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_timestamp_millis", + "description": "The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_timestamp_millis", + "description": "The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_runs", + "description": "An optional positive integer indicating the maximum number of runs to delete. The maximum allowed value for\nmax_runs is 10000.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "max_timestamp_millis", + "description": "The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_timestamp_millis", + "description": "The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to\nor at this timestamp are deleted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "DeleteTag", + "description": "Deletes a tag on a run. Tags are run metadata that can be updated during a run and after\na run completes.", + "summary": "Delete a tag on a run.", + "path": "/api/2.0/mlflow/runs/delete-tag", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run that the tag was logged under. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size is 255 bytes. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "ID of the run that the tag was logged under. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size is 255 bytes. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. Maximum size is 255 bytes. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run that the tag was logged under. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run that the tag was logged under. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size is 255 bytes. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "FinalizeLoggedModel", + "description": "Finalize a logged model.", + "summary": "Finalize a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "FinalizeLoggedModelRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to finalize.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelStatus", + "enum": [ + { + "content": "LOGGED_MODEL_PENDING" + }, + { + "content": "LOGGED_MODEL_READY" + }, + { + "content": "LOGGED_MODEL_UPLOAD_FAILED" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to finalize.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "status", + "description": "Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelStatus", + "enum": [ + { + "content": "LOGGED_MODEL_PENDING" + }, + { + "content": "LOGGED_MODEL_READY" + }, + { + "content": "LOGGED_MODEL_UPLOAD_FAILED" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "FinalizeLoggedModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to finalize.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelStatus", + "enum": [ + { + "content": "LOGGED_MODEL_PENDING" + }, + { + "content": "LOGGED_MODEL_READY" + }, + { + "content": "LOGGED_MODEL_UPLOAD_FAILED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to finalize.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Whether or not the model is ready for use. ``\"LOGGED_MODEL_UPLOAD_FAILED\"`` indicates that something went wrong\nwhen logging the model weights / agent code.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelStatus", + "enum": [ + { + "content": "LOGGED_MODEL_PENDING" + }, + { + "content": "LOGGED_MODEL_READY" + }, + { + "content": "LOGGED_MODEL_UPLOAD_FAILED" + } + ] + } + } + ] + }, + { + "name": "GetByName", + "description": "Gets metadata for an experiment.\n\nThis endpoint will return deleted experiments, but prefers the active experiment\nif an active and deleted experiment share the same name. If multiple deleted\nexperiments share the same name, the API will return one of them.\n\nThrows `RESOURCE_DOES_NOT_EXIST` if no experiment with the specified name exists.", + "summary": "Get an experiment by name.", + "path": "/api/2.0/mlflow/experiments/get-by-name", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetByNameRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_name", + "description": "Name of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_name", + "description": "Name of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetExperimentByNameResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_name", + "description": "Name of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_name", + "description": "Name of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetExperiment", + "description": "Gets metadata for an experiment. This method works on deleted experiments.", + "summary": "Get an experiment.", + "path": "/api/2.0/mlflow/experiments/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetExperimentRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetExperimentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetHistory", + "description": "Gets a list of all values for the specified metric for a given run.", + "summary": "Get metric history for a run.", + "path": "/api/2.0/mlflow/metrics/get-history", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetHistoryRequest", + "is_object": true, + "required_fields": [ + { + "name": "metric_key", + "description": "Name of the metric.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metric_key", + "description": "Name of the metric.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetMetricHistoryResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of Metric records to return per paginated request. Default is set to 25,000. If set higher than\n25,000, a request Exception will be raised.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "metric_key", + "description": "Name of the metric.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Token indicating the page of metric histories to fetch.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run from which to fetch metric values. Must be provided.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run from which to fetch metric values. This field\nwill be removed in a future MLflow version.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metric_key", + "description": "Name of the metric.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token indicating the page of metric histories to fetch.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "GetLoggedModel", + "description": "Get a logged model.", + "summary": "Get a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetLoggedModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetLoggedModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get experiment permission levels.", + "path": "/api/2.0/permissions/experiments/{experiment_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetExperimentPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetExperimentPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of an experiment. Experiments can inherit permissions from their root object.", + "summary": "Get experiment permissions.", + "path": "/api/2.0/permissions/experiments/{experiment_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetExperimentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExperimentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRun", + "description": "Gets the metadata, metrics, params, and tags for a run. In the case where multiple metrics with the same key are\nlogged for a run, return only the value with the latest timestamp.\n\nIf there are multiple values with the latest timestamp, return the maximum of these values.", + "summary": "Get a run.", + "path": "/api/2.0/mlflow/runs/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run to fetch. Must be provided.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "run_id", + "description": "ID of the run to fetch. Must be provided.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetRunResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "ID of the run to fetch. Must be provided.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run to fetch. This field will\nbe removed in a future MLflow version.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run to fetch. Must be provided.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListArtifacts", + "description": "List artifacts for a run. Takes an optional `artifact_path` prefix which if specified,\nthe response contains only artifacts with the specified prefix.\nA maximum of 1000 artifacts will be retrieved for UC Volumes. Please call\n`/api/2.0/fs/directories{directory_path}` for listing artifacts in UC Volumes, which supports pagination. See [List\ndirectory contents | Files API](/api/workspace/files/listdirectorycontents).", + "summary": "List artifacts.", + "path": "/api/2.0/mlflow/artifacts/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListArtifactsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListArtifactsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_token", + "description": "The token indicating the page of artifact results to fetch. `page_token` is not supported when listing artifacts in UC\nVolumes. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call\n`/api/2.0/fs/directories{directory_path}` for listing artifacts in UC Volumes, which supports pagination. See [List\ndirectory contents | Files API](/api/workspace/files/listdirectorycontents).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "Filter artifacts matching this path (a relative path from the root artifact directory).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run whose artifacts to list. Must be provided.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run whose artifacts to list. This field will\nbe removed in a future MLflow version.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "The token indicating the page of artifact results to fetch. `page_token` is not supported when listing artifacts in UC\nVolumes. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call\n`/api/2.0/fs/directories{directory_path}` for listing artifacts in UC Volumes, which supports pagination. See [List\ndirectory contents | Files API](/api/workspace/files/listdirectorycontents).", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListExperiments", + "description": "Gets a list of all experiments.", + "summary": "List experiments.", + "path": "/api/2.0/mlflow/experiments/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListExperimentsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListExperimentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of experiments desired.\nIf `max_results` is unspecified, return all experiments.\nIf `max_results` is too large, it'll be automatically capped at 1000.\nCallers of this endpoint are encouraged to pass max_results explicitly and leverage\npage_token to iterate through experiments.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "description": "Token indicating the page of experiments to fetch", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "view_type", + "description": "Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments.", + "is_query": true, + "entity": { + "pascal_name": "ViewType", + "enum": [ + { + "content": "ACTIVE_ONLY" + }, + { + "content": "ALL" + }, + { + "content": "DELETED_ONLY" + } + ] + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token indicating the page of experiments to fetch", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "LogBatch", + "description": "Logs a batch of metrics, params, and tags for a run. If any data failed to be persisted, the server will respond\nwith an error (non-200 status code).\n\nIn case of error (due to internal server error or an invalid request), partial data may be written.\n\nYou can write metrics, params, and tags in interleaving fashion, but within a given entity type are guaranteed to\nfollow the order specified in the request body.\n\nThe overwrite behavior for metrics, params, and tags is as follows:\n\n* Metrics: metric values are never overwritten. Logging a metric (key, value, timestamp) appends to the set of values\nfor the metric with the provided key.\n\n* Tags: tag values can be overwritten by successive writes to the same tag key. That is, if multiple tag values\nwith the same key are provided in the same API request, the last-provided tag value is written. Logging the same\ntag (key, value) is permitted. Specifically, logging a tag is idempotent.\n\n* Parameters: once written, param values cannot be changed (attempting to overwrite a param value will result in an\nerror). However, logging the same param (key, value) is permitted. Specifically, logging a param is idempotent.\n\nRequest Limits\n-------------------------------\nA single JSON-serialized API request may be up to 1 MB in size and contain:\n\n* No more than 1000 metrics, params, and tags in total\n\n* Up to 1000 metrics\n\n* Up to 100 params\n\n* Up to 100 tags\n\nFor example, a valid request might contain 900 metrics, 50 params, and 50 tags, but logging 900 metrics, 50 params,\nand 51 tags is invalid.\n\nThe following limits also apply to metric, param, and tag keys and values:\n\n* Metric keys, param keys, and tag keys can be up to 250 characters in length\n\n* Parameter and tag values can be up to 250 characters in length", + "summary": "Log a batch of metrics/params/tags for a run.", + "path": "/api/2.0/mlflow/runs/log-batch", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogBatch", + "is_object": true + }, + "response": { + "pascal_name": "LogBatchResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "metrics", + "description": "Metrics to log. A single request can contain up to 1000 metrics, and up to 1000\nmetrics, params, and tags in total.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MetricList", + "array_value": { + "pascal_name": "Metric", + "is_object": true + } + } + }, + { + "name": "params", + "description": "Params to log. A single request can contain up to 100 params, and up to 1000\nmetrics, params, and tags in total.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ParamList", + "array_value": { + "pascal_name": "Param", + "is_object": true + } + } + }, + { + "name": "run_id", + "description": "ID of the run to log under", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "Tags to log. A single request can contain up to 100 tags, and up to 1000\nmetrics, params, and tags in total.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RunTagList", + "array_value": { + "pascal_name": "RunTag", + "is_object": true + } + } + } + ] + }, + { + "name": "LogInputs", + "description": "Logs inputs, such as datasets and models, to an MLflow Run.", + "summary": "Log inputs to a run.", + "path": "/api/2.0/mlflow/runs/log-inputs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogInputs", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run to log under", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "ID of the run to log under", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LogInputsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "datasets", + "description": "Dataset inputs", + "is_request_body_field": true, + "entity": { + "pascal_name": "DatasetInputList", + "array_value": { + "pascal_name": "DatasetInput", + "is_object": true + } + } + }, + { + "name": "models", + "description": "Model inputs", + "is_request_body_field": true, + "entity": { + "pascal_name": "ModelInputList", + "array_value": { + "pascal_name": "ModelInput", + "is_object": true + } + } + }, + { + "name": "run_id", + "description": "ID of the run to log under", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run to log under", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "LogLoggedModelParams", + "description": "Logs params for a logged model. A param is a key-value pair (string key, string value). Examples include\nhyperparameters used for ML model training. A param can be logged only once for a logged model, and\nattempting to overwrite an existing param with a different value will result in an error", + "summary": "Log params for a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}/params", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogLoggedModelParamsRequest", + "is_object": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to log params for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to log params for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LogLoggedModelParamsRequestResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to log params for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "params", + "description": "Parameters to attach to the model.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelParameterList", + "array_value": { + "pascal_name": "LoggedModelParameter", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to log params for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "LogMetric", + "description": "Log a metric for a run. A metric is a key-value pair (string key, float value) with an\nassociated timestamp. Examples include the various metrics that represent ML model accuracy.\nA metric can be logged multiple times.", + "summary": "Log a metric for a run.", + "path": "/api/2.0/mlflow/runs/log-metric", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogMetric", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "description": "Name of the metric.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "Double value of the metric being logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_float64": true + } + }, + { + "name": "timestamp", + "description": "Unix timestamp in milliseconds at the time metric was logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "description": "Name of the metric.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "Double value of the metric being logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_float64": true + } + }, + { + "name": "timestamp", + "description": "Unix timestamp in milliseconds at the time metric was logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "LogMetricResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dataset_digest", + "description": "Dataset digest of the dataset associated with the metric,\ne.g. an md5 hash of the dataset that uniquely identifies it\nwithin datasets of the same name.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataset_name", + "description": "The name of the dataset associated with the metric.\nE.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the metric.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "model_id", + "description": "ID of the logged model associated with the metric, if applicable", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run under which to log the metric. Must be provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the metric. This field will\nbe removed in a future MLflow version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "step", + "description": "Step at which to log the metric", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "timestamp", + "description": "Unix timestamp in milliseconds at the time metric was logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "value", + "description": "Double value of the metric being logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_float64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "key", + "description": "Name of the metric.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "Double value of the metric being logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_float64": true + } + }, + { + "name": "timestamp", + "description": "Unix timestamp in milliseconds at the time metric was logged.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "LogModel", + "description": "**Note:** the [Create a logged model](/api/workspace/experiments/createloggedmodel) API replaces this endpoint.\n\nLog a model to an MLflow Run.", + "summary": "Log a model.", + "path": "/api/2.0/mlflow/runs/log-model", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogModel", + "is_object": true + }, + "response": { + "pascal_name": "LogModelResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "model_json", + "description": "MLmodel file in json format.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run to log under", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "LogOutputs", + "description": "Logs outputs, such as models, from an MLflow Run.", + "summary": "Log outputs from a run.", + "path": "/api/2.0/mlflow/runs/outputs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogOutputsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "The ID of the Run from which to log outputs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "The ID of the Run from which to log outputs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LogOutputsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "models", + "description": "The model outputs from the Run.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ModelOutputList", + "array_value": { + "pascal_name": "ModelOutput", + "is_object": true + } + } + }, + { + "name": "run_id", + "description": "The ID of the Run from which to log outputs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "The ID of the Run from which to log outputs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "LogParam", + "description": "Logs a param used for a run. A param is a key-value pair (string key,\nstring value). Examples include hyperparameters used for ML model training and\nconstant dates and values used in an ETL pipeline. A param can be logged only once for a run.", + "summary": "Log a param for a run.", + "path": "/api/2.0/mlflow/runs/log-parameter", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogParam", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "description": "Name of the param. Maximum size is 255 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the param being logged. Maximum size is 500 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "description": "Name of the param. Maximum size is 255 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the param being logged. Maximum size is 500 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LogParamResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the param. Maximum size is 255 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run under which to log the param. Must be provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the param. This field will\nbe removed in a future MLflow version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the param being logged. Maximum size is 500 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "key", + "description": "Name of the param. Maximum size is 255 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the param being logged. Maximum size is 500 bytes.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RestoreExperiment", + "description": "Restore an experiment marked for deletion. This also restores\nassociated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying\nartifacts associated with experiment are also restored.\n\nThrows `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.", + "summary": "Restore an experiment.", + "path": "/api/2.0/mlflow/experiments/restore", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestoreExperiment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestoreExperimentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RestoreRun", + "description": "Restores a deleted run. This also restores associated metadata, runs, metrics, params, and tags.\n\nThrows `RESOURCE_DOES_NOT_EXIST` if the run was never created or was permanently deleted.", + "summary": "Restore a run.", + "path": "/api/2.0/mlflow/runs/restore", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestoreRun", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "ID of the run to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestoreRunResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "ID of the run to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RestoreRuns", + "description": "Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores at most\nmax_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on", + "summary": "Restore runs by deletion time.", + "path": "/api/2.0/mlflow/databricks/runs/restore-runs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestoreRuns", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "min_timestamp_millis", + "description": "The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "min_timestamp_millis", + "description": "The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "RestoreRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_runs", + "description": "An optional positive integer indicating the maximum number of runs to restore. The maximum allowed value for\nmax_runs is 10000.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "min_timestamp_millis", + "description": "The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The ID of the experiment containing the runs to restore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "min_timestamp_millis", + "description": "The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no\nearlier than this timestamp are restored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "SearchExperiments", + "description": "Searches for experiments that satisfy specified search criteria.", + "summary": "Search experiments.", + "path": "/api/2.0/mlflow/experiments/search", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SearchExperiments", + "is_object": true + }, + "response": { + "pascal_name": "SearchExperimentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "String representing a SQL filter condition (e.g. \"name ILIKE 'my-experiment%'\")", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of experiments desired. Max threshold is 3000.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "order_by", + "description": "List of columns for ordering search results, which can include experiment name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by experiment id DESC.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Token indicating the page of experiments to fetch", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "view_type", + "description": "Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ViewType", + "enum": [ + { + "content": "ACTIVE_ONLY" + }, + { + "content": "ALL" + }, + { + "content": "DELETED_ONLY" + } + ] + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token indicating the page of experiments to fetch", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SearchLoggedModels", + "description": "Search for Logged Models that satisfy specified search criteria.", + "summary": "Search logged models.", + "path": "/api/2.0/mlflow/logged-models/search", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SearchLoggedModelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "SearchLoggedModelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "datasets", + "description": "List of datasets on which to apply the metrics filter clauses.\nFor example, a filter with `metrics.accuracy \u003e 0.9` and dataset info with name \"test_dataset\"\nmeans we will return all logged models with accuracy \u003e 0.9 on the test_dataset.\nMetric values from ANY dataset matching the criteria are considered.\nIf no datasets are specified, then metrics across all datasets are considered in the filter.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SearchLoggedModelsDatasetList", + "array_value": { + "pascal_name": "SearchLoggedModelsDataset", + "is_object": true + } + } + }, + { + "name": "experiment_ids", + "description": "The IDs of the experiments in which to search for logged models.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "filter", + "description": "A filter expression over logged model info and data that allows returning a subset of\nlogged models. The syntax is a subset of SQL that supports AND'ing together binary operations.\n\nExample: ``params.alpha \u003c 0.3 AND metrics.accuracy \u003e 0.9``.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "The maximum number of Logged Models to return. The maximum limit is 50.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "order_by", + "description": "The list of columns for ordering the results, with additional fields for sorting criteria.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SearchLoggedModelsOrderByList", + "array_value": { + "pascal_name": "SearchLoggedModelsOrderBy", + "is_object": true + } + } + }, + { + "name": "page_token", + "description": "The token indicating the page of logged models to fetch.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SearchRuns", + "description": "Searches for runs that satisfy expressions.\n\nSearch expressions can use `mlflowMetric` and `mlflowParam` keys.", + "summary": "Search for runs.", + "path": "/api/2.0/mlflow/runs/search", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SearchRuns", + "is_object": true + }, + "response": { + "pascal_name": "SearchRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_ids", + "description": "List of experiment IDs to search over.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "filter", + "description": "A filter expression over params, metrics, and tags, that allows returning a subset of\nruns. The syntax is a subset of SQL that supports ANDing together binary operations\nbetween a param, metric, or tag and a constant.\n\nExample: `metrics.rmse \u003c 1 and params.model_class = 'LogisticRegression'`\n\nYou can select columns with special characters (hyphen, space, period, etc.) by using double quotes:\n`metrics.\"model class\" = 'LinearRegression' and tags.\"user-name\" = 'Tomas'`\n\nSupported operators are `=`, `!=`, `\u003e`, `\u003e=`, `\u003c`, and `\u003c=`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of runs desired. Max threshold is 50000", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "order_by", + "description": "List of columns to be ordered by, including attributes, params, metrics, and tags with an\noptional `\"DESC\"` or `\"ASC\"` annotation, where `\"ASC\"` is the default.\nExample: `[\"params.input DESC\", \"metrics.alpha ASC\", \"metrics.rmse\"]`.\nTiebreaks are done by start_time `DESC` followed by `run_id` for runs with the same start time\n(and this is the default ordering criterion if order_by is not provided).", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Token for the current page of runs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_view_type", + "description": "Whether to display only active, only deleted, or all runs.\nDefaults to only active runs.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ViewType", + "enum": [ + { + "content": "ACTIVE_ONLY" + }, + { + "content": "ALL" + }, + { + "content": "DELETED_ONLY" + } + ] + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token for the current page of runs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetExperimentTag", + "description": "Sets a tag on an experiment. Experiment tags are metadata that can be updated.", + "summary": "Set a tag for an experiment.", + "path": "/api/2.0/mlflow/experiments/set-experiment-tag", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetExperimentTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "ID of the experiment under which to log the tag. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "ID of the experiment under which to log the tag. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetExperimentTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the experiment under which to log the tag. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "ID of the experiment under which to log the tag. Must be provided.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetLoggedModelTags", + "description": "Set tags for a logged model.", + "summary": "Set tags for a logged model.", + "path": "/api/2.0/mlflow/logged-models/{model_id}/tags", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetLoggedModelTagsRequest", + "is_object": true, + "required_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to set the tags on.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to set the tags on.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetLoggedModelTagsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "model_id", + "description": "The ID of the logged model to set the tags on.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "The tags to set on the logged model.", + "is_request_body_field": true, + "entity": { + "pascal_name": "LoggedModelTagList", + "array_value": { + "pascal_name": "LoggedModelTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "model_id", + "description": "The ID of the logged model to set the tags on.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set experiment permissions.", + "path": "/api/2.0/permissions/experiments/{experiment_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExperimentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExperimentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ExperimentAccessControlRequestList", + "array_value": { + "pascal_name": "ExperimentAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetTag", + "description": "Sets a tag on a run. Tags are run metadata that can be updated during a run and after\na run completes.", + "summary": "Set a tag for a run.", + "path": "/api/2.0/mlflow/runs/set-tag", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "ID of the run under which to log the tag. Must be provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run under which to log the tag. This field will\nbe removed in a future MLflow version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "key", + "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateExperiment", + "description": "Updates experiment metadata.", + "summary": "Update an experiment.", + "path": "/api/2.0/mlflow/experiments/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateExperiment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateExperimentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "If provided, the experiment's name is changed to the new name. The new name must be unique.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "ID of the associated experiment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on an experiment. Experiments can inherit permissions from their root object.", + "summary": "Update experiment permissions.", + "path": "/api/2.0/permissions/experiments/{experiment_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExperimentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExperimentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ExperimentAccessControlRequestList", + "array_value": { + "pascal_name": "ExperimentAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The experiment for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateRun", + "description": "Updates run metadata.", + "summary": "Update a run.", + "path": "/api/2.0/mlflow/runs/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateRun", + "is_object": true + }, + "response": { + "pascal_name": "UpdateRunResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "end_time", + "description": "Unix timestamp in milliseconds of when the run ended.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "run_id", + "description": "ID of the run to update. Must be provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_name", + "description": "Updated name of the run.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_uuid", + "description": "[Deprecated, use `run_id` instead] ID of the run to update. This field will\nbe removed in a future MLflow version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Updated status of the run.", + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateRunStatus", + "enum": [ + { + "content": "FAILED" + }, + { + "content": "FINISHED" + }, + { + "content": "KILLED" + }, + { + "content": "RUNNING" + }, + { + "content": "SCHEDULED" + } + ] + } + } + ] + } + ] + }, + { + "id": "catalog.ExternalLineage", + "name": "ExternalLineage", + "description": "External Lineage APIs enable defining and managing lineage relationships between Databricks objects and external systems. These APIs allow users to capture data flows connecting Databricks tables, models, and file paths with external metadata objects.\n\nWith these APIs, users can create, update, delete, and list lineage relationships with support for column-level mappings and custom properties.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListExternalLineageRelationshipsRequest" + } + }, + "methods": [ + { + "name": "CreateExternalLineageRelationship", + "description": "Creates an external lineage relationship between a Databricks or external metadata object and another external metadata object.", + "summary": "Create an external lineage relationship.", + "path": "/api/2.0/lineage-tracking/external-lineage", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateExternalLineageRelationshipRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateRequestExternalLineage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateRequestExternalLineage", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateRequestExternalLineage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "ExternalLineageRelationship", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateRequestExternalLineage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + } + }, + { + "name": "columns", + "description": "List of column relationships between source and target objects.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ColumnRelationshipList", + "array_value": { + "pascal_name": "ColumnRelationship", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Unique identifier of the external lineage relationship.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "Key-value properties associated with the external lineage relationship.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + }, + { + "name": "DeleteExternalLineageRelationship", + "description": "Deletes an external lineage relationship between a Databricks or external metadata object and another external metadata object.", + "summary": "Delete an external lineage relationship.", + "path": "/api/2.0/lineage-tracking/external-lineage", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteExternalLineageRelationshipRequest", + "is_object": true, + "required_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "DeleteRequestExternalLineage", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "DeleteRequestExternalLineage", + "is_object": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "DeleteRequestExternalLineage", + "is_object": true + } + } + ] + }, + { + "name": "ListExternalLineageRelationships", + "description": "Lists external lineage relationships of a Databricks object or external metadata given a supplied direction.", + "summary": "List external lineage relationships.", + "path": "/api/2.0/lineage-tracking/external-lineage", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListExternalLineageRelationshipsRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_info", + "description": "The object to query external lineage relationships for.\nSince this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like:\n`object_info.table.name=main.sales.customers`", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "lineage_direction", + "description": "The lineage direction to filter on.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "LineageDirection", + "enum": [ + { + "content": "DOWNSTREAM" + }, + { + "content": "UPSTREAM" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "object_info", + "description": "The object to query external lineage relationships for.\nSince this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like:\n`object_info.table.name=main.sales.customers`", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "lineage_direction", + "description": "The lineage direction to filter on.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "LineageDirection", + "enum": [ + { + "content": "DOWNSTREAM" + }, + { + "content": "UPSTREAM" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "ListExternalLineageRelationshipsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "lineage_direction", + "description": "The lineage direction to filter on.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "LineageDirection", + "enum": [ + { + "content": "DOWNSTREAM" + }, + { + "content": "UPSTREAM" + } + ] + } + }, + { + "name": "object_info", + "description": "The object to query external lineage relationships for.\nSince this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like:\n`object_info.table.name=main.sales.customers`", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "page_size", + "description": "Specifies the maximum number of external lineage relationships to return in a single response.\nThe value must be less than or equal to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateExternalLineageRelationship", + "description": "Updates an external lineage relationship between a Databricks or external metadata object and another external metadata object.", + "summary": "Update an external lineage relationship.", + "path": "/api/2.0/lineage-tracking/external-lineage", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateExternalLineageRelationshipRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateRequestExternalLineage", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateRequestExternalLineage", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateRequestExternalLineage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "ExternalLineageRelationship", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "external_lineage_relationship", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdateRequestExternalLineage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "columns", + "description": "List of column relationships between source and target objects.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ColumnRelationshipList", + "array_value": { + "pascal_name": "ColumnRelationship", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Unique identifier of the external lineage relationship.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "Key-value properties associated with the external lineage relationship.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "Source object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + }, + { + "name": "target", + "description": "Target object of the external lineage relationship.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalLineageObject", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "catalog.ExternalLocations", + "name": "ExternalLocations", + "description": "An external location is an object that combines a cloud storage path with a storage\ncredential that authorizes access to the cloud storage path. Each external location is\nsubject to Unity Catalog access-control policies that control which users and groups can\naccess the credential. If a user does not have access to an external location in Unity\nCatalog, the request fails and Unity Catalog does not attempt to authenticate to your cloud\ntenant on the user’s behalf.\n\nDatabricks recommends using external locations rather than using storage credentials\ndirectly.\n\nTo create external locations, you must be a metastore admin or a user with the\n**CREATE_EXTERNAL_LOCATION** privilege.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListExternalLocationsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new external location entry in the metastore.\nThe caller must be a metastore admin or have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage credential.", + "summary": "Create an external location.", + "path": "/api/2.1/unity-catalog/external-locations", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateExternalLocation", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "Path URL of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "credential_name", + "description": "Name of the storage credential used with this location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "Path URL of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "credential_name", + "description": "Name of the storage credential used with this location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExternalLocationInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "credential_name", + "description": "Name of the storage credential used with this location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_enable_file_events", + "description": "The effective value of `enable_file_events` after applying server-side defaults.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_file_event_queue", + "description": "The effective file event queue configuration after applying server-side defaults.\nAlways populated when a queue is provisioned, regardless of whether the user explicitly\nset `enable_file_events`. Use this field instead of `file_event_queue` for reading\nthe actual queue state.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileEventQueue", + "is_object": true + } + }, + { + "name": "enable_file_events", + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "encryption_details", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EncryptionDetails", + "is_object": true + } + }, + { + "name": "fallback", + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "file_event_queue", + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileEventQueue", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Indicates whether the external location is read-only.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Skips validation of the storage credential associated with the external location.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "url", + "description": "Path URL of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "Path URL of the external location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "credential_name", + "description": "Name of the storage credential used with this location.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the specified external location from the metastore. The caller must be the owner of the external location.", + "summary": "Delete an external location.", + "path": "/api/2.1/unity-catalog/external-locations/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteExternalLocationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if there are dependent external tables or mounts.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets an external location from the metastore.\nThe caller must be either a metastore admin, the owner of the external location, or a user that has some privilege on the external location.", + "summary": "Get an external location.", + "path": "/api/2.1/unity-catalog/external-locations/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetExternalLocationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExternalLocationInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include external locations in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore.\nThe caller must be a metastore admin, the owner of the external location, or a user that has some privilege on the external location.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List external locations.", + "path": "/api/2.1/unity-catalog/external-locations", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListExternalLocationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListExternalLocationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include external locations in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_unbound", + "description": "Whether to include external locations not bound to the workspace.\nEffective only if the user has permission to update the location–workspace binding.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of external locations to return.\nIf not set, all the external locations are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of external locations to return.\nIf not set, all the external locations are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates an external location in the metastore. The caller must be the owner of the external location, or be a metastore admin.\nIn the second case, the admin can only update the name of the external location.", + "summary": "Update an external location.", + "path": "/api/2.1/unity-catalog/external-locations/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateExternalLocation", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExternalLocationInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "credential_name", + "description": "Name of the storage credential used with this location.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_enable_file_events", + "description": "The effective value of `enable_file_events` after applying server-side defaults.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "effective_file_event_queue", + "description": "The effective file event queue configuration after applying server-side defaults.\nAlways populated when a queue is provisioned, regardless of whether the user explicitly\nset `enable_file_events`. Use this field instead of `file_event_queue` for reading\nthe actual queue state.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileEventQueue", + "is_object": true + } + }, + { + "name": "enable_file_events", + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "encryption_details", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EncryptionDetails", + "is_object": true + } + }, + { + "name": "fallback", + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "file_event_queue", + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileEventQueue", + "is_object": true + } + }, + { + "name": "force", + "description": "Force update even if changing url invalidates dependent external tables or mounts.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "isolation_mode", + "is_request_body_field": true, + "entity": { + "pascal_name": "IsolationMode", + "enum": [ + { + "content": "ISOLATION_MODE_ISOLATED" + }, + { + "content": "ISOLATION_MODE_OPEN" + } + ] + } + }, + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the external location.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The owner of the external location.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Indicates whether the external location is read-only.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Skips validation of the storage credential associated with the external location.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "url", + "description": "Path URL of the external location.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external location.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.ExternalMetadata", + "name": "ExternalMetadata", + "description": "External Metadata objects enable customers to register and manage metadata about external systems within Unity Catalog.\n\nThese APIs provide a standardized way to create, update, retrieve, list, and delete external metadata objects. Fine-grained authorization ensures that only users with appropriate permissions can view and manage external metadata objects.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListExternalMetadataRequest" + } + }, + "methods": [ + { + "name": "CreateExternalMetadata", + "description": "Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the **CREATE_EXTERNAL_METADATA** privilege.\nGrants **BROWSE** to all account users upon creation by default.", + "summary": "Create an external metadata object.", + "path": "/api/2.0/lineage-tracking/external-metadata", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateExternalMetadataRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "columns", + "description": "List of columns associated with the external metadata object.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "create_time", + "description": "Time at which this external metadata object was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_by", + "description": "Username of external metadata object creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique identifier of the external metadata object.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "Unique identifier of parent metastore.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Owner of the external metadata object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the external metadata object.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "update_time", + "description": "Time at which this external metadata object was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_by", + "description": "Username of user who last modified external metadata object.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "URL associated with the external metadata object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteExternalMetadata", + "description": "Deletes the external metadata object that matches the supplied name.\nThe caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.", + "summary": "Delete an external metadata object.", + "path": "/api/2.0/lineage-tracking/external-metadata/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteExternalMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetExternalMetadata", + "description": "Gets the specified external metadata object in a metastore.\nThe caller must be a metastore admin, the owner of the external metadata object, or a user that has the **BROWSE** privilege.", + "summary": "Get an external metadata object.", + "path": "/api/2.0/lineage-tracking/external-metadata/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetExternalMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListExternalMetadata", + "description": "Gets an array of external metadata objects in the metastore.\nIf the caller is the metastore admin, all external metadata objects will be retrieved.\nOtherwise, only external metadata objects that the caller has **BROWSE** on will be retrieved.\nThere is no guarantee of a specific ordering of the elements in the array.", + "summary": "List external metadata objects.", + "path": "/api/2.0/lineage-tracking/external-metadata", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListExternalMetadataRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListExternalMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateExternalMetadata", + "description": "Updates the external metadata object that matches the supplied name. The caller can only update either the owner or other metadata fields in one request.\nThe caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MODIFY** privilege.\nIf the caller is updating the owner, they must also have the **MANAGE** privilege.", + "summary": "Update an external metadata object.", + "path": "/api/2.0/lineage-tracking/external-metadata/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateExternalMetadataRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "external_metadata", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalMetadata", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "columns", + "description": "List of columns associated with the external metadata object.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "create_time", + "description": "Time at which this external metadata object was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_by", + "description": "Username of external metadata object creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique identifier of the external metadata object.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "Unique identifier of parent metastore.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Owner of the external metadata object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the external metadata object.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "update_time", + "description": "Time at which this external metadata object was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_by", + "description": "Username of user who last modified external metadata object.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "URL associated with the external metadata object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the external metadata object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "system_type", + "description": "Type of external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SystemType", + "enum": [ + { + "content": "AMAZON_REDSHIFT" + }, + { + "content": "AZURE_SYNAPSE" + }, + { + "content": "CONFLUENT" + }, + { + "content": "DATABRICKS" + }, + { + "content": "GOOGLE_BIGQUERY" + }, + { + "content": "KAFKA" + }, + { + "content": "LOOKER" + }, + { + "content": "MICROSOFT_FABRIC" + }, + { + "content": "MICROSOFT_SQL_SERVER" + }, + { + "content": "MONGODB" + }, + { + "content": "MYSQL" + }, + { + "content": "ORACLE" + }, + { + "content": "OTHER" + }, + { + "content": "POSTGRESQL" + }, + { + "content": "POWER_BI" + }, + { + "content": "SALESFORCE" + }, + { + "content": "SAP" + }, + { + "content": "SERVICENOW" + }, + { + "content": "SNOWFLAKE" + }, + { + "content": "STREAM_NATIVE" + }, + { + "content": "TABLEAU" + }, + { + "content": "TERADATA" + }, + { + "content": "WORKDAY" + } + ] + } + }, + { + "name": "entity_type", + "description": "Type of entity within the external system.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "ml.FeatureEngineering", + "name": "FeatureEngineering", + "description": "[description]", + "package": { + "name": "ml" + }, + "is_hidden_cli": true, + "docs_group": "ml", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListFeaturesRequest" + } + }, + "methods": [ + { + "name": "CreateFeature", + "description": "Create a Feature.", + "summary": "Create a feature.", + "path": "/api/2.0/feature-engineering/features", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateFeatureRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature", + "description": "Feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature", + "description": "Feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "feature", + "description": "Feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "feature", + "description": "Feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Time at which this feature was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "Username of the feature creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the feature.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entities", + "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityColumnList", + "array_value": { + "pascal_name": "EntityColumn", + "is_object": true + } + } + }, + { + "name": "filter_condition", + "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + }, + { + "name": "inputs", + "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "lineage_context", + "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "LineageContext", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the feature, extracted from the full three-part name (catalog.schema.name).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "time_window", + "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TimeWindow", + "is_object": true + } + }, + { + "name": "timeseries_column", + "description": "Column recording time, used for point-in-time joins, backfills, and aggregations.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TimeseriesColumn", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + }, + { + "name": "CreateKafkaConfig", + "description": "Create a Kafka config.\nDuring PrPr, Kafka configs can be read and used when creating features under the entire metastore.\nOnly the creator of the Kafka config can delete it.", + "summary": "Create a Kafka config.", + "path": "/api/2.0/feature-engineering/features/kafka-configs", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateKafkaConfigRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "kafka_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "kafka_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "kafka_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "kafka_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + }, + { + "name": "backfill_source", + "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BackfillSource", + "is_object": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "extra_options", + "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "key_schema", + "description": "Schema configuration for extracting message keys from topics. At least one of key_schema and value_schema must be provided.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SchemaConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "value_schema", + "description": "Schema configuration for extracting message values from topics. At least one of key_schema and value_schema must be provided.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SchemaConfig", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + }, + { + "name": "CreateMaterializedFeature", + "description": "Create a materialized feature.", + "summary": "Create a materialized feature.", + "path": "/api/2.0/feature-engineering/materialized-features", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateMaterializedFeatureRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "materialized_feature", + "description": "The materialized feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "materialized_feature", + "description": "The materialized feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "materialized_feature", + "description": "The materialized feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "materialized_feature", + "description": "The materialized feature to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "cron_schedule", + "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule_trigger", + "description": "A cron-based schedule trigger for the materialization pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_online", + "description": "True if this is an online materialized feature. False if it is an offline materialized feature.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "last_materialization_time", + "description": "The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "offline_store_config", + "description": "Destination for writing feature values to an offline Delta table.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OfflineStoreConfig", + "is_object": true + } + }, + { + "name": "online_store_config", + "description": "Destination for writing feature values to an online Lakebase table.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OnlineStoreConfig", + "is_object": true + } + }, + { + "name": "pipeline_schedule_state", + "description": "The schedule state of the materialization pipeline.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeaturePipelineScheduleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "PAUSED" + }, + { + "content": "SNAPSHOT" + } + ] + } + }, + { + "name": "streaming_mode", + "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StreamingMode", + "is_object": true + } + }, + { + "name": "table_name", + "description": "The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_trigger", + "description": "A trigger that fires when the upstream source table changes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TableTrigger", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateStream", + "description": "Create a Stream, a governed UC entity representing an external streaming data source.", + "summary": "Create a Stream.", + "path": "/api/2.0/feature-engineering/streams", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateStreamRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "stream", + "description": "The Stream to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "stream", + "description": "The Stream to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "stream", + "description": "The Stream to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "stream", + "description": "The Stream to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the\nassociated object through the BROWSE privilege when include_browse is enabled in the request.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "create_time", + "description": "Time at which this Stream was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "Username of the Stream creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "User-provided description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "update_time", + "description": "Time at which this Stream was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "Username of user who last modified the Stream.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + }, + { + "name": "DeleteFeature", + "description": "Delete a Feature.", + "summary": "Delete a feature.", + "path": "/api/2.0/feature-engineering/features/{full_name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteFeatureRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Name of the feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Name of the feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Name of the feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Name of the feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteKafkaConfig", + "description": "Delete a Kafka config.\nDuring PrPr, Kafka configs can be read and used when creating features under the entire metastore.\nOnly the creator of the Kafka config can delete it.", + "summary": "Delete a Kafka config.", + "path": "/api/2.0/feature-engineering/features/kafka-configs/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteKafkaConfigRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the Kafka config to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteMaterializedFeature", + "description": "Delete a materialized feature.", + "summary": "Delete a materialized feature.", + "path": "/api/2.0/feature-engineering/materialized-features/{materialized_feature_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteMaterializedFeatureRequest", + "is_object": true, + "required_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteStream", + "description": "Delete a Stream by its full three-part name (catalog.schema.stream).", + "summary": "Delete a Stream.", + "path": "/api/2.0/feature-engineering/streams/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteStreamRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetFeature", + "description": "Get a Feature.", + "summary": "Get a feature.", + "path": "/api/2.0/feature-engineering/features/{full_name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetFeatureRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Name of the feature to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Name of the feature to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "full_name", + "description": "Name of the feature to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Name of the feature to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetKafkaConfig", + "description": "Get a Kafka config.\nDuring PrPr, Kafka configs can be read and used when creating features under the entire metastore.\nOnly the creator of the Kafka config can delete it.", + "summary": "Get a Kafka config.", + "path": "/api/2.0/feature-engineering/features/kafka-configs/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetKafkaConfigRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the Kafka config to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the Kafka config to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMaterializedFeature", + "description": "Get a materialized feature.", + "summary": "Get a materialized feature.", + "path": "/api/2.0/feature-engineering/materialized-features/{materialized_feature_id}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetMaterializedFeatureRequest", + "is_object": true, + "required_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "materialized_feature_id", + "description": "The ID of the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStream", + "description": "Get a Stream by its full three-part name (catalog.schema.stream).", + "summary": "Get a Stream.", + "path": "/api/2.0/feature-engineering/streams/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetStreamRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part name (catalog.schema.stream) of the Stream to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListFeatures", + "description": "List Features.", + "summary": "List features.", + "path": "/api/2.0/feature-engineering/features", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListFeaturesRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for features of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for features of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFeaturesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for features of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The maximum number of results to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for features of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListKafkaConfigs", + "description": "List Kafka configs.\nDuring PrPr, Kafka configs can be read and used when creating features under the entire metastore.\nOnly the creator of the Kafka config can delete it.", + "summary": "List Kafka configs.", + "path": "/api/2.0/feature-engineering/features/kafka-configs", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListKafkaConfigsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListKafkaConfigsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "kafka_configs", + "description": "List of Kafka configs. Schemas are not included in the response.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfigList", + "array_value": { + "pascal_name": "KafkaConfig", + "is_object": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "kafka_configs", + "description": "List of Kafka configs. Schemas are not included in the response.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfigList", + "array_value": { + "pascal_name": "KafkaConfig", + "is_object": true + } + } + } + ] + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of results to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListMaterializedFeatures", + "description": "List materialized features.", + "summary": "List materialized features.", + "path": "/api/2.0/feature-engineering/materialized-features", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListMaterializedFeaturesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListMaterializedFeaturesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "feature_name", + "description": "Filter by feature name. If specified, only materialized features materialized from this feature will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The maximum number of results to return. Defaults to 100 if not specified. Cannot be greater than 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListStreams", + "description": "List Streams under a given catalog.schema parent.", + "summary": "List Streams.", + "path": "/api/2.0/feature-engineering/streams", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListStreamsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListStreamsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of results to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Two-part name (catalog.schema) of the parent under which to list Streams.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateFeature", + "description": "Update a Feature.", + "summary": "Update a feature's description (all other fields are immutable).", + "path": "/api/2.0/feature-engineering/features/{full_name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateFeatureRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature", + "description": "Feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature", + "description": "Feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "feature", + "description": "Feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "feature", + "description": "Feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Feature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + } + }, + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Time at which this feature was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "Username of the feature creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "The description of the feature.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entities", + "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntityColumnList", + "array_value": { + "pascal_name": "EntityColumn", + "is_object": true + } + } + }, + { + "name": "filter_condition", + "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + }, + { + "name": "inputs", + "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "lineage_context", + "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "LineageContext", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the feature, extracted from the full three-part name (catalog.schema.name).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "time_window", + "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TimeWindow", + "is_object": true + } + }, + { + "name": "timeseries_column", + "description": "Column recording time, used for point-in-time joins, backfills, and aggregations.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TimeseriesColumn", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "The data source of the feature.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSource", + "is_object": true + } + }, + { + "name": "function", + "description": "The function by which the feature is computed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Function", + "is_object": true + } + } + ] + }, + { + "name": "UpdateKafkaConfig", + "description": "Update a Kafka config.\nDuring PrPr, Kafka configs can be read and used when creating features under the entire metastore.\nOnly the creator of the Kafka config can delete it.", + "summary": "Update a Kafka config.", + "path": "/api/2.0/feature-engineering/features/kafka-configs/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateKafkaConfigRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "kafka_config", + "description": "The Kafka config to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "kafka_config", + "description": "The Kafka config to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "kafka_config", + "description": "The Kafka config to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "kafka_config", + "description": "The Kafka config to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KafkaConfig", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + } + }, + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + }, + { + "name": "backfill_source", + "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BackfillSource", + "is_object": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "extra_options", + "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "key_schema", + "description": "Schema configuration for extracting message keys from topics. At least one of key_schema and value_schema must be provided.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SchemaConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "value_schema", + "description": "Schema configuration for extracting message values from topics. At least one of key_schema and value_schema must be provided.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SchemaConfig", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "bootstrap_servers", + "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_mode", + "description": "Options to configure which Kafka topics to pull data from.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SubscriptionMode", + "is_object": true + } + }, + { + "name": "auth_config", + "description": "Authentication configuration for connection to topics.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthConfig", + "is_object": true + } + } + ] + }, + { + "name": "UpdateMaterializedFeature", + "description": "Update a materialized feature (pause/resume).", + "summary": "Update a materialized feature.", + "path": "/api/2.0/feature-engineering/materialized-features/{materialized_feature_id}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateMaterializedFeatureRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "materialized_feature", + "description": "The materialized feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Provide the materialization feature fields which should be updated.\nCurrently, only the pipeline_state field can be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Provide the materialization feature fields which should be updated.\nCurrently, only the pipeline_state field can be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "materialized_feature", + "description": "The materialized feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "materialized_feature", + "description": "The materialized feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "materialized_feature", + "description": "The materialized feature to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeature", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Provide the materialization feature fields which should be updated.\nCurrently, only the pipeline_state field can be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule", + "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule_trigger", + "description": "A cron-based schedule trigger for the materialization pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_online", + "description": "True if this is an online materialized feature. False if it is an offline materialized feature.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "last_materialization_time", + "description": "The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "offline_store_config", + "description": "Destination for writing feature values to an offline Delta table.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OfflineStoreConfig", + "is_object": true + } + }, + { + "name": "online_store_config", + "description": "Destination for writing feature values to an online Lakebase table.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OnlineStoreConfig", + "is_object": true + } + }, + { + "name": "pipeline_schedule_state", + "description": "The schedule state of the materialization pipeline.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MaterializedFeaturePipelineScheduleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "PAUSED" + }, + { + "content": "SNAPSHOT" + } + ] + } + }, + { + "name": "streaming_mode", + "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StreamingMode", + "is_object": true + } + }, + { + "name": "table_name", + "description": "The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_trigger", + "description": "A trigger that fires when the upstream source table changes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TableTrigger", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "materialized_feature_id", + "description": "Server-assigned unique identifier for the materialized feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Provide the materialization feature fields which should be updated.\nCurrently, only the pipeline_state field can be updated.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The full name of the feature in Unity Catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateStream", + "description": "Update a Stream. Only fields listed in `update_mask` are mutated.", + "summary": "Update a Stream.", + "path": "/api/2.0/feature-engineering/streams/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateStreamRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stream", + "description": "The Stream to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "stream", + "description": "The Stream to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "stream", + "description": "The Stream to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "stream", + "description": "The Stream to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Stream", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the\nassociated object through the BROWSE privilege when include_browse is enabled in the request.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "create_time", + "description": "Time at which this Stream was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "Username of the Stream creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "User-provided description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "update_time", + "description": "Time at which this Stream was last modified.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "Username of user who last modified the Stream.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog.schema.stream) name of the stream.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "source_config", + "description": "Source-specific configuration. Determines the streaming platform source.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSourceConfig", + "is_object": true + } + }, + { + "name": "connection_config", + "description": "Specifies how to connect and authenticate to the stream platform.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamConnectionConfig", + "is_object": true + } + }, + { + "name": "schema_config", + "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "StreamSchemaConfig", + "is_object": true + } + }, + { + "name": "ingestion_config", + "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "IngestionConfig", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "ml.FeatureStore", + "name": "FeatureStore", + "description": "A feature store is a centralized repository that enables data scientists to find and share features. Using a feature store also ensures that the code used to compute feature values is the same during model training and when the model is used for inference.\n\nAn online store is a low-latency database used for feature lookup during real-time model inference or serve feature for real-time applications.", + "package": { + "name": "ml" + }, + "is_hidden_cli": true, + "docs_group": "ml", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListOnlineStoresRequest" + } + }, + "methods": [ + { + "name": "CreateOnlineStore", + "description": "Create an Online Feature Store.", + "summary": "Create an Online Feature Store.", + "path": "/api/2.0/feature-store/online-stores", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateOnlineStoreRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "online_store", + "description": "Online store to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "online_store", + "description": "Online store to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "online_store", + "description": "Online store to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "online_store", + "description": "Online store to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creation_time", + "description": "The timestamp when the online store was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the creator of the online store.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_replica_count", + "description": "The number of read replicas for the online store. Defaults to 0.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "state", + "description": "The current state of the online store.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStoreState", + "enum": [ + { + "content": "AVAILABLE" + }, + { + "content": "DELETING" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "STARTING" + }, + { + "content": "STOPPED" + }, + { + "content": "UPDATING" + } + ] + } + }, + { + "name": "usage_policy_id", + "description": "The usage policy applied to the online store to track billing.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteOnlineStore", + "description": "Delete an Online Feature Store.", + "summary": "Delete an Online Feature Store.", + "path": "/api/2.0/feature-store/online-stores/{name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteOnlineStoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the online store to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the online store to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the online store to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the online store to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteOnlineTable", + "description": "Delete online table.", + "summary": "Delete an online table.", + "path": "/api/2.0/feature-store/online-tables/{online_table_name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteOnlineTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "online_table_name", + "description": "The full three-part (catalog, schema, table) name of the online table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "online_table_name", + "description": "The full three-part (catalog, schema, table) name of the online table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "online_table_name", + "description": "The full three-part (catalog, schema, table) name of the online table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "online_table_name", + "description": "The full three-part (catalog, schema, table) name of the online table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetOnlineStore", + "description": "Get an Online Feature Store.", + "summary": "Get an Online Feature Store.", + "path": "/api/2.0/feature-store/online-stores/{name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetOnlineStoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the online store to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the online store to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the online store to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the online store to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListOnlineStores", + "description": "List Online Feature Stores.", + "summary": "List Online Feature Stores.", + "path": "/api/2.0/feature-store/online-stores", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListOnlineStoresRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListOnlineStoresResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of results to return. Defaults to 100 if not specified.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "PublishTable", + "description": "Publish features.", + "summary": "Publish features.", + "path": "/api/2.0/feature-store/tables/{source_table_name}/publish", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "PublishTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_table_name", + "description": "The full three-part (catalog, schema, table) name of the source table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "publish_spec", + "description": "The specification for publishing the online table from the source table.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublishSpec", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "source_table_name", + "description": "The full three-part (catalog, schema, table) name of the source table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "publish_spec", + "description": "The specification for publishing the online table from the source table.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublishSpec", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "PublishTableResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "publish_spec", + "description": "The specification for publishing the online table from the source table.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublishSpec", + "is_object": true + } + }, + { + "name": "source_table_name", + "description": "The full three-part (catalog, schema, table) name of the source table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "source_table_name", + "description": "The full three-part (catalog, schema, table) name of the source table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateOnlineStore", + "description": "Update an Online Feature Store.", + "summary": "Update an Online Feature Store.", + "path": "/api/2.0/feature-store/online-stores/{name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateOnlineStoreRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "online_store", + "description": "Online store to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "online_store", + "description": "Online store to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "online_store", + "description": "Online store to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "online_store", + "description": "Online store to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creation_time", + "description": "The timestamp when the online store was created.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "The email of the creator of the online store.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_replica_count", + "description": "The number of read replicas for the online store. Defaults to 0.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "state", + "description": "The current state of the online store.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineStoreState", + "enum": [ + { + "content": "AVAILABLE" + }, + { + "content": "DELETING" + }, + { + "content": "FAILING_OVER" + }, + { + "content": "STARTING" + }, + { + "content": "STOPPED" + }, + { + "content": "UPDATING" + } + ] + } + }, + { + "name": "usage_policy_id", + "description": "The usage policy applied to the online store to track billing.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the online store. This is the unique identifier for the online store.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "capacity", + "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.AccountFederationPolicy", + "name": "AccountFederationPolicy", + "description": "These APIs manage account federation policies.\n\nAccount federation policies allow users and service principals in your Databricks account to securely access Databricks APIs using tokens from your trusted identity providers (IdPs).\n\nWith token federation, your users and service principals can exchange tokens from your IdP for Databricks OAuth tokens, which can be used to access Databricks APIs. Token federation eliminates the need to manage Databricks secrets, and allows you to centralize management of token issuance policies in your IdP. Databricks token federation is typically used in combination with [SCIM](https://docs.databricks.com/admin/users-groups/scim/index.html), so users in your IdP are synchronized into your Databricks account.\n\nToken federation is configured in your Databricks account using an account federation policy. An account federation policy specifies:\n* which IdP, or issuer, your Databricks account should accept tokens from\n* how to determine which Databricks user, or subject, a token is issued for\n\nTo configure a federation policy, you provide the following:\n* The required token __issuer__, as specified in the “iss” claim of your tokens. The issuer is an https URL that identifies your IdP.\n* The allowed token __audiences__, as specified in the “aud” claim of your tokens. This identifier is intended to represent the recipient of the token. As long as the audience in the token matches at least one audience in the policy, the token is considered a match. If unspecified, the default value is your Databricks account id.\n* The __subject claim__, which indicates which token claim contains the Databricks username of the user the token was issued for. If unspecified, the default value is “sub”.\n* Optionally, the public keys used to validate the signature of your tokens, in JWKS format. If unspecified (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public keys.\n\nAn example federation policy is:\n```\nissuer: \"https://idp.mycompany.com/oidc\"\naudiences: [\"databricks\"]\nsubject_claim: \"sub\"\n```\n\nAn example JWT token body that matches this policy and could be used to authenticate to Databricks as user `username@mycompany.com` is:\n```\n{\n\"iss\": \"https://idp.mycompany.com/oidc\",\n\"aud\": \"databricks\",\n\"sub\": \"username@mycompany.com\"\n}\n```\n\nYou may also need to configure your IdP to generate tokens for your users to exchange with Databricks, if your users do not already have the ability to generate tokens that are compatible with your federation policy.\n\nYou do not need to configure an OAuth application in Databricks to use token federation.", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountFederationPoliciesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create account federation policy.", + "summary": "Create account federation policy.", + "path": "/api/2.0/accounts/{account_id}/federationPolicies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAccountFederationPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Creation time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the federation policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oidc_policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OidcFederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The ID of the federation policy. Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "uid", + "description": "Unique, immutable id of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Last update time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete account federation policy.", + "summary": "Delete account federation policy.", + "path": "/api/2.0/accounts/{account_id}/federationPolicies/{policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get account federation policy.", + "summary": "Get account federation policy.", + "path": "/api/2.0/accounts/{account_id}/federationPolicies/{policy_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List account federation policies.", + "summary": "List account federation policies.", + "path": "/api/2.0/accounts/{account_id}/federationPolicies", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountFederationPoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListFederationPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update account federation policy.", + "summary": "Update account federation policy.", + "path": "/api/2.0/accounts/{account_id}/federationPolicies/{policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAccountFederationPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Creation time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the federation policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oidc_policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OidcFederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The ID of the federation policy. Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "uid", + "description": "Unique, immutable id of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Last update time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "files.Files", + "name": "Files", + "description": "The Files API is a standard HTTP API that allows you to read, write, list, and delete files and directories by\nreferring to their URI. The API makes working with file content as raw bytes easier and more efficient.\n\nThe API supports [Unity Catalog volumes](https://docs.databricks.com/en/connect/unity-catalog/volumes.html), where files and directories to operate on are specified using their\nvolume URI path, which follows the format /Volumes/\u0026lt;catalog_name\u0026gt;/\u0026lt;schema_name\u0026gt;/\u0026lt;volume_name\u0026gt;/\u0026lt;path_to_file\u0026gt;.\n\nThe Files API has two distinct endpoints, one for working with files (`/fs/files`) and another one for working\nwith directories (`/fs/directories`). Both endpoints use the standard HTTP methods GET, HEAD, PUT, and DELETE to\nmanage files and directories specified using their URI path. The path is always absolute.\n\nUse of Files API may incur Databricks data transfer charges.", + "package": { + "name": "files" + }, + "docs_group": "files", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListDirectoryContentsRequest" + } + }, + "methods": [ + { + "name": "CreateDirectory", + "description": "Creates an empty directory. If necessary, also creates any parent directories of the\nnew, empty directory (like the shell command `mkdir -p`). If called on an existing\ndirectory, returns a success response; this method is idempotent (it will succeed if the directory already\nexists).", + "summary": "Create a directory.", + "path": "/api/2.0/fs/directories{directory_path}", + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateDirectoryRequest", + "is_object": true, + "required_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a file. If the request is successful, there is no response body.", + "summary": "Delete a file.", + "path": "/api/2.0/fs/files{file_path}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteFileRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDirectory", + "description": "Deletes an empty directory.\n\nTo delete a non-empty directory, first delete all of its contents. This can be done\nby listing the directory contents and deleting each file and subdirectory recursively.", + "summary": "Delete a directory.", + "path": "/api/2.0/fs/directories{directory_path}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteDirectoryRequest", + "is_object": true, + "required_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Download", + "description": "Downloads a file. The file contents are the response body. This is a\nstandard HTTP file download, not a JSON RPC. It supports the\nRange and If-Unmodified-Since HTTP headers.", + "summary": "Download a file.", + "path": "/api/2.0/fs/files{file_path}", + "is_crud_read": true, + "is_response_byte_stream": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DownloadRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DownloadResponse", + "is_object": true + }, + "response_body_field": { + "pascal_name": "Contents" + }, + "all_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDirectoryMetadata", + "description": "Get the metadata of a directory. The response HTTP headers contain the metadata.\nThere is no response body.\n\nThis method is useful to check if a directory exists and the caller has access to it.\n\nIf you wish to ensure the directory exists, you can instead use `PUT`, which will create\nthe directory if it does not exist, and is idempotent (it will succeed if the directory\nalready exists).", + "summary": "Get directory metadata.", + "path": "/api/2.0/fs/directories{directory_path}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetDirectoryMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMetadata", + "description": "Get the metadata of a file. The response HTTP headers contain the metadata. There is no\nresponse body.", + "summary": "Get file metadata.", + "path": "/api/2.0/fs/files{file_path}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListDirectoryContents", + "description": "Returns the contents of a directory.\nIf there is no directory at the specified path, the API returns a HTTP 404 error.", + "summary": "List directory contents.", + "path": "/api/2.0/fs/directories{directory_path}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListDirectoryContentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListDirectoryResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The maximum number of directory entries to return. The response may contain fewer\nentries. If the response contains a `next_page_token`, there may be more entries,\neven if fewer than `page_size` entries are in the response.\n\nWe recommend not to set this value unless you are intentionally listing less than\nthe complete directory contents.\n\nIf unspecified, at most 1000 directory entries will be returned.\nThe maximum value is 1000. Values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous\nrequest to list the contents of this directory. Provide this token to retrieve the\nnext page of directory entries.\nWhen providing a `page_token`, all other parameters provided to the request must match\nthe previous request.\nTo list all of the entries in a directory, it is necessary to continue requesting\npages of entries until the response contains no `next_page_token`. Note that the\nnumber of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "directory_path", + "description": "The absolute path of a directory.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous\nrequest to list the contents of this directory. Provide this token to retrieve the\nnext page of directory entries.\nWhen providing a `page_token`, all other parameters provided to the request must match\nthe previous request.\nTo list all of the entries in a directory, it is necessary to continue requesting\npages of entries until the response contains no `next_page_token`. Note that the\nnumber of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Upload", + "description": "Uploads a file of up to 5 GiB. The file contents should be sent as the request body as\nraw bytes (an octet stream); do not encode or otherwise modify the bytes before sending.\nThe contents of the resulting file will be exactly the bytes sent in the request body.\nIf the request is successful, there is no response body.", + "summary": "Upload a file.", + "path": "/api/2.0/fs/files{file_path}", + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UploadRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "contents", + "required": true, + "entity": {} + } + ], + "required_in_url_fields": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "request_body_field": { + "name": "contents", + "required": true, + "entity": {} + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "contents", + "required": true, + "entity": {} + }, + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "overwrite", + "description": "If true or unspecified, an existing file will be overwritten. If false, an error will be returned if the path points to an existing file.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_path", + "description": "The absolute path of the file.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "ml.Forecasting", + "name": "Forecasting", + "description": "The Forecasting API allows you to create and get serverless forecasting experiments", + "package": { + "name": "ml" + }, + "is_hidden_cli": true, + "docs_group": "ml", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "CreateExperiment", + "description": "Creates a serverless forecasting experiment. Returns the experiment ID.", + "summary": "Create a forecasting experiment.", + "path": "/api/2.0/automl/create-forecasting-experiment", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateForecastingExperimentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "train_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_column", + "description": "The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_column", + "description": "The column in the input training table that represents each row's timestamp.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_granularity", + "description": "The time interval between consecutive rows in the time series data.\nPossible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_horizon", + "description": "The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "train_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_column", + "description": "The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_column", + "description": "The column in the input training table that represents each row's timestamp.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_granularity", + "description": "The time interval between consecutive rows in the time series data.\nPossible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_horizon", + "description": "The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "CreateForecastingExperimentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "custom_weights_column", + "description": "The column in the training table used to customize weights for each time series.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "experiment_path", + "description": "The path in the workspace to store the created experiment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_granularity", + "description": "The time interval between consecutive rows in the time series data.\nPossible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_horizon", + "description": "The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "future_feature_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store future feature data for predictions.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "holiday_regions", + "description": "The region code(s) to automatically add holiday features. Currently supports only one region.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "include_features", + "description": "Specifies the list of feature columns to include in model training. These columns must exist\nin the training data and be of type string, numerical, or boolean. If not specified, no additional\nfeatures will be included.\nNote: Certain columns are automatically handled:\n- Automatically excluded: split_column, target_column, custom_weights_column.\n- Automatically included: time_column.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "max_runtime", + "description": "The maximum duration for the experiment in minutes. The experiment stops automatically if it exceeds this limit.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "prediction_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used to store predictions.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_metric", + "description": "The evaluation metric used to optimize the forecasting model.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "register_to", + "description": "The fully qualified path of a Unity Catalog model, formatted as catalog_name.schema_name.model_name, used to store the best model.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "split_column", + "description": "// The column in the training table used for custom data splits. Values must be 'train', 'validate', or 'test'.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_column", + "description": "The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_column", + "description": "The column in the input training table that represents each row's timestamp.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "timeseries_identifier_columns", + "description": "The column in the training table used to group the dataset for predicting individual time series.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "train_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "training_frameworks", + "description": "List of frameworks to include for model tuning. Possible values are 'Prophet', 'ARIMA', 'DeepAR'. An empty list includes all supported frameworks.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "train_data_path", + "description": "The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_column", + "description": "The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_column", + "description": "The column in the input training table that represents each row's timestamp.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_granularity", + "description": "The time interval between consecutive rows in the time series data.\nPossible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "forecast_horizon", + "description": "The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "SUCCEEDED" + } + ], + "timeout": 120, + "poll": { + "response": { + "pascal_name": "ForecastingExperiment" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ] + } + }, + { + "name": "GetExperiment", + "description": "Public RPC to get forecasting experiment", + "summary": "Get a forecasting experiment.", + "path": "/api/2.0/automl/get-forecasting-experiment/{experiment_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetForecastingExperimentRequest", + "is_object": true, + "required_fields": [ + { + "name": "experiment_id", + "description": "The unique ID of a forecasting experiment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "experiment_id", + "description": "The unique ID of a forecasting experiment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ForecastingExperiment", + "is_object": true + }, + "all_fields": [ + { + "name": "experiment_id", + "description": "The unique ID of a forecasting experiment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "experiment_id", + "description": "The unique ID of a forecasting experiment", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.Functions", + "name": "Functions", + "description": "Functions implement User-Defined Functions (UDFs) in Unity Catalog.\n\nThe function implementation can be any SQL expression or Query, and it can be invoked wherever a table reference is allowed in a query.\nIn Unity Catalog, a function resides at the same level as a table, so it can be referenced with the form __catalog_name__.__schema_name__.__function_name__.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "FunctionInfoNameToFullNameMap" + }, + "request": { + "pascal_name": "ListFunctionsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "**WARNING: This API is experimental and will change in future versions**\n\nCreates a new function\n\nThe user must have the following permissions in order for the function to be created:\n- **USE_CATALOG** on the function's parent catalog\n- **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema", + "summary": "Create a function.", + "path": "/api/2.1/unity-catalog/functions", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateFunctionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "function_info", + "description": "Partial __FunctionInfo__ specifying the function to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateFunction", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "function_info", + "description": "Partial __FunctionInfo__ specifying the function to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateFunction", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "FunctionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "function_info", + "description": "Partial __FunctionInfo__ specifying the function to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateFunction", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the function that matches the supplied name.\nFor the deletion to succeed, the user must satisfy one of the following conditions:\n- Is the owner of the function's parent catalog\n- Is the owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent catalog\n- Is the owner of the function itself and have both the **USE_CATALOG** privilege on its parent catalog and the **USE_SCHEMA** privilege on its parent schema", + "summary": "Delete a function.", + "path": "/api/2.1/unity-catalog/functions/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteFunctionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the function is notempty.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a function from within a parent catalog and schema.\nFor the fetch to succeed, the user must satisfy one of the following requirements:\n- Is a metastore admin\n- Is an owner of the function's parent catalog\n- Have the **USE_CATALOG** privilege on the function's parent catalog and be the owner of the function\n- Have the **USE_CATALOG** privilege on the function's parent catalog, the **USE_SCHEMA** privilege on the function's parent schema, and the **EXECUTE** privilege on the function itself", + "summary": "Get a function.", + "path": "/api/2.1/unity-catalog/functions/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetFunctionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FunctionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include functions in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List functions within the specified parent catalog and schema.\nIf the user is a metastore admin, all functions are returned in the output list.\nOtherwise, the user must have the **USE_CATALOG** privilege on the catalog and the **USE_SCHEMA** privilege on the schema, and the output list contains only functions for which either the user has the **EXECUTE** privilege or the user is the owner.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List functions.", + "path": "/api/2.1/unity-catalog/functions", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListFunctionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for functions of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of functions.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for functions of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of functions.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFunctionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for functions of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include functions in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of functions to return.\nIf not set, all the functions are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of functions.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for functions of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of functions.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of functions to return.\nIf not set, all the functions are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates the function that matches the supplied name.\nOnly the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner.\n- Is a metastore admin\n- Is the owner of the function's parent catalog\n- Is the owner of the function's parent schema and has the **USE_CATALOG** privilege on its parent catalog\n- Is the owner of the function itself and has the **USE_CATALOG** privilege on its parent catalog as well as the **USE_SCHEMA** privilege on the function's parent schema.", + "summary": "Update a function.", + "path": "/api/2.1/unity-catalog/functions/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateFunction", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FunctionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of the function.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "dashboards.Genie", + "name": "Genie", + "description": "Genie provides a no-code experience for business users, powered by AI/BI. Analysts set up spaces that business users can use to ask questions using natural language. Genie uses data registered to Unity Catalog and requires at least CAN USE permission on a Pro or Serverless SQL warehouse. Also, Databricks Assistant must be enabled.", + "package": { + "name": "dashboards" + }, + "docs_group": "dashboards", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "CreateMessage", + "description": "Create new message in a [conversation](:method:genie/startconversation).\nThe AI response uses all previously created messages in the conversation to respond.", + "summary": "Create conversation message.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieCreateConversationMessageRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is started.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is started.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "content", + "description": "User message content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieMessage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "content", + "description": "User message content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is started.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is started.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "COMPLETED" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "GenieMessage" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ] + } + }, + { + "name": "CreateMessageComment", + "description": "Create a comment on a conversation message.", + "summary": "Create message comment.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/comments", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GenieCreateMessageCommentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "Comment text content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "content", + "description": "Comment text content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieMessageComment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_comment_id", + "description": "Comment ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "Comment text content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_comment_id", + "description": "Comment ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "Comment text content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "content", + "description": "Comment text content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "Comment text content.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateSpace", + "description": "Creates a Genie space from a serialized payload.", + "summary": "Create Genie Space.", + "path": "/api/2.0/genie/spaces", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieCreateSpaceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "warehouse_id", + "description": "Warehouse to associate with the new space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_space", + "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "warehouse_id", + "description": "Warehouse to associate with the new space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_space", + "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieSpace", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "description", + "description": "Optional description", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_path", + "description": "Parent folder path where the space will be registered", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_space", + "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Optional title override", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Warehouse to associate with the new space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "warehouse_id", + "description": "Warehouse to associate with the new space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_space", + "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteConversation", + "description": "Delete a conversation.", + "summary": "Delete conversation.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieDeleteConversationRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID of the conversation to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteConversationMessage", + "description": "Delete a conversation message.", + "summary": "Delete conversation message.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieDeleteConversationMessageRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ExecuteMessageAttachmentQuery", + "description": "Execute the SQL for a message query attachment. Use this API when the query attachment has expired and needs to be re-executed.", + "summary": "Execute message attachment SQL query.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/execute-query", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieExecuteMessageAttachmentQueryRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetMessageQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ExecuteMessageQuery", + "description": "DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery) instead.", + "summary": "[Deprecated] Execute SQL query in a conversation message.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/execute-query", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GenieExecuteMessageQueryRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetMessageQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenerateDownloadFullQueryResult", + "description": "Initiates a new SQL execution and returns a `download_id` and `download_id_signature` that you can use to track the progress of the download.\nThe query result is stored in an external link and can be retrieved using the [Get Download Full Query Result](:method:genie/getdownloadfullqueryresult) API.\nBoth `download_id` and `download_id_signature` must be provided when calling the Get endpoint.\n\n----\n\n### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**\n\nWhen you use the `EXTERNAL_LINKS` disposition, a\nshort-lived, URL is generated, which can be\nused to download the results directly\nfrom . As a\nshort-lived is\nembedded in this URL, you should protect\nthe URL.\n\nBecause URLs are already generated with\nembedded temporary s,\nyou must not set an `Authorization` header in the download requests.\n\nSee [Execute Statement](:method:statementexecution/executestatement) for more details.\n\n----", + "summary": "Generate full query result download.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/downloads", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieGenerateDownloadFullQueryResultRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGenerateDownloadFullQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenieCreateEvalRun", + "description": "Create and run evaluations for multiple benchmark questions in a Genie space.", + "summary": "Create eval run for benchmarks.", + "path": "/api/2.0/genie/spaces/{space_id}/eval-runs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenieCreateEvalRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluations will be executed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluations will be executed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieEvalRunResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "benchmark_question_ids", + "description": "List of benchmark question IDs to evaluate. These questions must exist in the specified Genie space. If none are specified, then all benchmark questions are evaluated.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluations will be executed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluations will be executed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenieGetEvalResultDetails", + "description": "Get details for evaluation results.", + "summary": "Get benchmark evaluation result details.", + "path": "/api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}/results/{result_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenieGetEvalResultDetailsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieEvalResultDetails", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID of the space the evaluation result belongs to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "benchmark_question_id", + "description": "The ID of the benchmark question that was evaluated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID of the space the evaluation result belongs to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "benchmark_question_id", + "description": "The ID of the benchmark question that was evaluated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "result_id", + "description": "The unique identifier for the evaluation result.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenieGetEvalRun", + "description": "Get evaluation run details.", + "summary": "Get benchmark evaluation run.", + "path": "/api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenieGetEvalRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieEvalRunResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "eval_run_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenieListEvalResults", + "description": "List evaluation results for a specific evaluation run.", + "summary": "List benchmark evaluation results.", + "path": "/api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}/results", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenieListEvalResultsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListEvalResultsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of eval results to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token to retrieve the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "eval_run_id", + "description": "The unique identifier for the evaluation run.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GenieListEvalRuns", + "description": "Lists all evaluation runs in a space.", + "summary": "List all evaluation runs in the space.", + "path": "/api/2.0/genie/spaces/{space_id}/eval-runs", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenieListEvalRunsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListEvalRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of evaluation runs to return per page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Token to get the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the evaluation run is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDownloadFullQueryResult", + "description": "After [Generating a Full Query Result Download](:method:genie/generatedownloadfullqueryresult) and successfully receiving a `download_id` and `download_id_signature`, use this API to poll the download progress.\nBoth `download_id` and `download_id_signature` are required to call this endpoint.\nWhen the download is complete, the API returns the result in the `EXTERNAL_LINKS` disposition, containing one or more external links to the query result files.\n\n----\n\n### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**\n\nWhen you use the `EXTERNAL_LINKS` disposition, a\nshort-lived, URL is generated, which can be\nused to download the results directly\nfrom . As a\nshort-lived is\nembedded in this URL, you should protect\nthe URL.\n\nBecause URLs are already generated with\nembedded temporary s,\nyou must not set an `Authorization` header in the download requests.\n\nSee [Execute Statement](:method:statementexecution/executestatement) for more details.\n\n----", + "summary": "Get download full query result.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/downloads/{download_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieGetDownloadFullQueryResultRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id", + "description": "Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult)", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id_signature", + "description": "JWT signature for the download_id to ensure secure access to query results", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id", + "description": "Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult)", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id_signature", + "description": "JWT signature for the download_id to ensure secure access to query results", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetDownloadFullQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id", + "description": "Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult)", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id_signature", + "description": "JWT signature for the download_id to ensure secure access to query results", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id", + "description": "Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult)", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "download_id_signature", + "description": "JWT signature for the download_id to ensure secure access to query results", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMessage", + "description": "Get message from conversation.", + "summary": "Get conversation message.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieGetConversationMessageRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the target conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the target conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the target message from the identified conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the target conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the target conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the target message from the identified conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieMessage", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "User message content", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID associated with the target conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the target message from the identified conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the target conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the target conversation is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the target conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the target message from the identified conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMessageAttachmentQueryResult", + "description": "Get the result of SQL query if the message has a query attachment.\nThis is only available if a message has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`.", + "summary": "Get message attachment SQL query result.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}/query-result", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieGetMessageAttachmentQueryResultRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetMessageQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMessageQueryResult", + "description": "DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.", + "summary": "[Deprecated] Get conversation message SQL query result.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/query-result", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GenieGetMessageQueryResultRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetMessageQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetMessageQueryResultByAttachment", + "description": "DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead.", + "summary": "[Deprecated] Get conversation message SQL query result.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/query-result/{attachment_id}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GenieGetQueryResultByAttachmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieGetMessageQueryResultResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "attachment_id", + "description": "Attachment ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSpace", + "description": "Get details of a Genie Space.", + "summary": "Get Genie Space.", + "path": "/api/2.0/genie/spaces/{space_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieGetSpaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieSpace", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "include_serialized_space", + "description": "Whether to include the serialized space export in the response.\nRequires at least CAN EDIT permission on the space.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListConversationComments", + "description": "List all comments across all messages in a conversation.", + "summary": "List conversation comments.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/list-comments", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GenieListConversationCommentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListConversationCommentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of comments to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token for getting the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListConversationMessages", + "description": "List messages in a conversation", + "summary": "List conversation messages.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieListConversationMessagesRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to list messages from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to list messages from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListConversationMessagesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID of the conversation to list messages from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of messages to return per page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Token to get the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the conversation is located", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID of the conversation to list messages from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListConversations", + "description": "Get a list of conversations in a Genie Space.", + "summary": "List conversations in a Genie Space.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieListConversationsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID of the Genie space to retrieve conversations from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID of the Genie space to retrieve conversations from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListConversationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_all", + "description": "Include all conversations in the space across all users.\nRequires at least CAN MANAGE permission on the space.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "description": "Maximum number of conversations to return per page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Token to get the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID of the Genie space to retrieve conversations from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID of the Genie space to retrieve conversations from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListMessageComments", + "description": "List comments on a specific conversation message.", + "summary": "List message comments.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/comments", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GenieListMessageCommentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieListMessageCommentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of comments to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token for getting the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListSpaces", + "description": "Get list of Genie Spaces.", + "summary": "List Genie spaces.", + "path": "/api/2.0/genie/spaces", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieListSpacesRequest", + "is_object": true + }, + "response": { + "pascal_name": "GenieListSpacesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of spaces to return per page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token for getting the next page of results", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SendMessageFeedback", + "description": "Send feedback for a message.", + "summary": "Send message feedback.", + "path": "/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/feedback", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieSendMessageFeedbackRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to provide feedback for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rating", + "description": "The rating (POSITIVE, NEGATIVE, or NONE).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "GenieFeedbackRating", + "enum": [ + { + "content": "NEGATIVE" + }, + { + "content": "NONE" + }, + { + "content": "POSITIVE" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to provide feedback for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "rating", + "description": "The rating (POSITIVE, NEGATIVE, or NONE).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "GenieFeedbackRating", + "enum": [ + { + "content": "NEGATIVE" + }, + { + "content": "NONE" + }, + { + "content": "POSITIVE" + } + ] + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "comment", + "description": "Optional text feedback that will be stored as a comment.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to provide feedback for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rating", + "description": "The rating (POSITIVE, NEGATIVE, or NONE).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "GenieFeedbackRating", + "enum": [ + { + "content": "NEGATIVE" + }, + { + "content": "NONE" + }, + { + "content": "POSITIVE" + } + ] + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where the message is located.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "The ID associated with the conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "message_id", + "description": "The ID associated with the message to provide feedback for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rating", + "description": "The rating (POSITIVE, NEGATIVE, or NONE).", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "GenieFeedbackRating", + "enum": [ + { + "content": "NEGATIVE" + }, + { + "content": "NONE" + }, + { + "content": "POSITIVE" + } + ] + } + } + ] + }, + { + "name": "StartConversation", + "description": "Start a new conversation.", + "summary": "Start conversation.", + "path": "/api/2.0/genie/spaces/{space_id}/start-conversation", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieStartConversationMessageRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where you want to start a conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "The text of the message that starts the conversation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where you want to start a conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "content", + "description": "The text of the message that starts the conversation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieStartConversationResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "message_id", + "description": "Message ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "conversation_id", + "description": "Conversation ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "content", + "description": "The text of the message that starts the conversation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "The ID associated with the Genie space where you want to start a conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space where you want to start a conversation.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "content", + "description": "The text of the message that starts the conversation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "COMPLETED" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "GenieMessage" + } + }, + "status_path": [ + { + "pascal_name": "Status" + } + ] + } + }, + { + "name": "TrashSpace", + "description": "Move a Genie Space to the trash.", + "summary": "Trash Genie Space.", + "path": "/api/2.0/genie/spaces/{space_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieTrashSpaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space to be sent to the trash.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space to be sent to the trash.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space to be sent to the trash.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "The ID associated with the Genie space to be sent to the trash.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSpace", + "description": "Updates a Genie space with a serialized payload.", + "summary": "Update Genie Space.", + "path": "/api/2.0/genie/spaces/{space_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenieUpdateSpaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GenieSpace", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Title of the Genie Space", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "description", + "description": "Optional description", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "ETag returned by a previous GET or UPDATE. When set, the update will fail if the space\nhas been modified since. Omit to apply the update unconditionally.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_path", + "description": "Parent workspace folder path to move this Genie space under.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_space", + "description": "The contents of the Genie Space in serialized string form (full replacement).\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "title", + "description": "Optional title override", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Optional warehouse override", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "space_id", + "description": "Genie space ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "workspace.GitCredentials", + "name": "GitCredentials", + "description": "Registers personal access token for Databricks to do operations on behalf of the user.\n\nSee [more info](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).", + "package": { + "name": "workspace" + }, + "docs_group": "workspace", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "CredentialInfoGitProviderToCredentialIdMap" + }, + "request": { + "pascal_name": "ListCredentialsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a Git credential entry for the user.\nUse the PATCH endpoint to update existing credentials, or the DELETE endpoint to\ndelete existing credentials.", + "summary": "Create a credential entry.", + "path": "/api/2.0/git-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateCredentialsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateCredentialsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "credential_id", + "description": "ID of the credential object in the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "git_provider", + "description": "The Git provider associated with the credential.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "credential_id", + "description": "ID of the credential object in the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "git_provider", + "description": "The Git provider associated with the credential.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "git_email", + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_username", + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_default_for_provider", + "description": "if the credential is the default for the given provider", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "the name of the git credential, used for identification and ease of lookup", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "personal_access_token", + "description": "The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal_id", + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the specified Git credential.", + "summary": "Delete a credential.", + "path": "/api/2.0/git-credentials/{credential_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCredentialsRequest", + "is_object": true, + "required_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteCredentialsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the Git credential with the specified credential ID.", + "summary": "Get a credential entry.", + "path": "/api/2.0/git-credentials/{credential_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetCredentialsRequest", + "is_object": true, + "required_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "GetCredentialsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "credential_id", + "description": "ID of the credential object in the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "credential_id", + "description": "ID of the credential object in the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "List", + "description": "Lists the calling user's Git credentials.", + "summary": "Get Git credentials.", + "path": "/api/2.0/git-credentials", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListCredentialsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListCredentialsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "The ID of the service principal whose credentials will be listed. Only service principal managers can perform this action.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": {} + }, + { + "name": "Update", + "description": "Updates the specified Git credential.", + "summary": "Update a credential.", + "path": "/api/2.0/git-credentials/{credential_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateCredentialsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateCredentialsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "git_email", + "description": "The authenticating email associated with your Git provider user account.\nUsed for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\nRequired for most Git providers except AWS CodeCommit.\nLearn more at https://docs.databricks.com/aws/en/repos/get-access-tokens-from-git-provider", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "git_username", + "description": "The username provided with your Git provider account and associated with the\ncredential. For most Git providers it is only used to set the Git committer \u0026 author names for commits,\nhowever it may be required for authentication depending on your Git provider / token requirements.\nRequired for AWS CodeCommit.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_default_for_provider", + "description": "if the credential is the default for the given provider", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "the name of the git credential, used for identification and ease of lookup", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "personal_access_token", + "description": "The personal access token used to authenticate to the corresponding Git provider.\nFor certain providers, support may exist for other types of scoped access tokens.\n[Learn more](https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal_id", + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "credential_id", + "description": "The ID for the corresponding credential to access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "git_provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.GlobalInitScripts", + "name": "GlobalInitScripts", + "description": "The Global Init Scripts API enables Workspace administrators to configure global\ninitialization scripts for their workspace. These scripts run on every node in every cluster\nin the workspace.\n\n**Important:** Existing clusters must be restarted to pick up any changes made to global\ninit scripts.\nGlobal init scripts are run in order. If the init script returns with a bad exit code,\nthe Apache Spark container fails to launch and init scripts with later position are skipped.\nIf enough containers fail, the entire cluster fails with a `GLOBAL_INIT_SCRIPT_FAILURE`\nerror code.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "GlobalInitScriptDetailsNameToScriptIdMap" + }, + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListGlobalInitScriptsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new global init script in this workspace.", + "summary": "Create init script.", + "path": "/api/2.0/global-init-scripts", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GlobalInitScriptCreateRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "position", + "description": "The position of a global init script, where 0 represents the first script to run, 1 is the second script to run, in ascending order.\n\nIf you omit the numeric position for a new global init script, it defaults to last position. It will run after all current scripts.\nSetting any value greater than the position of the last script is equivalent to the last position. Example: Take three existing scripts with positions 0, 1, and 2. Any position of (3) or greater puts the script in the last position.\nIf an explicit position value conflicts with an existing script value, your request succeeds, but the original script at that position and all later scripts have their positions incremented by 1.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a global init script.", + "summary": "Delete init script.", + "path": "/api/2.0/global-init-scripts/{script_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteGlobalInitScriptRequest", + "is_object": true, + "required_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets all the details of a script, including its Base64-encoded contents.", + "summary": "Get an init script.", + "path": "/api/2.0/global-init-scripts/{script_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetGlobalInitScriptRequest", + "is_object": true, + "required_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GlobalInitScriptDetailsWithContent", + "is_object": true + }, + "all_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Get a list of all global init scripts for this workspace. This returns all properties for each script but **not** the script contents.\nTo retrieve the contents of a script, use the [get a global init script](:method:globalinitscripts/get) operation.", + "summary": "Get init scripts.", + "path": "/api/2.0/global-init-scripts", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListGlobalInitScriptsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListGlobalInitScriptsResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Update", + "description": "Updates a global init script, specifying only the fields to change. All fields are optional.\nUnspecified fields retain their current value.", + "summary": "Update init script.", + "path": "/api/2.0/global-init-scripts/{script_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GlobalInitScriptUpdateRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether the script is enabled. The script runs only if enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "position", + "description": "The position of a script, where 0 represents the first script to run,\n1 is the second script to run, in ascending order.\nTo move the script to run first, set its position to 0.\n\nTo move the script to the end, set its position to any value\ngreater or equal to the position of the last script.\nExample, three existing scripts with positions 0, 1, and 2.\nAny position value of 2 or greater puts the script in the last position (2).\n\nIf an explicit position value conflicts with an existing script, your request succeeds,\nbut the original script at that position and all later scripts have their positions\nincremented by 1.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "script_id", + "description": "The ID of the global init script.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the script", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "script", + "description": "The Base64-encoded content of the script.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.Grants", + "name": "Grants", + "description": "In Unity Catalog, data is secure by default. Initially, users have no access to data in\na metastore. Access can be granted by either a metastore admin, the owner of an object, or\nthe owner of the catalog or schema that contains the object. Securable objects in Unity\nCatalog are hierarchical and privileges are inherited downward.\n\nSecurable objects in Unity Catalog are hierarchical and privileges are inherited downward.\nThis means that granting a privilege on the catalog automatically grants the privilege to\nall current and future objects within the catalog. Similarly, privileges granted on a schema\nare inherited by all current and future objects within that schema.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Get", + "description": "Gets the permissions for a securable. Does not include inherited permissions.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "Get permissions.", + "path": "/api/2.1/unity-catalog/permissions/{securable_type}/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetGrantRequest", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Specifies the maximum number of privileges to return (page length).\nEvery PrivilegeAssignment present in a single page response is guaranteed to contain all the privileges granted on\nthe requested Securable for the respective principal.\n\nIf not set, all the permissions are returned.\nIf set to\n- lesser than 0: invalid parameter error\n- 0: page length is set to a server configured value\n- lesser than 150 but greater than 0: invalid parameter error (this is to ensure that server is able to return at\nleast one complete PrivilegeAssignment in a single page response)\n- greater than (or equal to) 150: page length is the minimum of this value and a server configured value", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "If provided, only the permissions for the specified principal (user or group) are returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetEffective", + "description": "Gets the effective permissions for a securable. Includes inherited permissions from any parent securables.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "Get effective permissions.", + "path": "/api/2.1/unity-catalog/effective-permissions/{securable_type}/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetEffectiveRequest", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EffectivePermissionsList", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Specifies the maximum number of privileges to return (page length).\nEvery EffectivePrivilegeAssignment present in a single page response is guaranteed to contain all the effective\nprivileges granted on (or inherited by) the requested Securable for the respective principal.\n\nIf not set, all the effective permissions are returned.\nIf set to\n- lesser than 0: invalid parameter error\n- 0: page length is set to a server configured value\n- lesser than 150 but greater than 0: invalid parameter error (this is to ensure that server is able to return at\nleast one complete EffectivePrivilegeAssignment in a single page response)\n- greater than (or equal to) 150: page length is the minimum of this value and a server configured value", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token for the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "If provided, only the effective permissions for the specified principal (user or group) are returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the permissions for a securable.", + "summary": "Update permissions.", + "path": "/api/2.1/unity-catalog/permissions/{securable_type}/{full_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdatePermissions", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdatePermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "changes", + "description": "Array of permissions change objects.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PermissionsChangeList", + "array_value": { + "pascal_name": "PermissionsChange", + "is_object": true + } + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "Type of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.GroupsV2", + "name": "GroupsV2", + "description": "Groups simplify identity management, making it easier to assign access to Databricks workspace, data,\nand other securable objects.\n\nIt is best practice to assign access to workspaces and access-control policies in\nUnity Catalog to groups, instead of to users individually. All Databricks workspace identities can be\nassigned as members of groups, and members inherit permissions that are assigned to their\ngroup.", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListGroupsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a group in the Databricks workspace with a unique name, using the supplied group details.", + "summary": "Create a new group.", + "path": "/api/2.0/preview/scim/v2/Groups", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateGroupRequest", + "is_object": true + }, + "response": { + "pascal_name": "Group", + "is_object": true + }, + "all_fields": [ + { + "name": "displayName", + "description": "String that represents a human-readable group name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks group ID", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "members", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "meta", + "description": "Container for the group identifier. Workspace local versus account.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ResourceMeta", + "is_object": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the group.", + "is_request_body_field": true, + "entity": { + "pascal_name": "GroupSchemaList", + "array_value": { + "pascal_name": "GroupSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:Group" + } + ] + } + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a group from the Databricks workspace.", + "summary": "Delete a group.", + "path": "/api/2.0/preview/scim/v2/Groups/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the information for a specific group in the Databricks workspace.", + "summary": "Get group details.", + "path": "/api/2.0/preview/scim/v2/Groups/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Group", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all details of the groups associated with the Databricks workspace.", + "summary": "List group details.", + "path": "/api/2.0/preview/scim/v2/Groups", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListGroupsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListGroupsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates the details of a group.", + "summary": "Update group details.", + "path": "/api/2.0/preview/scim/v2/Groups/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the details of a group by replacing the entire group entity.", + "summary": "Replace a group.", + "path": "/api/2.0/preview/scim/v2/Groups/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "displayName", + "description": "String that represents a human-readable group name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the group. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "members", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "meta", + "description": "Container for the group identifier. Workspace local versus account.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ResourceMeta", + "is_object": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the group.", + "is_request_body_field": true, + "entity": { + "pascal_name": "GroupSchemaList", + "array_value": { + "pascal_name": "GroupSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:Group" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.AccountGroupsV2", + "name": "AccountGroupsV2", + "description": "Groups simplify identity management, making it easier to assign access to Databricks account, data,\nand other securable objects.\n\nIt is best practice to assign access to workspaces and access-control policies in\nUnity Catalog to groups, instead of to users individually. All Databricks account identities can be\nassigned as members of groups, and members inherit permissions that are assigned to their\ngroup.", + "package": { + "name": "iam" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountGroupsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a group in the Databricks account with a unique name, using the supplied group details.", + "summary": "Create a new group.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAccountGroupRequest", + "is_object": true + }, + "response": { + "pascal_name": "AccountGroup", + "is_object": true + }, + "all_fields": [ + { + "name": "displayName", + "description": "String that represents a human-readable group name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks group ID", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "members", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "meta", + "description": "Container for the group identifier. Workspace local versus account.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ResourceMeta", + "is_object": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a group from the Databricks account.", + "summary": "Delete a group.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the information for a specific group in the Databricks account.", + "summary": "Get group details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountGroup", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a group in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all details of the groups associated with the Databricks account. As of 08/22/2025,\nthis endpoint will no longer return members. Instead, members should be retrieved by\niterating through `Get group details`. Existing accounts that rely on this attribute\nwill not be impacted and will continue receiving member data as before.", + "summary": "List group details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountGroupsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAccountGroupsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates the details of a group.", + "summary": "Update group details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PatchAccountGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the details of a group by replacing the entire group entity.", + "summary": "Replace a group.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Groups/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAccountGroupRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "displayName", + "description": "String that represents a human-readable group name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "members", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "meta", + "description": "Container for the group identifier. Workspace local versus account.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ResourceMeta", + "is_object": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks group ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iamv2.AccountIamV2", + "name": "AccountIamV2", + "description": "These APIs are used to manage identities and the workspace access of these identities in \u003cDatabricks\u003e.", + "package": { + "name": "iamv2" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "methods": [ + { + "name": "CreateWorkspaceAssignmentDetail", + "description": "Creates a workspace assignment detail for a principal. Entitlement grants are applied\nindividually and non-atomically — if a failure occurs partway through, the principal will be\nassigned to the workspace but with only a subset of the requested entitlements. Use\nGetWorkspaceAssignmentDetail to confirm which entitlements were successfully granted.", + "summary": "Create a workspace assignment detail.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAssignmentDetails", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateWorkspaceAssignmentDetailRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being created.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being created.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being created.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "account_id", + "description": "The account ID parent of the workspace where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_type", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrincipalType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being created.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "DeleteWorkspaceAssignmentDetail", + "description": "Deletes a workspace assignment detail for a principal, revoking all associated entitlements.\nEntitlement revocations are applied individually and non-atomically — if a failure occurs\npartway through, the principal remains assigned with a subset of its original entitlements,\nand the operation is safe to retry.", + "summary": "Delete a workspace assignment detail.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAssignmentDetails/{principal_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteWorkspaceAssignmentDetailRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID where the principal has access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID where the principal has access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal has access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID where the principal has access.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetWorkspaceAccessDetail", + "description": "Returns the access details for a principal in a workspace. Allows for checking access details for any\nprovisioned principal (user, service principal, or group) in a workspace.\n* Provisioned principal here refers to one that has been synced into Databricks from the customer's IdP or\nadded explicitly to Databricks via SCIM/UI.\nAllows for passing in a \"view\" parameter to control what fields are returned (BASIC by default or FULL).", + "summary": "Get workspace access details for a principal.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAccessDetails/{principal_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetWorkspaceAccessDetailRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceAccessDetail", + "is_object": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "view", + "description": "Controls what fields are returned.", + "is_query": true, + "entity": { + "pascal_name": "WorkspaceAccessDetailView", + "enum": [ + { + "content": "BASIC" + }, + { + "content": "FULL" + } + ] + } + }, + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetWorkspaceAssignmentDetail", + "description": "Returns the assignment details for a principal in a workspace.", + "summary": "Get workspace assignment details for a principal.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAssignmentDetails/{principal_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetWorkspaceAssignmentDetailRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ListWorkspaceAssignmentDetails", + "description": "Lists workspace assignment details for a workspace.", + "summary": "List workspace assignment details for a workspace.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAssignmentDetails", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListWorkspaceAssignmentDetailsRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment details are being fetched.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment details are being fetched.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "ListWorkspaceAssignmentDetailsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of workspace assignment details to return. The service may return fewer than this value.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous ListWorkspaceAssignmentDetails call. Provide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment details are being fetched.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment details are being fetched.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ResolveGroup", + "description": "Resolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external group in the Databricks account.", + "path": "/api/2.0/identity/accounts/{account_id}/groups/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveGroupRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveGroupResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ResolveServicePrincipal", + "description": "Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external service principal in the Databricks account.", + "path": "/api/2.0/identity/accounts/{account_id}/servicePrincipals/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveServicePrincipalRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveServicePrincipalResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ResolveUser", + "description": "Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external user in the Databricks account.", + "path": "/api/2.0/identity/accounts/{account_id}/users/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveUserRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveUserResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateWorkspaceAssignmentDetail", + "description": "Updates the entitlements of a directly assigned principal in a workspace. Entitlement changes\nare applied individually and non-atomically — if a failure occurs partway through, only a\nsubset of the requested changes may have been applied. Use GetWorkspaceAssignmentDetail to\nconfirm the final state.", + "summary": "Update a workspace assignment detail.", + "path": "/api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspaceAssignmentDetails/{principal_id}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateWorkspaceAssignmentDetailRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "account_id", + "description": "The account ID parent of the workspace where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_type", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrincipalType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Required. The workspace ID for which the workspace assignment detail is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "compute.InstancePools", + "name": "InstancePools", + "description": "Instance Pools API are used to create, edit, delete and list instance pools by using\nready-to-use cloud instances which reduces a cluster start and auto-scaling times.\n\nDatabricks pools reduce cluster start and auto-scaling times by maintaining a set of idle,\nready-to-use instances. When a cluster is attached to a pool, cluster nodes are created using\nthe pool’s idle instances. If the pool has no idle instances, the pool expands by allocating\na new instance from the instance provider in order to accommodate the cluster’s request.\nWhen a cluster releases an instance, it returns to the pool and is free for another cluster\nto use. Only clusters attached to a pool can use that pool’s idle instances.\n\nYou can specify a different pool for the driver node and worker nodes, or use the same pool\nfor both.\n\nDatabricks does not charge DBUs while instances are idle in the pool. Instance provider\nbilling does apply. See pricing.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "InstancePoolAndStatsInstancePoolNameToInstancePoolIdMap" + }, + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListInstancePoolsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new instance pool using idle and ready-to-use cloud instances.", + "summary": "Create a new instance pool.", + "path": "/api/2.0/instance-pools/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateInstancePool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateInstancePoolResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_attributes", + "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "InstancePoolAwsAttributes", + "is_object": true + } + }, + { + "name": "azure_attributes", + "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "InstancePoolAzureAttributes", + "is_object": true + } + }, + { + "name": "custom_tags", + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "disk_spec", + "description": "Defines the specification of the disks that will be attached to all spark containers.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DiskSpec", + "is_object": true + } + }, + { + "name": "enable_elastic_disk", + "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "gcp_attributes", + "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "InstancePoolGcpAttributes", + "is_object": true + } + }, + { + "name": "idle_instance_autotermination_minutes", + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_capacity", + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "min_idle_instances", + "description": "Minimum number of idle instances to keep in the instance pool", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "node_type_flexibility", + "description": "Flexible node type configuration for the pool.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NodeTypeFlexibility", + "is_object": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "preloaded_docker_images", + "description": "Custom Docker Image BYOC", + "is_request_body_field": true, + "entity": { + "pascal_name": "DockerImageList", + "array_value": { + "pascal_name": "DockerImage", + "is_object": true + } + } + }, + { + "name": "preloaded_spark_versions", + "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the :method:clusters/sparkVersions API call.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "remote_disk_throughput", + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "total_initial_remote_disk_size", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously.", + "summary": "Delete an instance pool.", + "path": "/api/2.0/instance-pools/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteInstancePool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteInstancePoolResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The instance pool to be terminated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Edit", + "description": "Modifies the configuration of an existing instance pool.", + "summary": "Edit an existing instance pool.", + "path": "/api/2.0/instance-pools/edit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EditInstancePool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "Instance pool ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_pool_id", + "description": "Instance pool ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditInstancePoolResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "custom_tags", + "description": "Additional tags for pool resources. Databricks will tag all pool resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "idle_instance_autotermination_minutes", + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "instance_pool_id", + "description": "Instance pool ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_capacity", + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "min_idle_instances", + "description": "Minimum number of idle instances to keep in the instance pool", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "remote_disk_throughput", + "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "total_initial_remote_disk_size", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "Instance pool ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_pool_name", + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "node_type_id", + "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieve the information for an instance pool based on its identifier.", + "summary": "Get instance pool information.", + "path": "/api/2.0/instance-pools/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetInstancePoolRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The canonical unique identifier for the instance pool.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_pool_id", + "description": "The canonical unique identifier for the instance pool.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetInstancePool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "Canonical unique identifier for the pool.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_pool_id", + "description": "Canonical unique identifier for the pool.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "instance_pool_id", + "description": "The canonical unique identifier for the instance pool.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The canonical unique identifier for the instance pool.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get instance pool permission levels.", + "path": "/api/2.0/permissions/instance-pools/{instance_pool_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetInstancePoolPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetInstancePoolPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of an instance pool. Instance pools can inherit permissions from their root object.", + "summary": "Get instance pool permissions.", + "path": "/api/2.0/permissions/instance-pools/{instance_pool_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetInstancePoolPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "InstancePoolPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of instance pools with their statistics.", + "summary": "List instance pool info.", + "path": "/api/2.0/instance-pools/list", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListInstancePoolsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListInstancePools", + "is_object": true + }, + "pagination": {} + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set instance pool permissions.", + "path": "/api/2.0/permissions/instance-pools/{instance_pool_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "InstancePoolPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "InstancePoolPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "InstancePoolAccessControlRequestList", + "array_value": { + "pascal_name": "InstancePoolAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on an instance pool. Instance pools can inherit permissions from their root object.", + "summary": "Update instance pool permissions.", + "path": "/api/2.0/permissions/instance-pools/{instance_pool_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "InstancePoolPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "InstancePoolPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "InstancePoolAccessControlRequestList", + "array_value": { + "pascal_name": "InstancePoolAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_pool_id", + "description": "The instance pool for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.InstanceProfiles", + "name": "InstanceProfiles", + "description": "The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch\nclusters with. Regular users can list the instance profiles available to them.\nSee [Secure access to S3 buckets](https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html) using\ninstance profiles for more information.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListInstanceProfilesRequest" + } + }, + "methods": [ + { + "name": "Add", + "description": "Registers an instance profile in Databricks. In the UI, you can then give users the permission\nto use this instance profile when launching clusters.\n\nThis API is only available to admin users.", + "summary": "Register an instance profile.", + "path": "/api/2.0/instance-profiles/add", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AddInstanceProfile", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AddResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "iam_role_arn", + "description": "The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_meta_instance_profile", + "description": "Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "By default, Databricks validates that it has sufficient permissions to launch\ninstances with the instance profile. This validation uses AWS dry-run mode for\nthe RunInstances API. If validation fails with an error message that does not\nindicate an IAM related permission issue,\n(e.g. “Your requested instance type is not supported in your requested availability zone”),\nyou can pass this flag to skip the validation and forcibly add the instance profile.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Edit", + "description": "The only supported field to change is the optional IAM role ARN associated with\nthe instance profile. It is required to specify the IAM role ARN if both of\nthe following are true:\n\n* Your role name and instance profile name do not match. The name is the part\nafter the last slash in each ARN.\n* You want to use the instance profile with [Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nTo understand where these fields are in the AWS console, see\n[Enable serverless SQL warehouses](https://docs.databricks.com/sql/admin/serverless.html).\n\nThis API is only available to admin users.", + "summary": "Edit an instance profile.", + "path": "/api/2.0/instance-profiles/edit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "InstanceProfile", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "iam_role_arn", + "description": "The AWS IAM role ARN of the role associated with the instance profile.\nThis field is required if your role name and instance profile name do\nnot match and you want to use the instance profile with\n[Databricks SQL Serverless](https://docs.databricks.com/sql/admin/serverless.html).\n\nOtherwise, this field is optional.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "is_meta_instance_profile", + "description": "Boolean flag indicating whether the instance profile should only be used in credential\npassthrough scenarios. If true, it means the instance profile contains an meta IAM role\nwhich could assume a wide range of roles. Therefore it should always be used with\nauthorization.\nThis field is optional, the default value is `false`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_profile_arn", + "description": "The AWS ARN of the instance profile to register with Databricks. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List the instance profiles that the calling user can use to launch a cluster.\n\nThis API is available to all users.", + "summary": "List available instance profiles.", + "path": "/api/2.0/instance-profiles/list", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListInstanceProfilesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListInstanceProfilesResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Remove", + "description": "Remove the instance profile with the provided ARN.\nExisting clusters with this instance profile will continue to function.\n\nThis API is only accessible to admin users.", + "summary": "Remove the instance profile.", + "path": "/api/2.0/instance-profiles/remove", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RemoveInstanceProfile", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "instance_profile_arn", + "description": "The ARN of the instance profile to remove. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "instance_profile_arn", + "description": "The ARN of the instance profile to remove. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RemoveResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "instance_profile_arn", + "description": "The ARN of the instance profile to remove. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "instance_profile_arn", + "description": "The ARN of the instance profile to remove. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.IpAccessLists", + "name": "IpAccessLists", + "description": "IP Access List enables admins to configure IP access lists.\n\nIP access lists affect web application access and REST API access to this workspace only.\nIf the feature is disabled for a workspace, all access is allowed for this workspace.\nThere is support for allow lists (inclusion) and block lists (exclusion).\n\nWhen a connection is attempted:\n1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected.\n2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.\n\nIf there is at least one allow list for the workspace, the connection is allowed only if the IP address matches an allow list.\nIf there are no allow lists for the workspace, all IP addresses are allowed.\n\nFor all allow lists and block lists combined, the workspace supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.\n\nAfter changes to the IP access list feature, it can take a few minutes for changes to take effect.", + "package": { + "name": "settings" + }, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "IpAccessListInfoLabelToListIdMap" + }, + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListIpAccessLists" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates an IP access list for this workspace.\n\nA list can be an allow list or a block list.\nSee the top of this file for a description of how the server treats allow lists and block lists at runtime.\n\nWhen creating or updating an IP access list:\n\n* For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,\nwhere one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.\n* If the new list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.\n\nIt can take a few minutes for the changes to take effect. **Note**: Your new IP access list has no effect until you enable the feature. See :method:workspaceconf/setStatus", + "summary": "Create access list.", + "path": "/api/2.0/ip-access-lists", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateIpAccessList", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "CreateIpAccessListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes an IP access list, specified by its list ID.", + "summary": "Delete access list.", + "path": "/api/2.0/ip-access-lists/{ip_access_list_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteIpAccessListRequest", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets an IP access list, specified by its list ID.", + "summary": "Get access list.", + "path": "/api/2.0/ip-access-lists/{ip_access_list_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetIpAccessListRequest", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FetchIpAccessListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all IP access lists for the specified workspace.", + "summary": "Get access lists.", + "path": "/api/2.0/ip-access-lists", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListIpAccessLists", + "is_object": true + }, + "response": { + "pascal_name": "ListIpAccessListResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Replace", + "description": "Replaces an IP access list, specified by its ID.\n\nA list can include allow lists and block lists. See the top\nof this file for a description of how the server treats allow lists and block lists at run time. When\nreplacing an IP access list:\n* For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,\nwhere one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`\nvalue `QUOTA_EXCEEDED`.\n* If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`\nvalue `INVALID_STATE`.\nIt can take a few minutes for the changes to take effect. Note that your resulting IP access list has no\neffect until you enable the feature. See :method:workspaceconf/setStatus.", + "summary": "Replace access list.", + "path": "/api/2.0/ip-access-lists/{ip_access_list_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ReplaceIpAccessList", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates an existing IP access list, specified by its ID.\n\nA list can include allow lists and block lists.\nSee the top of this file for a description of how the server treats allow lists and block lists at run time.\n\nWhen updating an IP access list:\n\n* For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,\nwhere one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.\n* If the updated list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.\n\nIt can take a few minutes for the changes to take effect. Note that your resulting IP access list has no effect until you enable\nthe feature. See :method:workspaceconf/setStatus.", + "summary": "Update access list.", + "path": "/api/2.0/ip-access-lists/{ip_access_list_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateIpAccessList", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.AccountIpAccessLists", + "name": "AccountIpAccessLists", + "description": "The Accounts IP Access List API enables account admins to configure IP access lists for\naccess to the account console.\n\nAccount IP Access Lists affect web application access and REST API access to the account\nconsole and account APIs. If the feature is disabled for the account, all access is allowed\nfor this account. There is support for allow lists (inclusion) and block lists (exclusion).\n\nWhen a connection is attempted:\n1. **First, all block lists are checked.** If the connection IP address matches any block\nlist, the connection is rejected.\n2. **If the connection was not rejected by block lists**, the IP address is compared with\nthe allow lists.\n\nIf there is at least one allow list for the account, the connection is allowed only if the\nIP address matches an allow list. If there are no allow lists for the account, all IP\naddresses are allowed.\n\nFor all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR\nvalues, where one CIDR counts as a single value.\n\nAfter changes to the account-level IP access lists, it can take a few minutes for changes\nto take effect.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "IpAccessListInfoLabelToListIdMap" + }, + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListIpAccessLists" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates an IP access list for the account.\n\nA list can be an allow list or a block list. See the top of this file for a description of\nhow the server treats allow lists and block lists at runtime.\n\nWhen creating or updating an IP access list:\n\n* For all allow lists and block lists combined, the API supports a maximum of 1000\nIP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number\nreturn error 400 with `error_code` value `QUOTA_EXCEEDED`.\n* If the new list would block the calling user's current IP, error 400 is returned with\n`error_code` value `INVALID_STATE`.\n\nIt can take a few minutes for the changes to take effect.", + "summary": "Create access list.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateIpAccessList", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "CreateIpAccessListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes an IP access list, specified by its list ID.", + "summary": "Delete access list.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountIpAccessListRequest", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets an IP access list, specified by its list ID.", + "summary": "Get IP access list.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountIpAccessListRequest", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetIpAccessListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all IP access lists for the specified account.", + "summary": "Get access lists.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListIpAccessLists", + "is_object": true + }, + "response": { + "pascal_name": "GetIpAccessListsResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Replace", + "description": "Replaces an IP access list, specified by its ID.\n\nA list can include allow lists and block lists. See the top of this file for a description\nof how the server treats allow lists and block lists at run time. When replacing an IP\naccess list:\n* For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,\nwhere one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`\nvalue `QUOTA_EXCEEDED`.\n* If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`\nvalue `INVALID_STATE`.\nIt can take a few minutes for the changes to take effect.", + "summary": "Replace access list.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ReplaceIpAccessList", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + }, + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates an existing IP access list, specified by its ID.\n\nA list can include allow lists and block lists. See the top of this file for a description\nof how the server treats allow lists and block lists at run time.\n\nWhen updating an IP access list:\n\n* For all allow lists and block lists combined, the API supports a maximum of 1000\nIP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number\nreturn error 400 with `error_code` value `QUOTA_EXCEEDED`.\n* If the updated list would block the calling user's current IP, error 400 is returned\nwith `error_code` value `INVALID_STATE`.\n\nIt can take a few minutes for the changes to take effect.", + "summary": "Update access list.", + "path": "/api/2.0/accounts/{account_id}/ip-access-lists/{ip_access_list_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateIpAccessList", + "is_object": true, + "required_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "enabled", + "description": "Specifies whether this IP access list is enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_addresses", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "label", + "description": "Label for the IP access list. This **cannot** be empty.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "list_type", + "is_request_body_field": true, + "entity": { + "pascal_name": "ListType", + "enum": [ + { + "content": "ALLOW" + }, + { + "content": "BLOCK" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "ip_access_list_id", + "description": "The ID for the corresponding IP access list", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "jobs.Jobs", + "name": "Jobs", + "description": "The Jobs API allows you to create, edit, and delete jobs.\n\nYou can use a Databricks job to run a data processing or data analysis task in a Databricks\ncluster with scalable resources. Your job can consist of a single task or can be a large,\nmulti-task workflow with complex dependencies. Databricks manages the task orchestration,\ncluster management, monitoring, and error reporting for all of your jobs. You can run your jobs\nimmediately or periodically through an easy-to-use scheduling system. You can implement\njob tasks using notebooks, JARS, Spark Declarative Pipelines, or Python, Scala, Spark\nsubmit, and Java applications.\n\nYou should never hard code secrets or store them in plain text. Use the [Secrets CLI](https://docs.databricks.com/dev-tools/cli/secrets-cli.html)\nto manage secrets in the [Databricks CLI](https://docs.databricks.com/dev-tools/cli/index.html).\nUse the [Secrets utility](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-secrets) to reference secrets in notebooks and jobs.", + "package": { + "name": "jobs" + }, + "docs_group": "lakeflow", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "BaseJobSettingsNameToJobIdMap" + }, + "request": { + "pascal_name": "ListJobsRequest" + } + }, + "methods": [ + { + "name": "CancelAllRuns", + "description": "Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't\nprevent new runs from being started.", + "summary": "Cancel all runs of a job.", + "path": "/api/2.2/jobs/runs/cancel-all", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CancelAllRuns", + "is_object": true + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "all_queued_runs", + "description": "Optional boolean parameter to cancel all queued runs. If no job_id is provided, all queued runs in the workspace are canceled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "job_id", + "description": "The canonical identifier of the job to cancel all runs of.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "CancelRun", + "description": "Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when\nthis request completes.", + "summary": "Cancel a run.", + "path": "/api/2.2/jobs/runs/cancel", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CancelRun", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "TERMINATED" + }, + { + "content": "SKIPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "Run" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "LifeCycleState" + } + ], + "message_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "State" + } + } + }, + { + "name": "Create", + "description": "Create a new job.", + "summary": "Create a new job.", + "path": "/api/2.2/jobs/create", + "can_use_json": true, + "must_use_json": true, + "is_json_only": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateJob", + "is_object": true + }, + "response": { + "pascal_name": "CreateResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "description": "List of permissions to set on the job.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobAccessControlRequestList", + "array_value": { + "pascal_name": "JobAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Continuous", + "is_object": true + } + }, + { + "name": "deployment", + "description": "Deployment information for jobs managed by external sources.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobDeployment", + "is_object": true + } + }, + { + "name": "description", + "description": "An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "edit_mode", + "description": "Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobEditMode", + "enum": [ + { + "content": "EDITABLE" + }, + { + "content": "UI_LOCKED" + } + ] + } + }, + { + "name": "email_notifications", + "description": "An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobEmailNotifications", + "is_object": true + } + }, + { + "name": "environments", + "description": "A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nFor serverless notebook tasks, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the notebook environment.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobEnvironmentList", + "array_value": { + "pascal_name": "JobEnvironment", + "is_object": true + } + } + }, + { + "name": "format", + "description": "Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls. When using the Jobs API 2.1 this value is always set to `\"MULTI_TASK\"`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "Format", + "enum": [ + { + "content": "MULTI_TASK" + }, + { + "content": "SINGLE_TASK" + } + ] + } + }, + { + "name": "git_source", + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GitSource", + "is_object": true + } + }, + { + "name": "health", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobsHealthRules", + "is_object": true + } + }, + { + "name": "job_clusters", + "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobClusterList", + "array_value": { + "pascal_name": "JobCluster", + "is_object": true + } + } + }, + { + "name": "max_concurrent_runs", + "description": "An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job’s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notification_settings", + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobNotificationSettings", + "is_object": true + } + }, + { + "name": "parameters", + "description": "Job-level parameter definitions", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobParameterDefinitionList", + "array_value": { + "pascal_name": "JobParameterDefinition", + "is_object": true + } + } + }, + { + "name": "performance_target", + "description": "The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run.\nThe performance target does not apply to tasks that run on Serverless GPU compute.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PerformanceTarget", + "enum": [ + { + "content": "PERFORMANCE_OPTIMIZED" + }, + { + "content": "STANDARD" + } + ] + } + }, + { + "name": "queue", + "description": "The queue settings of the job.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "QueueSettings", + "is_object": true + } + }, + { + "name": "run_as", + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobRunAs", + "is_object": true + } + }, + { + "name": "schedule", + "description": "An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "tags", + "description": "A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "tasks", + "description": "A list of task specifications to be executed by this job.\nIt supports up to 1000 elements in write endpoints (:method:jobs/create, :method:jobs/reset, :method:jobs/update, :method:jobs/submit).\nRead endpoints return only 100 tasks. If more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.", + "is_request_body_field": true, + "entity": { + "pascal_name": "TaskList", + "array_value": { + "pascal_name": "Task", + "is_object": true + } + } + }, + { + "name": "timeout_seconds", + "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "trigger", + "description": "A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TriggerSettings", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "webhook_notifications", + "description": "A collection of system notification IDs to notify when runs of this job begin or complete.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "WebhookNotifications", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a job.", + "summary": "Delete a job.", + "path": "/api/2.2/jobs/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteJob", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to delete. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to delete. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to delete. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to delete. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "DeleteRun", + "description": "Deletes a non-active run. Returns an error if the run is active.", + "summary": "Delete a job run.", + "path": "/api/2.2/jobs/runs/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRun", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "ID of the run to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ExportRun", + "description": "Export and retrieve the job run task.", + "summary": "Export and retrieve a job run.", + "path": "/api/2.2/jobs/runs/export", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExportRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "ExportRunOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "views_to_export", + "description": "Which views to export (CODE, DASHBOARDS, or ALL). Defaults to CODE.", + "is_query": true, + "entity": { + "pascal_name": "ViewsToExport", + "enum": [ + { + "content": "ALL" + }, + { + "content": "CODE" + }, + { + "content": "DASHBOARDS" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "The canonical identifier for the run. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves the details for a single job.\n\nLarge arrays in the results will be paginated when they exceed 100 elements.\nA request for a single job will return all properties for that job, and the first 100 elements of array properties (`tasks`, `job_clusters`, `environments` and `parameters`).\nUse the `next_page_token` field to check for more results and pass its value as the `page_token` in subsequent requests.\nIf any array properties have more than 100 elements, additional results will be returned on subsequent requests. Arrays without additional results will be empty on later pages.", + "summary": "Get a single job.", + "path": "/api/2.2/jobs/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetJobRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to retrieve information about. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to retrieve information about. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "Job", + "is_object": true + }, + "all_fields": [ + { + "name": "include_trigger_state", + "description": "Flag that indicates that trigger state should be included in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "job_id", + "description": "The canonical identifier of the job to retrieve information about. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "description": "Use `next_page_token` returned from the previous GetJob response to request the next page of the job's array properties.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to retrieve information about. This field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get job permission levels.", + "path": "/api/2.0/permissions/jobs/{job_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetJobPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetJobPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a job. Jobs can inherit permissions from their root object.", + "summary": "Get job permissions.", + "path": "/api/2.0/permissions/jobs/{job_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetJobPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "JobPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRun", + "description": "Retrieves the metadata of a run.\n\nLarge arrays in the results will be paginated when they exceed 100 elements.\nA request for a single run will return all properties for that run, and the first 100 elements of array properties (`tasks`, `job_clusters`, `job_parameters` and `repair_history`).\nUse the next_page_token field to check for more results and pass its value as the page_token in subsequent requests.\nIf any array properties have more than 100 elements, additional results will be returned on subsequent requests. Arrays without additional results will be empty on later pages.", + "summary": "Get a single job run.", + "path": "/api/2.2/jobs/runs/get", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRunRequest", + "is_object": true, + "required_fields": [ + { + "name": "run_id", + "description": "The canonical identifier of the run for which to retrieve the metadata.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "run_id", + "description": "The canonical identifier of the run for which to retrieve the metadata.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "Run", + "is_object": true + }, + "all_fields": [ + { + "name": "include_history", + "description": "Whether to include the repair history in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_resolved_values", + "description": "Whether to include resolved parameter values in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_token", + "description": "Use `next_page_token` returned from the previous GetRun response to request the next page of the run's array properties.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "The canonical identifier of the run for which to retrieve the metadata.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "The canonical identifier of the run for which to retrieve the metadata.\nThis field is required.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetRunOutput", + "description": "Retrieve the output and metadata of a single task run. When a notebook task returns\na value through the `dbutils.notebook.exit()` call, you can use this endpoint to retrieve\nthat value. Databricks restricts this API to returning the first 5 MB of the output.\nTo return a larger result, you can store job results in a cloud storage service.\n\nThis endpoint validates that the __run_id__ parameter is valid and returns an HTTP status\ncode 400 if the __run_id__ parameter is invalid. Runs are automatically removed after\n60 days. If you to want to reference them beyond 60 days, you must save old run results\nbefore they expire.", + "summary": "Get the output for a single run.", + "path": "/api/2.2/jobs/runs/get-output", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRunOutputRequest", + "is_object": true, + "required_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "RunOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "run_id", + "description": "The canonical identifier for the run.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "The canonical identifier for the run.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "List", + "description": "Retrieves a list of jobs.", + "summary": "List jobs.", + "path": "/api/2.2/jobs/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListJobsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListJobsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "expand_tasks", + "description": "Whether to include task and cluster details in the response. Note that only the first 100 elements will be shown.\nUse :method:jobs/get to paginate through all tasks and clusters.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "limit", + "description": "The number of jobs to return. This value must be greater than 0 and less or equal to 100. The default value is 20.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "A filter on the list based on the exact (case insensitive) job name.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "offset", + "description": "The offset of the first job to return, relative to the most recently created job.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of jobs respectively.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of jobs respectively.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListRuns", + "description": "List runs in descending order by start time.", + "summary": "List job runs.", + "path": "/api/2.2/jobs/runs/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListRunsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListRunsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "active_only", + "description": "If active_only is `true`, only active runs are included in the results; otherwise,\nlists both active and completed runs. An active run is a run in the `QUEUED`, `PENDING`,\n`RUNNING`, or `TERMINATING`. This field cannot be `true` when completed_only is `true`.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "completed_only", + "description": "If completed_only is `true`, only completed runs are included in the results;\notherwise, lists both active and completed runs. This field cannot be `true` when\nactive_only is `true`.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "expand_tasks", + "description": "Whether to include task and cluster details in the response. Note that only the first 100 elements will be shown.\nUse :method:jobs/getrun to paginate through all tasks and clusters.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "job_id", + "description": "The job for which to list runs. If omitted, the Jobs service lists runs from all jobs.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "limit", + "description": "The number of runs to return. This value must be greater than 0 and less than 25.\nThe default value is 20. If a request specifies a limit of 0, the service instead\nuses the maximum limit.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "offset", + "description": "The offset of the first run to return, relative to the most recent run.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of runs respectively.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_type", + "description": "The type of runs to return. For a description of run types, see :method:jobs/getRun.", + "is_query": true, + "entity": { + "pascal_name": "RunType", + "enum": [ + { + "content": "JOB_RUN" + }, + { + "content": "SUBMIT_RUN" + }, + { + "content": "WORKFLOW_RUN" + } + ] + } + }, + { + "name": "start_time_from", + "description": "Show runs that started _at or after_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_to_ to filter by a time range.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "start_time_to", + "description": "Show runs that started _at or before_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_from_ to filter by a time range.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of runs respectively.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "RepairRun", + "description": "Re-run one or more tasks. Tasks are re-run as part of the original job run.\nThey use the current job and task settings, and can be viewed in the history for the\noriginal job run.", + "summary": "Repair a job run.", + "path": "/api/2.2/jobs/runs/repair", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RepairRun", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "run_id", + "description": "The job run ID of the run to repair. The run must not be in progress.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "run_id", + "description": "The job run ID of the run to repair. The run must not be in progress.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "RepairRunResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "job_parameters", + "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "latest_repair_id", + "description": "The ID of the latest repair. This parameter is not required when repairing a run for the first time, but must be provided on subsequent requests to repair the same run.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "performance_target", + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PerformanceTarget", + "enum": [ + { + "content": "PERFORMANCE_OPTIMIZED" + }, + { + "content": "STANDARD" + } + ] + } + }, + { + "name": "pipeline_params", + "description": "Controls whether the pipeline should perform a full refresh", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineParams", + "is_object": true + } + }, + { + "name": "python_named_params", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "rerun_all_failed_tasks", + "description": "If true, repair all failed tasks. Only one of `rerun_tasks` or `rerun_all_failed_tasks` can be used.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "rerun_dependent_tasks", + "description": "If true, repair all tasks that depend on the tasks in `rerun_tasks`, even if they were previously successful. Can be also used in combination with `rerun_all_failed_tasks`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "rerun_tasks", + "description": "The task keys of the task runs to repair.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "run_id", + "description": "The job run ID of the run to repair. The run must not be in progress.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "run_id", + "description": "The job run ID of the run to repair. The run must not be in progress.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "TERMINATED" + }, + { + "content": "SKIPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "Run" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "LifeCycleState" + } + ], + "message_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "State" + } + } + }, + { + "name": "Reset", + "description": "Overwrite all settings for the given job. Use the [_Update_ endpoint](:method:jobs/update) to update job settings partially.", + "summary": "Update all job settings (reset).", + "path": "/api/2.2/jobs/reset", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ResetJob", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to reset. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "new_settings", + "description": "The new settings of the job. These settings completely replace the old settings.\n\nChanges to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "JobSettings", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to reset. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "new_settings", + "description": "The new settings of the job. These settings completely replace the old settings.\n\nChanges to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "JobSettings", + "is_object": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to reset. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "new_settings", + "description": "The new settings of the job. These settings completely replace the old settings.\n\nChanges to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "JobSettings", + "is_object": true + } + } + ] + }, + { + "name": "RunNow", + "description": "Run a job and return the `run_id` of the triggered run.", + "summary": "Trigger a new job run.", + "path": "/api/2.2/jobs/run-now", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RunNow", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "job_id", + "description": "The ID of the job to be executed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "job_id", + "description": "The ID of the job to be executed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "RunNowResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "idempotency_token", + "description": "An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run\nis launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "job_id", + "description": "The ID of the job to be executed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "job_parameters", + "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "only", + "description": "A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "performance_target", + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PerformanceTarget", + "enum": [ + { + "content": "PERFORMANCE_OPTIMIZED" + }, + { + "content": "STANDARD" + } + ] + } + }, + { + "name": "pipeline_params", + "description": "Controls whether the pipeline should perform a full refresh", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineParams", + "is_object": true + } + }, + { + "name": "python_named_params", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "queue", + "description": "The queue settings of the run.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "QueueSettings", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The ID of the job to be executed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "TERMINATED" + }, + { + "content": "SKIPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "Run" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "LifeCycleState" + } + ], + "message_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "State" + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set job permissions.", + "path": "/api/2.0/permissions/jobs/{job_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "JobPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "JobPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobAccessControlRequestList", + "array_value": { + "pascal_name": "JobAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Submit", + "description": "Submit a one-time run. This endpoint allows you to submit a workload directly\nwithout creating a job. Runs submitted using this endpoint don’t display in\nthe UI. Use the `jobs/runs/get` API to check the run state after the job is\nsubmitted.\n\n**Important:** Jobs submitted using this endpoint are not saved as a job.\nThey do not show up in the Jobs UI, and do not retry when they fail. Because\nthey are not saved, Databricks cannot auto-optimize serverless compute in case\nof failure. If your job fails, you may want to use classic compute to specify\nthe compute needs for the job. Alternatively, use the `POST /jobs/create` and\n`POST /jobs/run-now` endpoints to create and run a saved job.", + "summary": "Create and trigger a one-time run.", + "path": "/api/2.2/jobs/runs/submit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SubmitRun", + "is_object": true + }, + "response": { + "pascal_name": "SubmitRunResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "description": "List of permissions to set on the job.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobAccessControlRequestList", + "array_value": { + "pascal_name": "JobAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "budget_policy_id", + "description": "The user specified id of the budget policy to use for this one-time run.\nIf not specified, the run will be not be attributed to any budget policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "email_notifications", + "description": "An optional set of email addresses notified when the run begins or completes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobEmailNotifications", + "is_object": true + } + }, + { + "name": "environments", + "description": "A list of task execution environment specifications that can be referenced by tasks of this run.", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobEnvironmentList", + "array_value": { + "pascal_name": "JobEnvironment", + "is_object": true + } + } + }, + { + "name": "git_source", + "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GitSource", + "is_object": true + } + }, + { + "name": "health", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobsHealthRules", + "is_object": true + } + }, + { + "name": "idempotency_token", + "description": "An optional token that can be used to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly\none run is launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notification_settings", + "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this run.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobNotificationSettings", + "is_object": true + } + }, + { + "name": "queue", + "description": "The queue settings of the one-time run.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "QueueSettings", + "is_object": true + } + }, + { + "name": "run_as", + "description": "Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who submits the request.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobRunAs", + "is_object": true + } + }, + { + "name": "run_name", + "description": "An optional name for the run. The default value is `Untitled`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tasks", + "is_request_body_field": true, + "entity": { + "pascal_name": "SubmitTaskList", + "array_value": { + "pascal_name": "SubmitTask", + "is_object": true + } + } + }, + { + "name": "timeout_seconds", + "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "usage_policy_id", + "description": "The user specified id of the usage policy to use for this one-time run.\nIf not specified, a default usage policy may be applied when creating or modifying the job.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "webhook_notifications", + "description": "A collection of system notification IDs to notify when the run begins or completes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "WebhookNotifications", + "is_object": true + } + } + ], + "wait": { + "success": [ + { + "content": "TERMINATED" + }, + { + "content": "SKIPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "Run" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "LifeCycleState" + } + ], + "message_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "StateMessage" + } + ], + "message_path_head": { + "pascal_name": "State" + } + } + }, + { + "name": "Update", + "description": "Add, update, or remove specific settings of an existing job. Use the [_Reset_ endpoint](:method:jobs/reset) to overwrite all job settings.", + "summary": "Update job settings partially.", + "path": "/api/2.2/jobs/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateJob", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to update. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to update. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "fields_to_remove", + "description": "Remove top-level fields in the job settings. Removing nested fields is not supported, except for tasks and job clusters (`tasks/task_1`). This field is optional.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "job_id", + "description": "The canonical identifier of the job to update. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "new_settings", + "description": "The new settings for the job.\n\nTop-level fields specified in `new_settings` are completely replaced, except for arrays which are merged. That is, new and existing entries are completely replaced based on the respective key fields, i.e. `task_key` or `job_cluster_key`, while previous entries are kept.\n\nPartially updating nested fields is not supported.\n\nChanges to the field `JobSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobSettings", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The canonical identifier of the job to update. This field is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a job. Jobs can inherit permissions from their root object.", + "summary": "Update job permissions.", + "path": "/api/2.0/permissions/jobs/{job_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "JobPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "JobPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "JobAccessControlRequestList", + "array_value": { + "pascal_name": "JobAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The job for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "knowledgeassistants.KnowledgeAssistants", + "name": "KnowledgeAssistants", + "description": "Manage Knowledge Assistants and related resources.", + "package": { + "name": "knowledgeassistants" + }, + "docs_group": "agentbricks", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListExamplesRequest" + } + }, + "methods": [ + { + "name": "CreateExample", + "description": "Creates an example for a Knowledge Assistant.", + "summary": "Create an example for a Knowledge Assistant.", + "path": "/api/2.1/{parent=knowledge-assistants/*}/examples", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateExampleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "example", + "description": "The example to create under the parent Knowledge Assistant.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "example", + "description": "The example to create under the parent Knowledge Assistant.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "example", + "description": "The example to create under the parent Knowledge Assistant.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "example", + "description": "The example to create under the parent Knowledge Assistant.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Timestamp when this example was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "example_id", + "description": "The universally unique identifier (UUID) of the example.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question. Optional — examples may be created\nwith just a question; the front-end form does not require guidelines.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "name", + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Timestamp when this example was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateKnowledgeAssistant", + "description": "Creates a Knowledge Assistant.", + "summary": "Create a Knowledge Assistant.", + "path": "/api/2.1/knowledge-assistants", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateKnowledgeAssistantRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "Creation timestamp.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The creator of the Knowledge Assistant.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "The name of the knowledge assistant agent endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "error_info", + "description": "Error details when the Knowledge Assistant is in FAILED state.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "experiment_id", + "description": "The MLflow experiment ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Deprecated: use knowledge_assistant_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in update_mask to\nmodify it.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "description": "State of the Knowledge Assistant. Not returned in List responses.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistantState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "CREATING" + }, + { + "content": "FAILED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateKnowledgeSource", + "description": "Creates a Knowledge Source under a Knowledge Assistant.", + "summary": "Create a Knowledge Source.", + "path": "/api/2.1/{parent=knowledge-assistants/*}/knowledge-sources", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateKnowledgeSourceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "knowledge_source", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "knowledge_source", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "knowledge_source", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "knowledge_source", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "parent", + "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Timestamp when this knowledge source was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "file_table", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileTableSpec", + "is_object": true + } + }, + { + "name": "files", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FilesSpec", + "is_object": true + } + }, + { + "name": "id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IndexSpec", + "is_object": true + } + }, + { + "name": "knowledge_cutoff_time", + "description": "Timestamp representing the cutoff before which content in this knowledge source is being ingested.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSourceState", + "enum": [ + { + "content": "FAILED_UPDATE" + }, + { + "content": "UPDATED" + }, + { + "content": "UPDATING" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteExample", + "description": "Deletes an example from a Knowledge Assistant.", + "summary": "Delete an example from a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*/examples/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteExampleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteKnowledgeAssistant", + "description": "Deletes a Knowledge Assistant.", + "summary": "Delete a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteKnowledgeAssistantRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant to be deleted.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant to be deleted.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant to be deleted.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant to be deleted.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteKnowledgeSource", + "description": "Deletes a Knowledge Source.", + "summary": "Delete a Knowledge Source.", + "path": "/api/2.1/{name=knowledge-assistants/*/knowledge-sources/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteKnowledgeSourceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to delete.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetExample", + "description": "Gets an example from a Knowledge Assistant.", + "summary": "Get an example from a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*/examples/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetExampleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetKnowledgeAssistant", + "description": "Gets a Knowledge Assistant.", + "summary": "Get a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetKnowledgeAssistantRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the knowledge assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetKnowledgeSource", + "description": "Gets a Knowledge Source.", + "summary": "Get a Knowledge Source.", + "path": "/api/2.1/{name=knowledge-assistants/*/knowledge-sources/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetKnowledgeSourceRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get knowledge assistant permission levels.", + "path": "/api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetKnowledgeAssistantPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetKnowledgeAssistantPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a knowledge assistant. Knowledge assistants can inherit permissions from their root object.", + "summary": "Get knowledge assistant permissions.", + "path": "/api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetKnowledgeAssistantPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KnowledgeAssistantPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListExamples", + "description": "Lists examples under a Knowledge Assistant.", + "summary": "List examples for a Knowledge Assistant.", + "path": "/api/2.1/{parent=knowledge-assistants/*}/examples", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListExamplesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListExamplesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of examples to return.\nIf unspecified, at most 100 examples will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListKnowledgeAssistants", + "description": "List Knowledge Assistants", + "summary": "List Knowledge Assistants.", + "path": "/api/2.1/knowledge-assistants", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListKnowledgeAssistantsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListKnowledgeAssistantsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of knowledge assistants to return.\nIf unspecified, at most 100 knowledge assistants will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListKnowledgeAssistants` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListKnowledgeAssistants` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListKnowledgeSources", + "description": "Lists Knowledge Sources under a Knowledge Assistant.", + "summary": "List Knowledge Sources.", + "path": "/api/2.1/{parent=knowledge-assistants/*}/knowledge-sources", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListKnowledgeSourcesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListKnowledgeSourcesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set knowledge assistant permissions.", + "path": "/api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "KnowledgeAssistantPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KnowledgeAssistantPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistantAccessControlRequestList", + "array_value": { + "pascal_name": "KnowledgeAssistantAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SyncKnowledgeSources", + "description": "Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources do not require sync)", + "summary": "Syncs all Knowledge Sources for a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*}/knowledge-sources:sync", + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "SyncKnowledgeSourcesRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateExample", + "description": "Updates an example in a Knowledge Assistant.", + "summary": "Update an example in a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*/examples/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateExampleRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Timestamp when this example was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "example_id", + "description": "The universally unique identifier (UUID) of the example.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question. Optional — examples may be created\nwith just a question; the front-end form does not require guidelines.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "name", + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Timestamp when this example was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateKnowledgeAssistant", + "description": "Updates a Knowledge Assistant.", + "summary": "Update a Knowledge Assistant.", + "path": "/api/2.1/{name=knowledge-assistants/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateKnowledgeAssistantRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Assistant fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Assistant.\nAllowed values: `display_name`, `description`, `instructions`.\nExamples:\n- `display_name`\n- `description,instructions`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Assistant.\nAllowed values: `display_name`, `description`, `instructions`.\nExamples:\n- `display_name`\n- `description,instructions`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Assistant fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Assistant fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "knowledge_assistant", + "description": "The Knowledge Assistant update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Assistant fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Assistant.\nAllowed values: `display_name`, `description`, `instructions`.\nExamples:\n- `display_name`\n- `description,instructions`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Creation timestamp.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The creator of the Knowledge Assistant.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "The name of the knowledge assistant agent endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "error_info", + "description": "Error details when the Knowledge Assistant is in FAILED state.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "experiment_id", + "description": "The MLflow experiment ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Deprecated: use knowledge_assistant_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in update_mask to\nmodify it.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "description": "State of the Knowledge Assistant. Not returned in List responses.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistantState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "CREATING" + }, + { + "content": "FAILED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Assistant.\nAllowed values: `display_name`, `description`, `instructions`.\nExamples:\n- `display_name`\n- `description,instructions`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "display_name", + "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateKnowledgeSource", + "description": "Updates a Knowledge Source.", + "summary": "Update a Knowledge Source.", + "path": "/api/2.1/{name=knowledge-assistants/*/knowledge-sources/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateKnowledgeSourceRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "knowledge_source", + "description": "The Knowledge Source update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Source fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Source.\nAllowed values: `display_name`, `description`.\nExamples:\n- `display_name`\n- `display_name,description`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Source.\nAllowed values: `display_name`, `description`.\nExamples:\n- `display_name`\n- `display_name,description`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "knowledge_source", + "description": "The Knowledge Source update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Source fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "knowledge_source", + "description": "The Knowledge Source update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Source fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "knowledge_source", + "description": "The Knowledge Source update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Source fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSource", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The resource name of the Knowledge Source to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Source.\nAllowed values: `display_name`, `description`.\nExamples:\n- `display_name`\n- `display_name,description`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Timestamp when this knowledge source was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "file_table", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FileTableSpec", + "is_object": true + } + }, + { + "name": "files", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FilesSpec", + "is_object": true + } + }, + { + "name": "id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IndexSpec", + "is_object": true + } + }, + { + "name": "knowledge_cutoff_time", + "description": "Timestamp representing the cutoff before which content in this knowledge source is being ingested.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeSourceState", + "enum": [ + { + "content": "FAILED_UPDATE" + }, + { + "content": "UPDATED" + }, + { + "content": "UPDATING" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Knowledge Source to update.\nFormat: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the Knowledge Source.\nAllowed values: `display_name`, `description`.\nExamples:\n- `display_name`\n- `display_name,description`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "display_name", + "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_type", + "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a knowledge assistant. Knowledge assistants can inherit permissions from their root object.", + "summary": "Update knowledge assistant permissions.", + "path": "/api/2.0/permissions/knowledge-assistants/{knowledge_assistant_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "KnowledgeAssistantPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "KnowledgeAssistantPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "KnowledgeAssistantAccessControlRequestList", + "array_value": { + "pascal_name": "KnowledgeAssistantAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "knowledge_assistant_id", + "description": "The knowledge assistant for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "dashboards.Lakeview", + "name": "Lakeview", + "description": "These APIs provide specific management operations for Lakeview dashboards. Generic resource management can be done with Workspace API (import, export, get-status, list, delete).", + "package": { + "name": "dashboards" + }, + "docs_group": "dashboards", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListDashboardsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a draft dashboard.", + "summary": "Create dashboard.", + "path": "/api/2.0/lakeview/dashboards", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateDashboardRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + }, + { + "name": "dataset_catalog", + "description": "Sets the default catalog for all datasets in this dashboard.\nDoes not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataset_schema", + "description": "Sets the default schema for all datasets in this dashboard.\nDoes not impact table references that use fully qualified schema names (ex: nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "The timestamp of when the dashboard was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifecycle_state", + "description": "The state of the dashboard resource. Used for tracking trashed status.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LifecycleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "TRASHED" + } + ] + } + }, + { + "name": "parent_path", + "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_dashboard", + "description": "The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "The warehouse ID used to run the dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateSchedule", + "description": "Create dashboard schedule.", + "summary": "Create dashboard schedule.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateScheduleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "The schedule to create. A dashboard is limited to 10 schedules.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "schedule", + "description": "The schedule to create. A dashboard is limited to 10 schedules.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "schedule", + "description": "The schedule to create. A dashboard is limited to 10 schedules.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "The schedule to create. A dashboard is limited to 10 schedules.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the schedule was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name for schedule.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the schedule. Must be left empty on create, must be provided on updates to ensure\nthat the schedule has not been modified since the last read, and can be optionally provided on delete.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pause_status", + "description": "The status indicates whether this schedule is paused or not.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SchedulePauseStatus", + "enum": [ + { + "content": "PAUSED" + }, + { + "content": "UNPAUSED" + } + ] + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the schedule was last updated.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "The warehouse id to run the dashboard with for the schedule.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + { + "name": "CreateSubscription", + "description": "Create schedule subscription.", + "summary": "Create schedule subscription.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateSubscriptionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription", + "description": "The subscription to create. A schedule is limited to 100 subscriptions.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscription", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "subscription", + "description": "The subscription to create. A schedule is limited to 100 subscriptions.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscription", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "subscription", + "description": "The subscription to create. A schedule is limited to 100 subscriptions.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscription", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Subscription", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription", + "description": "The subscription to create. A schedule is limited to 100 subscriptions.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscription", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the subscription was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_by_user_id", + "description": "UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the subscription belongs.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the subscription. Must be left empty on create, can be optionally provided on delete\nto ensure that the subscription has not been deleted since the last read.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule to which the subscription belongs.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "skip_notify", + "description": "Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.\nIf not defined, defaults to false in the backend to match the current behavior (refresh and notify)", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the subscription was last updated.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule to which the subscription belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ] + }, + { + "name": "DeleteSchedule", + "description": "Delete dashboard schedule.", + "summary": "Delete dashboard schedule.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteScheduleRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the schedule. Optionally, it can be provided to verify that the schedule has not\nbeen modified from its last retrieval.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSubscription", + "description": "Delete schedule subscription.", + "summary": "Delete schedule subscription.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteSubscriptionRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the subscription. Can be optionally provided to ensure that the subscription has not been\nmodified since the last read.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a draft dashboard.", + "summary": "Get dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPublished", + "description": "Get the current published dashboard.", + "summary": "Get published dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPublishedDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PublishedDashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSchedule", + "description": "Get dashboard schedule.", + "summary": "Get dashboard schedule.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetScheduleRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSubscription", + "description": "Get schedule subscription.", + "summary": "Get schedule subscription.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetSubscriptionRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Subscription", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "subscriber", + "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Subscriber", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscription belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "subscription_id", + "description": "UUID identifying the subscription.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List dashboards.", + "summary": "List dashboards.", + "path": "/api/2.0/lakeview/dashboards", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListDashboardsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListDashboardsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The number of dashboards to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListDashboards` call.\nThis token can be used to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "show_trashed", + "description": "The flag to include dashboards located in the trash.\nIf unspecified, only active dashboards will be returned.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "view", + "description": "`DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard.", + "is_query": true, + "entity": { + "pascal_name": "DashboardView", + "enum": [ + { + "content": "DASHBOARD_VIEW_BASIC" + } + ] + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListDashboards` call.\nThis token can be used to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSchedules", + "description": "List dashboard schedules.", + "summary": "List dashboard schedules.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSchedulesRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedules belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedules belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSchedulesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedules belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The number of schedules to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListSchedules` call.\nUse this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedules belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListSchedules` call.\nUse this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSubscriptions", + "description": "List schedule subscriptions.", + "summary": "List schedule subscriptions.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSubscriptionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSubscriptionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The number of subscriptions to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListSubscriptions` call.\nUse this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule which the subscriptions belongs.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListSubscriptions` call.\nUse this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Migrate", + "description": "Migrates a classic SQL dashboard to Lakeview.", + "summary": "Migrate dashboard.", + "path": "/api/2.0/lakeview/dashboards/migrate", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "MigrateDashboardRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_dashboard_id", + "description": "UUID of the dashboard to be migrated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "source_dashboard_id", + "description": "UUID of the dashboard to be migrated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "display_name", + "description": "Display name for the new Lakeview dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_path", + "description": "The workspace path of the folder to contain the migrated Lakeview dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_dashboard_id", + "description": "UUID of the dashboard to be migrated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_parameter_syntax", + "description": "Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated\nto named syntax (:param) when converting datasets in the dashboard.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "source_dashboard_id", + "description": "UUID of the dashboard to be migrated.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Publish", + "description": "Publish the current draft dashboard.", + "summary": "Publish dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PublishRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to be published.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to be published.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PublishedDashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to be published.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "embed_credentials", + "description": "Flag to indicate if the publisher's credentials should be embedded in the\npublished dashboard. These embedded credentials will be used to execute the\npublished dashboard's queries.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "warehouse_id", + "description": "The ID of the warehouse that can be used to override the warehouse which\nwas set in the draft.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to be published.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Revert", + "description": "Revert a dashboard's definition in draft mode to the last published version.", + "summary": "Revert dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/revert", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RevertDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RevertDashboardResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the dashboard. Optionally, it can be provided to verify that the dashboard\nhas not been modified from its last retrieval.\nTODO(TSE-3937): update to new non-CMK-encrypted label when available", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Trash", + "description": "Trash a dashboard.", + "summary": "Trash dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TrashDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TrashDashboardResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Unpublish", + "description": "Unpublish the dashboard.", + "summary": "Unpublish dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UnpublishDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UnpublishDashboardResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Update a draft dashboard.", + "summary": "Update dashboard.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateDashboardRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + }, + "response": { + "pascal_name": "Dashboard", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Dashboard", + "is_object": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataset_catalog", + "description": "Sets the default catalog for all datasets in this dashboard.\nDoes not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataset_schema", + "description": "Sets the default schema for all datasets in this dashboard.\nDoes not impact table references that use fully qualified schema names (ex: nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "The timestamp of when the dashboard was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifecycle_state", + "description": "The state of the dashboard resource. Used for tracking trashed status.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LifecycleState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "TRASHED" + } + ] + } + }, + { + "name": "parent_path", + "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serialized_dashboard", + "description": "The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "The warehouse ID used to run the dashboard.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSchedule", + "description": "Update dashboard schedule.", + "summary": "Update dashboard schedule.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateScheduleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "The schedule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "schedule", + "description": "The schedule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "schedule", + "description": "The schedule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "The schedule to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Schedule", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the schedule was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + }, + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name for schedule.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "etag", + "description": "The etag for the schedule. Must be left empty on create, must be provided on updates to ensure\nthat the schedule has not been modified since the last read, and can be optionally provided on delete.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pause_status", + "description": "The status indicates whether this schedule is paused or not.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SchedulePauseStatus", + "enum": [ + { + "content": "PAUSED" + }, + { + "content": "UNPAUSED" + } + ] + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the schedule was last updated.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "The warehouse id to run the dashboard with for the schedule.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the dashboard to which the schedule belongs.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule_id", + "description": "UUID identifying the schedule.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "cron_schedule", + "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CronSchedule", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "dashboards.LakeviewEmbedded", + "name": "LakeviewEmbedded", + "description": "Token-based Lakeview APIs for embedding dashboards in external applications.", + "package": { + "name": "dashboards" + }, + "docs_group": "dashboards", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GetPublishedDashboardTokenInfo", + "description": "Get a required authorization details and scopes of a published dashboard to mint an OAuth token.", + "summary": "Read information of a published dashboard to mint an OAuth token.", + "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published/tokeninfo", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPublishedDashboardTokenInfoRequest", + "is_object": true, + "required_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPublishedDashboardTokenInfoResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "external_value", + "description": "Provided external value to be included in the custom claim.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "external_viewer_id", + "description": "Provided external viewer id to be included in the custom claim.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "dashboard_id", + "description": "UUID identifying the published dashboard.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "compute.Libraries", + "name": "Libraries", + "description": "The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster.\n\nTo make third-party or custom code available to notebooks and jobs running on your clusters, you can install a library.\nLibraries can be written in Python, Java, Scala, and R. You can upload Python, Java, Scala and R libraries and\npoint to external packages in PyPI, Maven, and CRAN repositories.\n\nCluster libraries can be used by all notebooks running on a cluster. You can install a cluster library directly\nfrom a public repository such as PyPI or Maven, using a previously installed workspace library, or using an init script.\n\nWhen you uninstall a library from a cluster, the library is removed only when you restart the cluster.\nUntil you restart the cluster, the status of the uninstalled library appears as Uninstall pending restart.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ClusterStatus" + } + }, + "methods": [ + { + "name": "AllClusterStatuses", + "description": "Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster\nvia the API or the libraries UI.", + "summary": "Get all statuses.", + "path": "/api/2.0/libraries/all-cluster-statuses", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAllClusterLibraryStatuses", + "is_object": true + }, + "response": { + "pascal_name": "ListAllClusterLibraryStatusesResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "ClusterStatus", + "description": "Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API\nor the libraries UI.\nThe order of returned libraries is as follows:\n1. Libraries set to be installed on this cluster, in the order that the libraries were added\nto the cluster, are returned first.\n2. Libraries that were previously requested to be installed on this cluster or,\nbut are now marked for removal, in no particular order, are returned last.", + "summary": "Get status.", + "path": "/api/2.0/libraries/cluster-status", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClusterStatus", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier of the cluster whose status should be retrieved.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier of the cluster whose status should be retrieved.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClusterLibraryStatuses", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier of the cluster whose status should be retrieved.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "Unique identifier of the cluster whose status should be retrieved.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "Install", + "description": "Add libraries to install on a cluster. The installation is asynchronous; it happens in\nthe background after the completion of this request.", + "summary": "Add a library.", + "path": "/api/2.0/libraries/install", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "InstallLibraries", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to install these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to install.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to install these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to install.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ] + }, + "response": { + "pascal_name": "InstallLibrariesResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to install these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to install.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ] + }, + { + "name": "Uninstall", + "description": "Set libraries to uninstall from a cluster. The libraries won't be uninstalled until\nthe cluster is restarted. A request to uninstall a library that is not currently installed is ignored.", + "summary": "Uninstall libraries.", + "path": "/api/2.0/libraries/uninstall", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UninstallLibraries", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to uninstall these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to uninstall.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to uninstall these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to uninstall.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ] + }, + "response": { + "pascal_name": "UninstallLibrariesResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "Unique identifier for the cluster on which to uninstall these libraries.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "libraries", + "description": "The libraries to uninstall.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LibraryList", + "array_value": { + "pascal_name": "Library", + "is_object": true + } + } + } + ] + } + ] + }, + { + "id": "settings.LlmProxyPartnerPoweredAccount", + "name": "LlmProxyPartnerPoweredAccount", + "description": "Determines if partner powered models are enabled or not for a specific account", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Get", + "description": "Gets the enable partner powered AI features account setting.", + "summary": "Get the enable partner powered AI features account setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/llm_proxy_partner_powered/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetLlmProxyPartnerPoweredAccountRequest", + "is_object": true + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredAccount", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the enable partner powered AI features account setting.", + "summary": "Update the enable partner powered AI features account setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/llm_proxy_partner_powered/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateLlmProxyPartnerPoweredAccountRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredAccount", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredAccount", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredAccount", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredAccount", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.LlmProxyPartnerPoweredEnforce", + "name": "LlmProxyPartnerPoweredEnforce", + "description": "Determines if the account-level partner-powered setting value is enforced upon the workspace-level partner-powered setting", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Get", + "description": "Gets the enforcement status of partner powered AI features account setting.", + "summary": "Get the enforcement status of partner powered AI features account setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/llm_proxy_partner_powered_enforce/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetLlmProxyPartnerPoweredEnforceRequest", + "is_object": true + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredEnforce", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the enable enforcement status of partner powered AI features account setting.", + "summary": "Update the enforcement status of partner powered AI features account setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/llm_proxy_partner_powered_enforce/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateLlmProxyPartnerPoweredEnforceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredEnforce", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredEnforce", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredEnforce", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredEnforce", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "settings.LlmProxyPartnerPoweredWorkspace", + "name": "LlmProxyPartnerPoweredWorkspace", + "description": "Determines if partner powered models are enabled or not for a specific workspace", + "package": { + "name": "settings" + }, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the enable partner powered AI features workspace setting to its default value.", + "summary": "Delete the enable partner powered AI features workspace setting.", + "path": "/api/2.0/settings/types/llm_proxy_partner_powered/names/default", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteLlmProxyPartnerPoweredWorkspaceRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteLlmProxyPartnerPoweredWorkspaceResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the enable partner powered AI features workspace setting.", + "summary": "Get the enable partner powered AI features workspace setting.", + "path": "/api/2.0/settings/types/llm_proxy_partner_powered/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetLlmProxyPartnerPoweredWorkspaceRequest", + "is_object": true + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredWorkspace", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the enable partner powered AI features workspace setting.", + "summary": "Update the enable partner powered AI features workspace setting.", + "path": "/api/2.0/settings/types/llm_proxy_partner_powered/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateLlmProxyPartnerPoweredWorkspaceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredWorkspace", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredWorkspace", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LlmProxyPartnerPoweredWorkspace", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LlmProxyPartnerPoweredWorkspace", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "billing.LogDelivery", + "name": "LogDelivery", + "description": "These APIs manage log delivery configurations for this account. The two supported log types for this API are _billable usage logs_ (AWS only) and _audit logs_ (AWS and GCP). This feature is in Public Preview. This feature works with all account ID types.\n\nLog delivery works with all account types. However, if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account, you can optionally configure different storage destinations for each workspace. Log delivery status is also provided to know the latest status of log delivery attempts.\n\nThe high-level flow of billable usage delivery (AWS only):\n\n1. **Create storage**: In AWS, [create a new AWS S3 bucket](https://docs.databricks.com/administration-guide/account-api/aws-storage.html) with a specific bucket policy. Using Databricks APIs, call the Account API to create a [storage configuration object](:method:Storage/Create) that uses the bucket name.\n\n2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details, including the required IAM role policies and trust relationship, see [Billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). Using Databricks APIs, call the Account API to create a [credential configuration object](:method:Credentials/Create) that uses the IAM role's ARN.\n\n3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and storage configuration objects from previous steps. You can specify if the logs should include all events of that log type in your account (_Account level_ delivery) or only events for a specific set of workspaces (_workspace level_ delivery). Account level log delivery applies to all current and future workspaces plus account level logs, while workspace level log delivery solely delivers logs related to the specified workspaces. You can create multiple types of delivery configurations per account.\n\nFor billable usage delivery (AWS only):\n* For more information about billable usage logs, see [Billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [Usage page](https://docs.databricks.com/administration-guide/account-settings/usage.html).\n* The delivery location is `\u003cbucket-name\u003e/\u003cprefix\u003e/billable-usage/csv/`, where `\u003cprefix\u003e` is the name of the optional delivery path prefix you set up during log delivery configuration. Files are named `workspaceId=\u003cworkspace-id\u003e-usageMonth=\u003cmonth\u003e.csv`.\n* All billable usage logs apply to specific workspaces (_workspace level_ logs). You can aggregate usage for your entire account by creating an _account level_ delivery configuration that delivers logs for all current and future workspaces in your account.\n* The files are delivered daily by overwriting the month's CSV file for each workspace.\n\nFor audit log delivery (AWS and GCP):\n* For more information about about audit log delivery, see Audit log delivery [AWS](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html) or [GCP](https://docs.databricks.com/gcp/en/admin/account-settings/audit-logs), which includes information about the used JSON schema.\n* The delivery location is `\u003cbucket-name\u003e/\u003cdelivery-path-prefix\u003e/workspaceId=\u003cworkspaceId\u003e/date=\u003cyyyy-mm-dd\u003e/auditlogs_\u003cinternal-id\u003e.json`. Files may get overwritten with the same content multiple times to achieve exactly-once delivery.\n* If the audit log delivery configuration included specific workspace IDs, only _workspace-level_ audit logs for those workspaces are delivered. If the log delivery configuration applies to the entire account (_account level_ delivery configuration), the audit log delivery includes workspace-level audit logs for all workspaces in the account as well as account-level audit logs. See Audit log delivery [AWS](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html) or [GCP](https://docs.databricks.com/gcp/en/admin/account-settings/audit-logs) for details.\n* Auditable events are typically available in logs within 15 minutes.", + "package": { + "name": "billing" + }, + "is_accounts": true, + "docs_group": "billing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "LogDeliveryConfigurationConfigNameToConfigIdMap" + }, + "request": { + "pascal_name": "ListLogDeliveryRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs to your storage location.\nThis requires that you already created a [credential object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role)\nand a [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket).\n\nFor full details, including the required IAM role policies and bucket policies,\nsee [Deliver and access billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html)\nor [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).\n\n**Note**: There is a limit on the number of log delivery configurations available per account (each limit applies separately to each log type including billable usage and audit logs).\nYou can create a maximum of two enabled account-level delivery configurations (configurations without a workspace filter) per type.\nAdditionally, you can create two enabled workspace-level delivery configurations per workspace for each log type, which means that the same workspace ID can occur in the workspace filter for no more than two delivery configurations per log type.\n\nYou cannot delete a log delivery configuration, but you can disable it (see [Enable or disable log delivery configuration](:method:LogDelivery/PatchStatus)).", + "summary": "Create a new log delivery configuration.", + "path": "/api/2.0/accounts/{account_id}/log-delivery", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WrappedCreateLogDeliveryConfiguration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "log_delivery_configuration", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateLogDeliveryConfigurationParams", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "log_delivery_configuration", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateLogDeliveryConfigurationParams", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "WrappedLogDeliveryConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "log_delivery_configuration", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateLogDeliveryConfigurationParams", + "is_object": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Databricks log delivery configuration object for an account, both specified by ID.", + "summary": "Get log delivery configuration.", + "path": "/api/2.0/accounts/{account_id}/log-delivery/{log_delivery_configuration_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetLogDeliveryRequest", + "is_object": true, + "required_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetLogDeliveryConfigurationResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all Databricks log delivery configurations associated with an account specified by ID.", + "summary": "Get all log delivery configurations.", + "path": "/api/2.0/accounts/{account_id}/log-delivery", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListLogDeliveryRequest", + "is_object": true + }, + "response": { + "pascal_name": "WrappedLogDeliveryConfigurations", + "is_object": true + }, + "all_fields": [ + { + "name": "credentials_id", + "description": "The Credentials id to filter the search results with", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "The log delivery status to filter the search results with", + "is_query": true, + "entity": { + "pascal_name": "LogDeliveryConfigStatus", + "enum": [ + { + "content": "DISABLED" + }, + { + "content": "ENABLED" + } + ] + } + }, + { + "name": "storage_configuration_id", + "description": "The Storage Configuration id to filter the search results with", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "PatchStatus", + "description": "Enables or disables a log delivery configuration.\nDeletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed.\nNote that you can't re-enable a delivery configuration if this would violate the delivery configuration limits described under [Create log delivery](:method:LogDelivery/Create).", + "summary": "Enable or disable log delivery configuration.", + "path": "/api/2.0/accounts/{account_id}/log-delivery/{log_delivery_configuration_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateLogDeliveryConfigurationStatusRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LogDeliveryConfigStatus", + "enum": [ + { + "content": "DISABLED" + }, + { + "content": "ENABLED" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "status", + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LogDeliveryConfigStatus", + "enum": [ + { + "content": "DISABLED" + }, + { + "content": "ENABLED" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "PatchStatusResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LogDeliveryConfigStatus", + "enum": [ + { + "content": "DISABLED" + }, + { + "content": "ENABLED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "log_delivery_configuration_id", + "description": "The log delivery configuration id of customer", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "LogDeliveryConfigStatus", + "enum": [ + { + "content": "DISABLED" + }, + { + "content": "ENABLED" + } + ] + } + } + ] + } + ] + }, + { + "id": "ml.MaterializedFeatures", + "name": "MaterializedFeatures", + "description": "Materialized Features are columns in tables and views that can be directly used as features to train and serve ML models.", + "package": { + "name": "ml" + }, + "is_hidden_cli": true, + "docs_group": "ml", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListFeatureTagsRequest" + } + }, + "methods": [ + { + "name": "CreateFeatureTag", + "description": "Creates a FeatureTag.", + "summary": "Create a feature tag.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateFeatureTagRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteFeatureTag", + "description": "Deletes a FeatureTag.", + "summary": "Delete a feature tag.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteFeatureTagRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "The name of the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature within the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "The key of the tag to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "The name of the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature within the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "The key of the tag to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "feature_name", + "description": "The name of the feature within the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "The key of the tag to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "The name of the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "The name of the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature within the feature table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "The key of the tag to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetFeatureLineage", + "description": "Get Feature Lineage.", + "summary": "Get Feature Lineage.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/lineage", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetFeatureLineageRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "The full name of the feature table in Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "The full name of the feature table in Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FeatureLineage", + "is_object": true + }, + "all_fields": [ + { + "name": "feature_name", + "description": "The name of the feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "The full name of the feature table in Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "The full name of the feature table in Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "description": "The name of the feature.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetFeatureTag", + "description": "Gets a FeatureTag.", + "summary": "Get a feature tag.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetFeatureTagRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListFeatureTags", + "description": "Lists FeatureTags.", + "summary": "List all feature tags.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListFeatureTagsRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFeatureTagsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "The maximum number of results to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateFeatureTag", + "description": "Updates a FeatureTag.", + "summary": "Update a feature tag.", + "path": "/api/2.0/feature-store/feature-tables/{table_name}/features/{feature_name}/tags/{key}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateFeatureTagRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_tag", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FeatureTag", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "feature_name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.AccountMetastoreAssignments", + "name": "AccountMetastoreAssignments", + "description": "These APIs manage metastore assignments to a workspace.", + "package": { + "name": "catalog" + }, + "is_accounts": true, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountMetastoreAssignmentsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates an assignment to a metastore for a workspace", + "summary": "Assigns a workspace to a metastore.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsCreateMetastoreAssignment", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsCreateMetastoreAssignmentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_assignment", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateMetastoreAssignment", + "is_object": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a metastore assignment to a workspace, leaving the workspace with no metastore.", + "summary": "Delete a metastore assignment.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountMetastoreAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsDeleteMetastoreAssignmentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the metastore assignment, if any, for the workspace specified by ID.\nIf the workspace is assigned a metastore, the mapping will be returned.\nIf no metastore is assigned to the workspace, the assignment will not be\nfound and a 404 returned.", + "summary": "Gets the metastore assignment for a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastore", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountMetastoreAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsMetastoreAssignment", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of all Databricks workspace IDs that have been assigned to given metastore.", + "summary": "Get all workspaces assigned to a metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/workspaces", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountMetastoreAssignmentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAccountMetastoreAssignmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "Update", + "description": "Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be updated.", + "summary": "Updates a metastore assignment to a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/metastores/{metastore_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsUpdateMetastoreAssignment", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsUpdateMetastoreAssignmentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_assignment", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateMetastoreAssignment", + "is_object": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "Workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.Metastores", + "name": "Metastores", + "description": "A metastore is the top-level container of objects in Unity Catalog. It stores data assets\n(tables and views) and the permissions that govern access to them. Databricks account admins\ncan create metastores and assign them to Databricks workspaces to control which workloads\nuse each metastore. For a workspace to use Unity Catalog, it must have a Unity Catalog\nmetastore attached.\n\nEach metastore is configured with a root storage location in a cloud storage account.\nThis storage location is used for metadata and managed tables data.\n\nNOTE: This metastore is distinct from the metastore included in Databricks workspaces\ncreated before Unity Catalog was released. If your workspace includes a legacy Hive\nmetastore, the data in that metastore is available in a catalog named hive_metastore.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListMetastoresRequest" + } + }, + "methods": [ + { + "name": "Assign", + "description": "Creates a new metastore assignment.\nIf an assignment for the same __workspace_id__ exists, it will be overwritten by the new __metastore_id__ and\n__default_catalog_name__. The caller must be an account admin.", + "summary": "Create an assignment.", + "path": "/api/2.1/unity-catalog/workspaces/{workspace_id}/metastore", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateMetastoreAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_catalog_name", + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_catalog_name", + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AssignResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "default_catalog_name", + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_catalog_name", + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Creates a new metastore based on a provided name and optional storage root path.\nBy default (if the __owner__ field is not set), the owner of the new metastore is the user calling\nthe __createMetastore__ API. If the __owner__ field is set to the empty string (**\"\"**), the ownership is\nassigned to the System User instead.", + "summary": "Create a metastore.", + "path": "/api/2.1/unity-catalog/metastores", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateMetastore", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The user-specified name of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The user-specified name of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MetastoreInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "external_access_enabled", + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The user-specified name of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "Cloud region which the metastore serves (e.g., `us-west-2`, `westus`).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_root", + "description": "The storage root URL for metastore", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The user-specified name of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Current", + "description": "Gets the metastore assignment for the workspace being accessed.", + "summary": "Get metastore assignment for workspace.", + "path": "/api/2.1/unity-catalog/current-metastore-assignment", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CurrentRequest", + "is_object": true + }, + "response": { + "pascal_name": "MetastoreAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The unique ID of the Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_id", + "description": "The unique ID of the Databricks workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "Delete", + "description": "Deletes a metastore. The caller must be a metastore admin.", + "summary": "Delete a metastore.", + "path": "/api/2.1/unity-catalog/metastores/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteMetastoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the metastore is not empty. Default is false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info.", + "summary": "Get a metastore.", + "path": "/api/2.1/unity-catalog/metastores/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetMetastoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MetastoreInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin to retrieve this info.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List metastores.", + "path": "/api/2.1/unity-catalog/metastores", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListMetastoresRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListMetastoresResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of metastores to return.\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the metastores are returned (not recommended).\n- Note: The number of returned metastores might be less than the specified max_results size, even zero.\nThe only definitive indication that no further metastores can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of metastores to return.\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the metastores are returned (not recommended).\n- Note: The number of returned metastores might be less than the specified max_results size, even zero.\nThe only definitive indication that no further metastores can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Summary", + "description": "Gets information about a metastore.\nThis summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.", + "summary": "Get a metastore summary.", + "path": "/api/2.1/unity-catalog/metastore_summary", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SummaryRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetMetastoreSummaryResponse", + "is_object": true + } + }, + { + "name": "Unassign", + "description": "Deletes a metastore assignment. The caller must be an account administrator.", + "summary": "Delete an assignment.", + "path": "/api/2.1/unity-catalog/workspaces/{workspace_id}/metastore", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UnassignRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Query for the ID of the metastore to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Query for the ID of the metastore to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UnassignResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Query for the ID of the metastore to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "metastore_id", + "description": "Query for the ID of the metastore to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates information for a specific metastore. The caller must be a metastore admin.\nIf the __owner__ field is set to the empty string (**\"\"**), the ownership is updated\nto the System User.", + "summary": "Update a metastore.", + "path": "/api/2.1/unity-catalog/metastores/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateMetastore", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MetastoreInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "delta_sharing_organization_name", + "description": "The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "delta_sharing_recipient_token_lifetime_in_seconds", + "description": "The lifetime of delta sharing recipient token in seconds.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "delta_sharing_scope", + "description": "The scope of Delta Sharing enabled for the metastore.", + "is_request_body_field": true, + "entity": { + "pascal_name": "DeltaSharingScopeEnum", + "enum": [ + { + "content": "INTERNAL" + }, + { + "content": "INTERNAL_AND_EXTERNAL" + } + ] + } + }, + { + "name": "external_access_enabled", + "description": "Whether to allow non-DBR clients to directly access entities under the metastore.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the metastore.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The owner of the metastore.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "privilege_model_version", + "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_root_credential_id", + "description": "UUID of storage credential to access the metastore storage_root.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID of the metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateAssignment", + "description": "Updates a metastore assignment. This operation can be used to update __metastore_id__ or __default_catalog_name__\nfor a specified Workspace, if the Workspace is already assigned a metastore.\nThe caller must be an account admin to update __metastore_id__; otherwise, the caller can be a Workspace admin.", + "summary": "Update an assignment.", + "path": "/api/2.1/unity-catalog/workspaces/{workspace_id}/metastore", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateMetastoreAssignment", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateAssignmentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "default_catalog_name", + "description": "The name of the default catalog in the metastore.\nThis field is deprecated. Please use \"Default Namespace API\" to\nconfigure the default catalog for a Databricks workspace.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The unique ID of the metastore.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "A workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "catalog.AccountMetastores", + "name": "AccountMetastores", + "description": "These APIs manage Unity Catalog metastores for an account. A metastore contains catalogs that can be associated with workspaces", + "package": { + "name": "catalog" + }, + "is_accounts": true, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListAccountMetastoresRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a Unity Catalog metastore.", + "summary": "Create Metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsCreateMetastore", + "is_object": true + }, + "response": { + "pascal_name": "AccountsCreateMetastoreResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateAccountsMetastore", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Unity Catalog metastore for an account, both specified by ID.", + "summary": "Delete a metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountMetastoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsDeleteMetastoreResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the metastore is not empty. Default is false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Unity Catalog metastore from an account, both specified by ID.", + "summary": "Get a metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountMetastoreRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsGetMetastoreResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets all Unity Catalog metastores associated with an account specified by ID.", + "summary": "Get all metastores associated with an account.", + "path": "/api/2.0/accounts/{account_id}/metastores", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountMetastoresRequest", + "is_object": true + }, + "response": { + "pascal_name": "AccountsListMetastoresResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Update", + "description": "Updates an existing Unity Catalog metastore.", + "summary": "Update a metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsUpdateMetastore", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsUpdateMetastoreResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_info", + "description": "Properties of the metastore to change.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateAccountsMetastore", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "ml.ModelRegistry", + "name": "ModelRegistry", + "description": "Note: This API reference documents APIs for the Workspace Model Registry. Databricks recommends using\n[Models in Unity Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog provides\ncentralized model governance, cross-workspace access, lineage, and deployment. Workspace Model Registry\nwill be deprecated in the future.\n\nThe Workspace Model Registry is a centralized model repository and a UI and set of APIs that enable\nyou to manage the full lifecycle of MLflow Models.", + "package": { + "name": "ml" + }, + "docs_group": "ml", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListModelsRequest" + } + }, + "methods": [ + { + "name": "ApproveTransitionRequest", + "description": "Approves a model version stage transition request.", + "summary": "Approve transition request.", + "path": "/api/2.0/mlflow/transition-requests/approve", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ApproveTransitionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + "response": { + "pascal_name": "ApproveTransitionRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "CreateComment", + "description": "Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display\nrelevant information about the model. For example, test results or deployment errors.", + "summary": "Post a comment.", + "path": "/api/2.0/mlflow/comments/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateComment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateCommentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateModel", + "description": "Creates a new registered model with the name specified in the request body.\nThrows `RESOURCE_ALREADY_EXISTS` if a registered model with the given name exists.", + "summary": "Create a model.", + "path": "/api/2.0/mlflow/registered-models/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateModelRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Register models under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Register models under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "Optional description for registered model.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Register models under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "Additional metadata for registered model.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ModelTagList", + "array_value": { + "pascal_name": "ModelTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Register models under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateModelVersion", + "description": "Creates a model version.", + "summary": "Create a model version.", + "path": "/api/2.0/mlflow/model-versions/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateModelVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Register model under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "URI indicating the location of the model artifacts.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Register model under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "URI indicating the location of the model artifacts.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateModelVersionResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "Optional description for model version.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Register model under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_id", + "description": "MLflow run ID for correlation, if `source` was generated by an experiment run in\nMLflow tracking server", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_link", + "description": "MLflow run link - this is the exact link of the run that generated this model version,\npotentially hosted at another instance of MLflow.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "URI indicating the location of the model artifacts.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "Additional metadata for model version.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ModelVersionTagList", + "array_value": { + "pascal_name": "ModelVersionTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Register model under this name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "URI indicating the location of the model artifacts.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateTransitionRequest", + "description": "Creates a model version stage transition request.", + "summary": "Make a transition request.", + "path": "/api/2.0/mlflow/transition-requests/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateTransitionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateTransitionRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided comment on the action.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateWebhook", + "description": "**NOTE:** This endpoint is in Public Preview.\nCreates a registry webhook.", + "summary": "Create a webhook.", + "path": "/api/2.0/mlflow/registry-webhooks/create", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateRegistryWebhook", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "events", + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookEventList", + "array_value": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + } + } + ], + "required_request_body_fields": [ + { + "name": "events", + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookEventList", + "array_value": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + } + } + ] + }, + "response": { + "pascal_name": "CreateWebhookResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "User-specified description for the webhook.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "events", + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookEventList", + "array_value": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + } + }, + { + "name": "http_url_spec", + "description": "External HTTPS URL called on event trigger (by using a POST request).", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "HttpUrlSpec", + "is_object": true + } + }, + { + "name": "job_spec", + "description": "ID of the job that the webhook runs.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobSpec", + "is_object": true + } + }, + { + "name": "model_name", + "description": "If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Enable or disable triggering the webhook, or put the webhook into test mode. The default is `ACTIVE`:\n* `ACTIVE`: Webhook is triggered when an associated event happens.\n\n* `DISABLED`: Webhook is not triggered.\n\n* `TEST_MODE`: Webhook can be triggered through the test endpoint, but is not triggered on a real event.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookStatus", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DISABLED" + }, + { + "content": "TEST_MODE" + } + ] + } + } + ] + }, + { + "name": "DeleteComment", + "description": "Deletes a comment on a model version.", + "summary": "Delete a comment.", + "path": "/api/2.0/mlflow/comments/delete", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteCommentRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteCommentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteModel", + "description": "Deletes a registered model.", + "summary": "Delete a model.", + "path": "/api/2.0/mlflow/registered-models/delete", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteModelResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteModelTag", + "description": "Deletes the tag for a registered model.", + "summary": "Delete a model tag.", + "path": "/api/2.0/mlflow/registered-models/delete-tag", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteModelTagRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteModelTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteModelVersion", + "description": "Deletes a model version.", + "summary": "Delete a model version.", + "path": "/api/2.0/mlflow/model-versions/delete", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteModelVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteModelVersionResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteModelVersionTag", + "description": "Deletes a model version tag.", + "summary": "Delete a model version tag.", + "path": "/api/2.0/mlflow/model-versions/delete-tag", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteModelVersionTagRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteModelVersionTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number that the tag was logged under.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteTransitionRequest", + "description": "Cancels a model version stage transition request.", + "summary": "Delete a transition request.", + "path": "/api/2.0/mlflow/transition-requests/delete", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTransitionRequestRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteTransitionRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided comment on the action.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator", + "description": "Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteWebhook", + "description": "**NOTE:** This endpoint is in Public Preview.\nDeletes a registry webhook.", + "summary": "Delete a webhook.", + "path": "/api/2.0/mlflow/registry-webhooks/delete", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteWebhookRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Webhook ID required to delete a registry webhook.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Webhook ID required to delete a registry webhook.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteWebhookResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Webhook ID required to delete a registry webhook.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Webhook ID required to delete a registry webhook.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetLatestVersions", + "description": "Gets the latest version of a registered model.", + "summary": "Get the latest version.", + "path": "/api/2.0/mlflow/registered-models/get-latest-versions", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetLatestVersionsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetLatestVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stages", + "description": "List of stages.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "GetModel", + "description": "Get the details of a model.\nThis is a Databricks workspace version of the [MLflow endpoint](https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel)\nthat also returns the model's Databricks workspace ID and the permission level of the requesting user on the model.", + "summary": "Get model.", + "path": "/api/2.0/mlflow/databricks/registered-models/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetModelVersion", + "description": "Get a model version.", + "summary": "Get a model version.", + "path": "/api/2.0/mlflow/model-versions/get", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetModelVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetModelVersionResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetModelVersionDownloadUri", + "description": "Gets a URI to download the model version.", + "summary": "Get a model version URI.", + "path": "/api/2.0/mlflow/model-versions/get-download-uri", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetModelVersionDownloadUriRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetModelVersionDownloadUriResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get registered model permission levels.", + "path": "/api/2.0/permissions/registered-models/{registered_model_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRegisteredModelPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetRegisteredModelPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a registered model. Registered models can inherit permissions from their root object.", + "summary": "Get registered model permissions.", + "path": "/api/2.0/permissions/registered-models/{registered_model_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRegisteredModelPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListModels", + "description": "Lists all available registered models, up to the limit specified in __max_results__.", + "summary": "List models.", + "path": "/api/2.0/mlflow/registered-models/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListModelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListModelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of registered models desired. Max threshold is 1000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListTransitionRequests", + "description": "Gets a list of all open stage transition requests for the model version.", + "summary": "List transition requests.", + "path": "/api/2.0/mlflow/transition-requests/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListTransitionRequestsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the registered model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListTransitionRequestsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the registered model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "ListWebhooks", + "description": "**NOTE:** This endpoint is in Public Preview.\nLists all registry webhooks.", + "summary": "List registry webhooks.", + "path": "/api/2.0/mlflow/registry-webhooks/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWebhooksRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListRegistryWebhooks", + "is_object": true + }, + "all_fields": [ + { + "name": "events", + "description": "Events that trigger the webhook.\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.\n\nIf `events` is specified, any webhook with one or more of the specified trigger events is included in the output.\nIf `events` is not specified, webhooks of all event types are included in the output.", + "is_query": true, + "entity": { + "pascal_name": "RegistryWebhookEventList", + "array_value": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + } + }, + { + "name": "max_results", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "model_name", + "description": "Registered model name\nIf not specified, all webhooks associated with the specified events are listed, regardless of their associated model.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Token indicating the page of artifact results to fetch", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token indicating the page of artifact results to fetch", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "RejectTransitionRequest", + "description": "Rejects a model version stage transition request.", + "summary": "Reject a transition request.", + "path": "/api/2.0/mlflow/transition-requests/reject", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RejectTransitionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RejectTransitionRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided comment on the action.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RenameModel", + "description": "Renames a registered model.", + "summary": "Rename a model.", + "path": "/api/2.0/mlflow/registered-models/rename", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RenameModelRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RenameModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "If provided, updates the name for this `registered_model`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SearchModelVersions", + "description": "Searches for specific model versions based on the supplied __filter__.", + "summary": "Search model versions.", + "path": "/api/2.0/mlflow/model-versions/search", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SearchModelVersionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "SearchModelVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "String filter condition, like \"name='my-model-name'\". Must be a single boolean condition,\nwith string values wrapped in single quotes.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of models desired. Max threshold is 10K.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "order_by", + "description": "List of columns to be ordered by including model name, version, stage with an\noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Pagination token to go to next page based on previous search query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to next page based on previous search query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SearchModels", + "description": "Search for registered models based on the specified __filter__.", + "summary": "Search models.", + "path": "/api/2.0/mlflow/registered-models/search", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SearchModelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "SearchModelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "String filter condition, like \"name LIKE 'my-model-name'\".\nInterpreted in the backend automatically as \"name LIKE '%my-model-name%'\".\nSingle boolean condition, with string values wrapped in single quotes.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of models desired. Default is 100. Max threshold is 1000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "order_by", + "description": "List of columns for ordering search results, which can include model name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by model name ASC.", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous search query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page based on a previous search query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetModelTag", + "description": "Sets a tag on a registered model.", + "summary": "Set a tag.", + "path": "/api/2.0/mlflow/registered-models/set-tag", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetModelTagRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetModelTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetModelVersionTag", + "description": "Sets a model version tag.", + "summary": "Set a version tag.", + "path": "/api/2.0/mlflow/model-versions/set-tag", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetModelVersionTagRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SetModelVersionTagResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Unique name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the tag. Maximum size depends on storage backend.\nIf a tag with this name already exists, its preexisting value will be replaced by the specified `value`.\nAll storage backends are guaranteed to support key values up to 250 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "String value of the tag being logged. Maximum size depends on storage backend.\nAll storage backends are guaranteed to support key values up to 5000 bytes in size.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set registered model permissions.", + "path": "/api/2.0/permissions/registered-models/{registered_model_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RegisteredModelPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegisteredModelAccessControlRequestList", + "array_value": { + "pascal_name": "RegisteredModelAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "TestRegistryWebhook", + "description": "**NOTE:** This endpoint is in Public Preview.\nTests a registry webhook.", + "summary": "Test a webhook.", + "path": "/api/2.0/mlflow/registry-webhooks/test", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TestRegistryWebhookRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TestRegistryWebhookResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "event", + "description": "If `event` is specified, the test trigger uses the specified event. If `event` is not specified, the test trigger uses a randomly chosen event associated with the webhook.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + }, + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "TransitionStage", + "description": "Transition a model version's stage.\nThis is a Databricks workspace version of the [MLflow endpoint](https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage)\nthat also accepts a comment associated with the transition to be recorded.", + "summary": "Transition a stage.", + "path": "/api/2.0/mlflow/databricks/model-versions/transition-stage", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TransitionModelVersionStageDatabricks", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + "response": { + "pascal_name": "TransitionStageResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version of the model.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "stage", + "description": "Target stage of the transition. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "archive_existing_versions", + "description": "Specifies whether to archive all current model versions in the target stage.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ] + }, + { + "name": "UpdateComment", + "description": "Post an edit to a comment on a model version.", + "summary": "Update a comment.", + "path": "/api/2.0/mlflow/comments/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateComment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateCommentResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique identifier of an activity", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided comment on the action.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateModel", + "description": "Updates a registered model.", + "summary": "Update model.", + "path": "/api/2.0/mlflow/registered-models/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateModelRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateModelResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "If provided, updates the description for this `registered_model`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Registered model unique name identifier.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateModelVersion", + "description": "Updates the model version.", + "summary": "Update model version.", + "path": "/api/2.0/mlflow/model-versions/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateModelVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateModelVersionResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "If provided, updates the description for this `registered_model`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the registered model", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Model version number", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a registered model. Registered models can inherit permissions from their root object.", + "summary": "Update registered model permissions.", + "path": "/api/2.0/permissions/registered-models/{registered_model_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RegisteredModelPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegisteredModelAccessControlRequestList", + "array_value": { + "pascal_name": "RegisteredModelAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "registered_model_id", + "description": "The registered model for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateWebhook", + "description": "**NOTE:** This endpoint is in Public Preview.\nUpdates a registry webhook.", + "summary": "Update a webhook.", + "path": "/api/2.0/mlflow/registry-webhooks/update", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateRegistryWebhook", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateWebhookResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "User-specified description for the webhook.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "events", + "description": "Events that can trigger a registry webhook:\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookEventList", + "array_value": { + "pascal_name": "RegistryWebhookEvent", + "enum": [ + { + "content": "COMMENT_CREATED" + }, + { + "content": "MODEL_VERSION_CREATED" + }, + { + "content": "MODEL_VERSION_TAG_SET" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_STAGE" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION" + }, + { + "content": "MODEL_VERSION_TRANSITIONED_TO_STAGING" + }, + { + "content": "REGISTERED_MODEL_CREATED" + }, + { + "content": "TRANSITION_REQUEST_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_ARCHIVED_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_PRODUCTION_CREATED" + }, + { + "content": "TRANSITION_REQUEST_TO_STAGING_CREATED" + } + ] + } + } + }, + { + "name": "http_url_spec", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "HttpUrlSpec", + "is_object": true + } + }, + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "job_spec", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "JobSpec", + "is_object": true + } + }, + { + "name": "status", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegistryWebhookStatus", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DISABLED" + }, + { + "content": "TEST_MODE" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Webhook ID", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.ModelVersions", + "name": "ModelVersions", + "description": "Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.\nModels in Unity Catalog provide centralized access control, auditing, lineage, and discovery of\nML models across Databricks workspaces.\n\nThis API reference documents the REST endpoints for managing model versions in Unity Catalog. For\nmore details, see the [registered models API docs](/api/workspace/registeredmodels).", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListModelVersionsRequest" + } + }, + "methods": [ + { + "name": "Delete", + "description": "Deletes a model version from the specified registered model. Any aliases assigned to the\nmodel version will also be deleted.\n\nThe caller must be a metastore admin or an owner of the parent registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Delete a Model Version.", + "path": "/api/2.1/unity-catalog/models/{full_name}/versions/{version}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteModelVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a model version.\n\nThe caller must be a metastore admin or an owner of (or have the **EXECUTE**\nprivilege on) the parent registered model. For the latter case, the caller must also be the owner\nor have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege\non the parent schema.", + "summary": "Get a Model Version.", + "path": "/api/2.1/unity-catalog/models/{full_name}/versions/{version}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetModelVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "ModelVersionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_aliases", + "description": "Whether to include aliases associated with the model version in the response", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_browse", + "description": "Whether to include model versions in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + { + "name": "GetByAlias", + "description": "Get a model version by alias.\n\nThe caller must be a metastore admin or an owner of (or have the **EXECUTE**\nprivilege on) the registered model. For the latter case, the caller must also be the owner\nor have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege\non the parent schema.", + "summary": "Get Model Version By Alias.", + "path": "/api/2.1/unity-catalog/models/{full_name}/aliases/{alias}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetByAliasRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ModelVersionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_aliases", + "description": "Whether to include aliases associated with the model version in the response", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List model versions. You can list model versions under a particular schema,\nor list all model versions in the current metastore.\n\nThe returned models are filtered based on the privileges of the calling user.\nFor example, the metastore admin is able to list all the model versions.\nA regular user needs to be the owner or have the **EXECUTE** privilege\non the parent registered model to recieve the model versions in the response.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nThere is no guarantee of a specific ordering of the elements in the response. The\nelements in the response will not contain any aliases or tags.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List Model Versions.", + "path": "/api/2.1/unity-catalog/models/{full_name}/versions", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListModelVersionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The full three-level name of the registered model under which to list model versions", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The full three-level name of the registered model under which to list model versions", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListModelVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The full three-level name of the registered model under which to list model versions", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include model versions in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of model versions to return.\nIf not set, the page length is set to a server configured value (100, as of 1/3/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value(1000, as of 1/3/2024);\n- when set to 0, the page length is set to a server configured value (100, as of 1/3/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The full three-level name of the registered model under which to list model versions", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates the specified model version.\n\nThe caller must be a metastore admin or an owner of the parent registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nCurrently only the comment of the model version can be updated.", + "summary": "Update a Model Version.", + "path": "/api/2.1/unity-catalog/models/{full_name}/versions/{version}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateModelVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "ModelVersionInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aliases", + "description": "List of aliases associated with the model version", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegisteredModelAliasList", + "array_value": { + "pascal_name": "RegisteredModelAlias", + "is_object": true + } + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog containing the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "The comment attached to the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "The identifier of the user who created the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "The unique identifier of the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The unique identifier of the metastore containing the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "model_name", + "description": "The name of the parent registered model of the model version, relative to parent schema", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "model_version_dependencies", + "description": "Model version dependencies, for feature-store packaged models", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DependencyList", + "is_object": true + } + }, + { + "name": "run_id", + "description": "MLflow run ID used when creating the model version, if ``source`` was generated by an\nexperiment run stored in an MLflow tracking server", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_workspace_id", + "description": "ID of the Databricks workspace containing the MLflow run that generated this model\nversion, if applicable", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema containing the model version, relative to parent catalog", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "source", + "description": "URI indicating the location of the source artifacts (files) for the model version", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "Current status of the model version. Newly created model versions start in\nPENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and\nthe model version is finalized. Only model versions in READY status can be loaded for inference or\nserved.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ModelVersionInfoStatus", + "enum": [ + { + "content": "FAILED_REGISTRATION" + }, + { + "content": "MODEL_VERSION_STATUS_UNKNOWN" + }, + { + "content": "PENDING_REGISTRATION" + }, + { + "content": "READY" + } + ] + } + }, + { + "name": "storage_location", + "description": "The storage location on the cloud under which model version data files are stored", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_at", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "updated_by", + "description": "The identifier of the user who updated the model version last time", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the model version", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The integer version number of the model version", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + } + ] + }, + { + "id": "settings.NetworkConnectivity", + "name": "NetworkConnectivity", + "description": "These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources. This API provides stable subnets for your workspace so that you can configure your firewalls on your Azure Storage accounts to allow access from Databricks. You can also use the API to provision private endpoints for Databricks to privately connect serverless compute resources to your Azure resources using Azure Private Link. See [configure serverless secure connectivity](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security).", + "package": { + "name": "settings" + }, + "is_accounts": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "CreateNetworkConnectivityConfiguration", + "description": "Creates a network connectivity configuration (NCC), which provides stable Azure service\nsubnets when accessing your Azure Storage accounts. You can also use a network connectivity configuration to create\nDatabricks managed private endpoints so that Databricks serverless compute resources privately access your\nresources.\n\n**IMPORTANT**: After you create the network connectivity configuration, you must assign one or more workspaces to the new network connectivity configuration.\nYou can share one network connectivity configuration with multiple workspaces from the same Azure region within\nthe same Databricks account.\nSee [configure serverless secure connectivity](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security).", + "summary": "Create a network connectivity configuration.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateNetworkConnectivityConfigRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "network_connectivity_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateNetworkConnectivityConfiguration", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "network_connectivity_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateNetworkConnectivityConfiguration", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "network_connectivity_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateNetworkConnectivityConfiguration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "NetworkConnectivityConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateNetworkConnectivityConfiguration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens,\nand underscores. The length must be between 3 and 30 characters. The name must match the regular\nexpression ^[0-9a-zA-Z-_]{3,30}$", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "region", + "description": "The region for the network connectivity configuration.\nOnly workspaces in the same region can be attached to the network connectivity configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreatePrivateEndpointRule", + "description": "Create a private endpoint rule for the specified network connectivity config object.\nOnce the object is created, Databricks asynchronously provisions a new Azure private endpoint to your\nspecified Azure resource.\n\n**IMPORTANT**: You must use Azure portal or other Azure tools to approve the private endpoint to complete the\nconnection. To get the information of the private endpoint created, make a `GET` request on the new private\nendpoint rule. See [serverless private link](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link).", + "summary": "Create a private endpoint rule.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}/private-endpoint-rules", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePrivateEndpointRuleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreatePrivateEndpointRule", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreatePrivateEndpointRule", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreatePrivateEndpointRule", + "is_object": true + } + }, + "response": { + "pascal_name": "NccPrivateEndpointRule", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CreatePrivateEndpointRule", + "is_object": true + } + }, + { + "name": "domain_names", + "description": "Only used by private endpoints to customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "endpoint_service", + "description": "The full target AWS endpoint service name that connects to the destination resources of the private endpoint.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "error_message", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gcp_endpoint", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpEndpoint", + "is_object": true + } + }, + { + "name": "group_id", + "description": "Not used by customer-managed private endpoint services.\n\nThe sub-resource type (group ID) of the target resource.\nNote that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_id", + "description": "The Azure resource ID of the target resource.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "resource_names", + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteNetworkConnectivityConfiguration", + "description": "Deletes a network connectivity configuration.", + "summary": "Delete a network connectivity configuration.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteNetworkConnectivityConfigurationRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeletePrivateEndpointRule", + "description": "Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED,\nthe private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated\nand will be deleted after one day of deactivation. When a private endpoint is deactivated,\nthe `deactivated` field is set to `true` and the private endpoint is not\navailable to your serverless compute resources.", + "summary": "Delete a private endpoint rule.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}/private-endpoint-rules/{private_endpoint_rule_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePrivateEndpointRuleRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "NccPrivateEndpointRule", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetNetworkConnectivityConfiguration", + "description": "Gets a network connectivity configuration.", + "summary": "Get a network connectivity configuration.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetNetworkConnectivityConfigurationRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "NetworkConnectivityConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectivity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPrivateEndpointRule", + "description": "Gets the private endpoint rule.", + "summary": "Gets a private endpoint rule.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}/private-endpoint-rules/{private_endpoint_rule_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPrivateEndpointRuleRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "NccPrivateEndpointRule", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListNetworkConnectivityConfigurations", + "description": "Gets an array of network connectivity configurations.", + "summary": "List network connectivity configurations.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListNetworkConnectivityConfigurationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListNetworkConnectivityConfigurationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListPrivateEndpointRules", + "description": "Gets an array of private endpoint rules.", + "summary": "List private endpoint rules.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}/private-endpoint-rules", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPrivateEndpointRulesRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListPrivateEndpointRulesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "Your Network Connectvity Configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdatePrivateEndpointRule", + "description": "Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources is allowed to be updated.", + "summary": "Update a private endpoint rule.", + "path": "/api/2.0/accounts/{account_id}/network-connectivity-configs/{network_connectivity_config_id}/private-endpoint-rules/{private_endpoint_rule_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateNccPrivateEndpointRuleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "network_connectivity_config_id", + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdatePrivateEndpointRule", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_connectivity_config_id", + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdatePrivateEndpointRule", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdatePrivateEndpointRule", + "is_object": true + } + }, + "response": { + "pascal_name": "NccPrivateEndpointRule", + "is_object": true + }, + "all_fields": [ + { + "name": "network_connectivity_config_id", + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UpdatePrivateEndpointRule", + "is_object": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "domain_names", + "description": "Only used by private endpoints to customer-managed private endpoint services.\n\nDomain names of target private link service.\nWhen updating this field, the full list of target domain_names must be specified.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "enabled", + "description": "Update this field to activate/deactivate this private endpoint to allow egress access from\nserverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "error_message", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gcp_endpoint", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpEndpoint", + "is_object": true + } + }, + { + "name": "resource_names", + "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "network_connectivity_config_id", + "description": "The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_endpoint_rule_id", + "description": "Your private endpoint rule ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.NetworkPolicies", + "name": "NetworkPolicies", + "description": "These APIs manage network policies for this account. Network policies control which network destinations can be accessed from the Databricks environment. Each Databricks account includes a default policy named 'default-policy'. 'default-policy' is associated with any workspace lacking an explicit network policy assignment, and is automatically associated with each newly created workspace. 'default-policy' is reserved and cannot be deleted, but it can be updated to customize the default network access rules for your account.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "CreateNetworkPolicyRpc", + "description": "Creates a new network policy to manage which network destinations can be accessed from the Databricks\nenvironment.", + "summary": "Create a network policy.", + "path": "/api/2.0/accounts/{account_id}/network-policies", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateNetworkPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "network_policy", + "description": "Network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "network_policy", + "description": "Network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "network_policy", + "description": "Network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "network_policy", + "description": "Network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + }, + { + "name": "account_id", + "description": "The associated account ID for this Network Policy object.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "egress", + "description": "The network policies applying for egress traffic.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NetworkPolicyEgress", + "is_object": true + } + }, + { + "name": "ingress", + "description": "The network policies applying for ingress traffic.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CustomerFacingIngressNetworkPolicy", + "is_object": true + } + }, + { + "name": "ingress_dry_run", + "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CustomerFacingIngressNetworkPolicy", + "is_object": true + } + }, + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteNetworkPolicyRpc", + "description": "Deletes a network policy. Cannot be called on 'default-policy'.", + "summary": "Delete a network policy.", + "path": "/api/2.0/accounts/{account_id}/network-policies/{network_policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteNetworkPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to delete.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetNetworkPolicyRpc", + "description": "Gets a network policy.", + "summary": "Get a network policy.", + "path": "/api/2.0/accounts/{account_id}/network-policies/{network_policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetNetworkPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_policy_id", + "description": "The unique identifier of the network policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListNetworkPoliciesRpc", + "description": "Gets an array of network policies.", + "summary": "List network policies.", + "path": "/api/2.0/accounts/{account_id}/network-policies", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListNetworkPoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListNetworkPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateNetworkPolicyRpc", + "description": "Updates a network policy. This allows you to modify the configuration of a network policy.", + "summary": "Update a network policy.", + "path": "/api/2.0/accounts/{account_id}/network-policies/{network_policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateNetworkPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "network_policy", + "description": "Updated network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "network_policy", + "description": "Updated network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "network_policy", + "description": "Updated network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "network_policy", + "description": "Updated network policy configuration details.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccountNetworkPolicy", + "is_object": true + } + }, + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "account_id", + "description": "The associated account ID for this Network Policy object.", + "is_computed": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "egress", + "description": "The network policies applying for egress traffic.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NetworkPolicyEgress", + "is_object": true + } + }, + { + "name": "ingress", + "description": "The network policies applying for ingress traffic.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CustomerFacingIngressNetworkPolicy", + "is_object": true + } + }, + { + "name": "ingress_dry_run", + "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CustomerFacingIngressNetworkPolicy", + "is_object": true + } + }, + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_policy_id", + "description": "The unique identifier for the network policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "provisioning.Networks", + "name": "Networks", + "description": "These APIs manage network configurations for customer-managed VPCs (optional). Its ID is\nused when creating a new workspace if you use customer-managed VPCs.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a Databricks network configuration that represents an VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets.", + "summary": "Create network configuration.", + "path": "/api/2.0/accounts/{account_id}/networks", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateNetworkRequest", + "is_object": true + }, + "response": { + "pascal_name": "Network", + "is_object": true + }, + "all_fields": [ + { + "name": "gcp_network_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpNetworkInfo", + "is_object": true + } + }, + { + "name": "network_name", + "description": "The human-readable name of the network configuration.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "security_group_ids", + "description": "IDs of one to five security groups associated with this network. Security group IDs **cannot** be used in multiple network configurations.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "subnet_ids", + "description": "IDs of at least two subnets associated with this network. Subnet IDs **cannot** be used in multiple network configurations.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "vpc_endpoints", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "NetworkVpcEndpoints", + "is_object": true + } + }, + { + "name": "vpc_id", + "description": "The ID of the VPC associated with this network configuration. VPC IDs can be used in multiple networks.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.\n\nThis operation is available only if your account is on the E2 version of the platform.", + "summary": "Delete a network configuration.", + "path": "/api/2.0/accounts/{account_id}/networks/{network_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteNetworkRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Network", + "is_object": true + }, + "all_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Databricks network configuration, which represents a cloud VPC and its resources.", + "summary": "Get a network configuration.", + "path": "/api/2.0/accounts/{account_id}/networks/{network_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetNetworkRequest", + "is_object": true, + "required_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Network", + "is_object": true + }, + "all_fields": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "network_id", + "description": "Databricks Account API network configuration ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks network configurations for an account.", + "summary": "List network configurations.", + "path": "/api/2.0/accounts/{account_id}/networks", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListNetworksRequest", + "is_object": true + }, + "response": { + "pascal_name": "NetworkList", + "array_value": { + "pascal_name": "Network", + "is_object": true + } + } + } + ] + }, + { + "id": "settings.NotificationDestinations", + "name": "NotificationDestinations", + "description": "The notification destinations API lets you programmatically manage a workspace's notification destinations.\nNotification destinations are used to send notifications for query alerts and jobs to destinations outside of Databricks.\nOnly workspace admins can create, update, and delete notification destinations.", + "package": { + "name": "settings" + }, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListNotificationDestinationsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a notification destination. Requires workspace admin permissions.", + "summary": "Create a notification destination.", + "path": "/api/2.0/notification-destinations", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateNotificationDestinationRequest", + "is_object": true + }, + "response": { + "pascal_name": "NotificationDestination", + "is_object": true + }, + "all_fields": [ + { + "name": "config", + "description": "The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Config", + "is_object": true + } + }, + { + "name": "display_name", + "description": "The display name for the notification destination.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a notification destination. Requires workspace admin permissions.", + "summary": "Delete a notification destination.", + "path": "/api/2.0/notification-destinations/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteNotificationDestinationRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Empty", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a notification destination.", + "summary": "Get a notification destination.", + "path": "/api/2.0/notification-destinations/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetNotificationDestinationRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "NotificationDestination", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists notification destinations.", + "summary": "List notification destinations.", + "path": "/api/2.0/notification-destinations", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListNotificationDestinationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListNotificationDestinationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.", + "summary": "Update a notification destination.", + "path": "/api/2.0/notification-destinations/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateNotificationDestinationRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "UUID identifying notification destination.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "UUID identifying notification destination.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "NotificationDestination", + "is_object": true + }, + "all_fields": [ + { + "name": "config", + "description": "The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Config", + "is_object": true + } + }, + { + "name": "display_name", + "description": "The display name for the notification destination.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "UUID identifying notification destination.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "UUID identifying notification destination.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.OAuthPublishedApps", + "name": "OAuthPublishedApps", + "description": "These APIs enable administrators to view all the available published OAuth applications in Databricks.\nAdministrators can add the published OAuth applications to their account through the OAuth Published App Integration APIs.", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListOAuthPublishedAppsRequest" + } + }, + "methods": [ + { + "name": "List", + "description": "Get all the available published OAuth apps in Databricks.", + "summary": "Get all the published OAuth apps.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-apps", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListOAuthPublishedAppsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetPublishedAppsOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The max number of OAuth published apps to return in one page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A token that can be used to get the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A token that can be used to get the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "catalog.OnlineTables", + "name": "OnlineTables", + "description": "Online tables provide lower latency and higher QPS access to data from Delta tables.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Create", + "description": "Create a new Online Table.", + "summary": "Create an Online Table.", + "path": "/api/2.0/online-tables", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateOnlineTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table", + "description": "Specification of the online table to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineTable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "table", + "description": "Specification of the online table to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineTable", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "table", + "description": "Specification of the online table to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineTable", + "is_object": true + } + }, + "response": { + "pascal_name": "OnlineTable", + "is_object": true + }, + "all_fields": [ + { + "name": "table", + "description": "Specification of the online table to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "OnlineTable", + "is_object": true + } + }, + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Specification of the online table.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OnlineTableSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Online Table data synchronization status", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OnlineTableStatus", + "is_object": true + } + }, + { + "name": "table_serving_url", + "description": "Data serving REST API URL for this table", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "unity_catalog_provisioning_state", + "description": "The provisioning state of the online table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously).", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProvisioningInfoState", + "enum": [ + { + "content": "ACTIVE" + }, + { + "content": "DEGRADED" + }, + { + "content": "DELETING" + }, + { + "content": "FAILED" + }, + { + "content": "PROVISIONING" + }, + { + "content": "UPDATING" + } + ] + } + } + ], + "wait": { + "success": [ + { + "content": "ACTIVE" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "OnlineTable" + } + }, + "status_path": [ + { + "pascal_name": "UnityCatalogProvisioningState" + } + ] + } + }, + { + "name": "Delete", + "description": "Delete an online table.\nWarning: This will delete all the data in the online table. If the source Delta table was\ndeleted or modified since this Online Table was created, this will lose the data forever!", + "summary": "Delete an Online Table.", + "path": "/api/2.0/online-tables/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteOnlineTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get information about an existing online table and its status.", + "summary": "Get an Online Table.", + "path": "/api/2.0/online-tables/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetOnlineTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "OnlineTable", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full three-part (catalog, schema, table) name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.PermissionMigration", + "name": "PermissionMigration", + "description": "APIs for migrating acl permissions, used only by the ucx tool: https://github.com/databrickslabs/ucx", + "package": { + "name": "iam" + }, + "is_hidden_cli": true, + "docs_group": "iam", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "MigratePermissions", + "description": "Migrate Permissions.", + "summary": "Migrate Permissions.", + "path": "/api/2.0/permissionmigration", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "MigratePermissionsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "WorkspaceId of the associated workspace where the permission migration will occur.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "from_workspace_group_name", + "description": "The name of the workspace group that permissions will be migrated from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "to_account_group_name", + "description": "The name of the account group that permissions will be migrated to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_id", + "description": "WorkspaceId of the associated workspace where the permission migration will occur.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "from_workspace_group_name", + "description": "The name of the workspace group that permissions will be migrated from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "to_account_group_name", + "description": "The name of the account group that permissions will be migrated to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MigratePermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "from_workspace_group_name", + "description": "The name of the workspace group that permissions will be migrated from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "size", + "description": "The maximum number of permissions that will be migrated.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "to_account_group_name", + "description": "The name of the account group that permissions will be migrated to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "WorkspaceId of the associated workspace where the permission migration will occur.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "WorkspaceId of the associated workspace where the permission migration will occur.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "from_workspace_group_name", + "description": "The name of the workspace group that permissions will be migrated from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "to_account_group_name", + "description": "The name of the account group that permissions will be migrated to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.Permissions", + "name": "Permissions", + "description": "Permissions API are used to create read, write, edit, update and manage access for various users on different objects and endpoints.\n* **[Apps permissions](:service:apps)** — Manage which users can manage or use apps.\n* **[Cluster permissions](:service:clusters)** — Manage which users can manage, restart, or attach to clusters.\n* **[Cluster policy permissions](:service:clusterpolicies)** — Manage which users can use cluster policies.\n* **[Spark Declarative Pipelines permissions](:service:pipelines)** — Manage which users can view, manage, run, cancel, or own a Spark Declarative Pipeline.\n* **[Job permissions](:service:jobs)** — Manage which users can view, manage, trigger, cancel, or own a job.\n* **[MLflow experiment permissions](:service:experiments)** — Manage which users can read, edit, or manage MLflow experiments.\n* **[MLflow registered model permissions](:service:modelregistry)** — Manage which users can read, edit, or manage MLflow registered models.\n* **[Instance Pool permissions](:service:instancepools)** — Manage which users can manage or attach to pools.\n* **[Repo permissions](repos)** — Manage which users can read, run, edit, or manage a repo.\n* **[Serving endpoint permissions](:service:servingendpoints)** — Manage which users can view, query, or manage a serving endpoint.\n* **[SQL warehouse permissions](:service:warehouses)** — Manage which users can use or manage SQL warehouses.\n* **[Token permissions](:service:tokenmanagement)** — Manage which users can create or use tokens.\n* **[Workspace object permissions](:service:workspace)** — Manage which users can read, run, edit, or manage alerts, dbsql-dashboards, directories, files, notebooks and queries.\nFor the mapping of the required permissions for specific actions or abilities and other important information, see [Access Control](https://docs.databricks.com/security/auth-authz/access-control/index.html).\nNote that to manage access control on service principals, use **[Account Access Control Proxy](:service:accountaccesscontrolproxy)**.", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Get", + "description": "Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object.", + "summary": "Get object permissions.", + "path": "/api/2.0/permissions/{request_object_type}/{request_object_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPermissionRequest", + "is_object": true, + "required_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get object permission levels.", + "path": "/api/2.0/permissions/{request_object_type}/{request_object_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "request_object_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Set", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object.", + "summary": "Set object permissions.", + "path": "/api/2.0/permissions/{request_object_type}/{request_object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetObjectPermissions", + "is_object": true, + "required_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessControlRequestList", + "array_value": { + "pascal_name": "AccessControlRequest", + "is_object": true + } + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object.", + "summary": "Update object permissions.", + "path": "/api/2.0/permissions/{request_object_type}/{request_object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateObjectPermissions", + "is_object": true, + "required_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessControlRequestList", + "array_value": { + "pascal_name": "AccessControlRequest", + "is_object": true + } + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "request_object_type", + "description": "The type of the request object. Can be one of the following: alerts, alertsv2, authorization, clusters, cluster-policies, dashboards, database-projects, dbsql-dashboards, directories, experiments, files, genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_object_id", + "description": "The id of the request object.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.PersonalCompute", + "name": "PersonalCompute", + "description": "The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources.\nBy default all users in all workspaces have access (ON), but you can change the setting to instead let individual workspaces configure access control (DELEGATE).\n\nThere is only one instance of this setting per account.\nSince this setting has a default value, this setting is present on all accounts even though it's never set on a given account.\nDeletion reverts the value of the setting back to the default value.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_parent": true, + "is_hidden_cli": true, + "docs_group": "settings", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "parent_service_id": "settings.AccountSettings", + "methods": [ + { + "name": "Delete", + "description": "Reverts back the Personal Compute setting value to default (ON)", + "summary": "Delete Personal Compute setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/dcp_acct_enable/names/default", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeletePersonalComputeSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeletePersonalComputeSettingResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the value of the Personal Compute setting.", + "summary": "Get Personal Compute setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/dcp_acct_enable/names/default", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetPersonalComputeSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "PersonalComputeSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "personal_compute", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "personal_compute", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the value of the Personal Compute setting.", + "summary": "Update Personal Compute setting.", + "path": "/api/2.0/accounts/{account_id}/settings/types/dcp_acct_enable/names/default", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdatePersonalComputeSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PersonalComputeSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "personal_compute", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "personal_compute", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalComputeSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "pipelines.Pipelines", + "name": "Pipelines", + "description": "The Lakeflow Spark Declarative Pipelines API allows you to create, edit, delete, start, and view details about pipelines.\n\nSpark Declarative Pipelines is a framework for building reliable, maintainable, and testable data processing pipelines. You define the transformations to perform on your data, and Spark Declarative Pipelines manages task orchestration, cluster management, monitoring, data quality, and error handling.\n\nInstead of defining your data pipelines using a series of separate Apache Spark tasks, Spark Declarative Pipelines manages how your data is transformed based on a target schema you define for each processing step. You can also enforce data quality with Spark Declarative Pipelines expectations. Expectations allow you to define expected data quality and specify how to handle records that fail those expectations.", + "package": { + "name": "pipelines" + }, + "docs_group": "lakeflow", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "PipelineStateInfoNameToPipelineIdMap" + }, + "request": { + "pascal_name": "ListPipelinesRequest" + } + }, + "methods": [ + { + "name": "ApplyEnvironment", + "description": "*\nApplies the current pipeline environment onto the pipeline compute. The environment applied can be used by subsequent\ndev-mode updates.", + "summary": "Apply the latest environment to the pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}/environment/apply", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ApplyEnvironmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ApplyEnvironmentRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Clone", + "description": "Creates a new pipeline using Unity Catalog from a pipeline using Hive Metastore.\nThis method returns the ID of the newly created clone.\nAdditionally, this method starts an update for the newly created pipeline.", + "summary": "Clone a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}/clone", + "can_use_json": true, + "must_use_json": true, + "is_json_only": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ClonePipelineRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "Source pipeline to clone from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "Source pipeline to clone from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ClonePipelineResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "allow_duplicate_names", + "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "budget_policy_id", + "description": "Budget policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "channel", + "description": "SDP Release Channel that specifies which version to use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "clone_mode", + "description": "The type of clone to perform. Currently, only deep copies are supported", + "is_request_body_field": true, + "entity": { + "pascal_name": "CloneMode", + "enum": [ + { + "content": "MIGRATE_TO_UC" + } + ] + } + }, + { + "name": "clusters", + "description": "Cluster settings for this pipeline deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineClusterList", + "array_value": { + "pascal_name": "PipelineCluster", + "is_object": true + } + } + }, + { + "name": "configuration", + "description": "String-String configuration for this pipeline execution.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "continuous", + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "deployment", + "description": "Deployment type of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineDeployment", + "is_object": true + } + }, + { + "name": "development", + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "edition", + "description": "Pipeline product edition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "environment", + "description": "Environment specification for this pipeline used to install dependencies.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelinesEnvironment", + "is_object": true + } + }, + { + "name": "event_log", + "description": "Event log configuration for this pipeline", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EventLogSpec", + "is_object": true + } + }, + { + "name": "expected_last_modified", + "description": "If present, the last-modified time of the pipeline settings before the clone.\nIf the settings were modified after that time, then the request will fail with\na conflict.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "filters", + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Filters", + "is_object": true + } + }, + { + "name": "gateway_definition", + "description": "The definition of a gateway pipeline to support change data capture.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionGatewayPipelineDefinition", + "is_object": true + } + }, + { + "name": "id", + "description": "Unique identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ingestion_definition", + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionPipelineDefinition", + "is_object": true + } + }, + { + "name": "libraries", + "description": "Libraries or code needed by this deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineLibraryList", + "array_value": { + "pascal_name": "PipelineLibrary", + "is_object": true + } + } + }, + { + "name": "name", + "description": "Friendly identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notifications", + "description": "List of notification settings for this pipeline.", + "is_request_body_field": true, + "entity": { + "pascal_name": "NotificationsList", + "array_value": { + "pascal_name": "Notifications", + "is_object": true + } + } + }, + { + "name": "photon", + "description": "Whether Photon is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "pipeline_id", + "description": "Source pipeline to clone from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "restart_window", + "description": "Restart window of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestartWindow", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema", + "description": "The default schema (database) where tables are read from or published to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serverless", + "description": "Whether serverless compute is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "storage", + "description": "DBFS root directory for storing checkpoints and tables.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "target", + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "trigger", + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineTrigger", + "is_object": true + } + }, + { + "name": "usage_policy_id", + "description": "Usage policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "Source pipeline to clone from", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Creates a new data processing pipeline based on the requested configuration. If successful, this method returns\nthe ID of the new pipeline.", + "summary": "Create a pipeline.", + "path": "/api/2.0/pipelines", + "can_use_json": true, + "must_use_json": true, + "is_json_only": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePipeline", + "is_object": true + }, + "response": { + "pascal_name": "CreatePipelineResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "allow_duplicate_names", + "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "budget_policy_id", + "description": "Budget policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "channel", + "description": "SDP Release Channel that specifies which version to use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "clusters", + "description": "Cluster settings for this pipeline deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineClusterList", + "array_value": { + "pascal_name": "PipelineCluster", + "is_object": true + } + } + }, + { + "name": "configuration", + "description": "String-String configuration for this pipeline execution.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "continuous", + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "deployment", + "description": "Deployment type of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineDeployment", + "is_object": true + } + }, + { + "name": "development", + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "dry_run", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "edition", + "description": "Pipeline product edition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "environment", + "description": "Environment specification for this pipeline used to install dependencies.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelinesEnvironment", + "is_object": true + } + }, + { + "name": "event_log", + "description": "Event log configuration for this pipeline", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EventLogSpec", + "is_object": true + } + }, + { + "name": "filters", + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Filters", + "is_object": true + } + }, + { + "name": "gateway_definition", + "description": "The definition of a gateway pipeline to support change data capture.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionGatewayPipelineDefinition", + "is_object": true + } + }, + { + "name": "id", + "description": "Unique identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ingestion_definition", + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionPipelineDefinition", + "is_object": true + } + }, + { + "name": "libraries", + "description": "Libraries or code needed by this deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineLibraryList", + "array_value": { + "pascal_name": "PipelineLibrary", + "is_object": true + } + } + }, + { + "name": "name", + "description": "Friendly identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notifications", + "description": "List of notification settings for this pipeline.", + "is_request_body_field": true, + "entity": { + "pascal_name": "NotificationsList", + "array_value": { + "pascal_name": "Notifications", + "is_object": true + } + } + }, + { + "name": "parameters", + "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "photon", + "description": "Whether Photon is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "restart_window", + "description": "Restart window of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestartWindow", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RunAs", + "is_object": true + } + }, + { + "name": "schema", + "description": "The default schema (database) where tables are read from or published to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serverless", + "description": "Whether serverless compute is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "storage", + "description": "DBFS root directory for storing checkpoints and tables.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "target", + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "trigger", + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineTrigger", + "is_object": true + } + }, + { + "name": "usage_policy_id", + "description": "Usage policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a pipeline. If the pipeline publishes to Unity Catalog, pipeline deletion will cascade to\nall pipeline tables. Please reach out to Databricks support for assistance to undo this action.", + "summary": "Delete a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePipelineRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeletePipelineResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cascade", + "description": "If false, pipeline deletion will not cascade to its datasets (MVs, STs, Views).\nBy default, this parameter will be true and all tables will be deleted with the pipeline.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "force", + "description": "If true, deletion will proceed even if resource cleanup fails.\nBy default, deletion will fail if resources cleanup is required but fails.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a pipeline.", + "summary": "Get a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPipelineRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPipelineResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get pipeline permission levels.", + "path": "/api/2.0/permissions/pipelines/{pipeline_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPipelinePermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPipelinePermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a pipeline. Pipelines can inherit permissions from their root object.", + "summary": "Get pipeline permissions.", + "path": "/api/2.0/permissions/pipelines/{pipeline_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPipelinePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PipelinePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetUpdate", + "description": "Gets an update from an active pipeline.", + "summary": "Get a pipeline update.", + "path": "/api/2.0/pipelines/{pipeline_id}/updates/{update_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetUpdateRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The ID of the pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_id", + "description": "The ID of the update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The ID of the pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_id", + "description": "The ID of the update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetUpdateResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "description": "The ID of the pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_id", + "description": "The ID of the update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The ID of the pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_id", + "description": "The ID of the update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListPipelineEvents", + "description": "Retrieves events for a pipeline.", + "summary": "List pipeline events.", + "path": "/api/2.0/pipelines/{pipeline_id}/events", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPipelineEventsRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline to return events for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline to return events for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListPipelineEventsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "Criteria to select a subset of results, expressed using a SQL-like syntax.\nThe supported filters are:\n1. level='INFO' (or WARN or ERROR)\n2. level in ('INFO', 'WARN')\n3. id='[event-id]'\n4. timestamp \u003e 'TIMESTAMP' (or \u003e=,\u003c,\u003c=,=)\n\nComposite expressions are supported, for example: level in ('ERROR', 'WARN')\nAND timestamp\u003e '2021-07-22T06:37:33.083Z'", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Max number of entries to return in a single page. The system may return\nfewer than max_results events in a response, even if there are more events\navailable.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "order_by", + "description": "A string indicating a sort order by timestamp for the results, for example, [\"timestamp asc\"].\nThe sort order can be ascending or descending. By default, events are returned\nin descending order by timestamp.", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Page token returned by previous call. This field is mutually\nexclusive with all fields in this request except max_results. An error is\nreturned if any fields other than max_results are set when this field is set.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "pipeline_id", + "description": "The pipeline to return events for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline to return events for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token returned by previous call. This field is mutually\nexclusive with all fields in this request except max_results. An error is\nreturned if any fields other than max_results are set when this field is set.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListPipelines", + "description": "Lists pipelines defined in the Spark Declarative Pipelines system.", + "summary": "List pipelines.", + "path": "/api/2.0/pipelines", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPipelinesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListPipelinesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "Select a subset of results based on the specified criteria.\nThe supported filters are:\n\n* `notebook='\u003cpath\u003e'` to select pipelines that reference the provided notebook path.\n* `name LIKE '[pattern]'` to select pipelines with a name that matches pattern.\nWildcards are supported, for example: `name LIKE '%shopping%'`\n\nComposite filters are not supported. This field is optional.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "The maximum number of entries to return in a single page. The system may\nreturn fewer than max_results events in a response, even if there are\nmore events available. This field is optional. The default value is 25.\nThe maximum value is 100. An error is returned if the value of max_results\nis greater than 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "order_by", + "description": "A list of strings specifying the order of results.\nSupported order_by fields are id and name. The default is id asc.\nThis field is optional.", + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "page_token", + "description": "Page token returned by previous call", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token returned by previous call", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListUpdates", + "description": "List updates for an active pipeline.", + "summary": "List pipeline updates.", + "path": "/api/2.0/pipelines/{pipeline_id}/updates", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListUpdatesRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline to return updates for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline to return updates for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListUpdatesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Max number of entries to return in a single page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token returned by previous call", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "pipeline_id", + "description": "The pipeline to return updates for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "until_update_id", + "description": "If present, returns updates until and including this update_id.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline to return updates for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set pipeline permissions.", + "path": "/api/2.0/permissions/pipelines/{pipeline_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PipelinePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PipelinePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineAccessControlRequestList", + "array_value": { + "pascal_name": "PipelineAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "StartUpdate", + "description": "Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running.", + "summary": "Start a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}/updates", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StartUpdate", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StartUpdateResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cause", + "is_request_body_field": true, + "entity": { + "pascal_name": "StartUpdateCause", + "enum": [ + { + "content": "API_CALL" + }, + { + "content": "INFRASTRUCTURE_MAINTENANCE" + }, + { + "content": "JOB_TASK" + }, + { + "content": "RETRY_ON_FAILURE" + }, + { + "content": "SCHEMA_CHANGE" + }, + { + "content": "SERVICE_UPGRADE" + }, + { + "content": "USER_ACTION" + } + ] + } + }, + { + "name": "full_refresh", + "description": "If true, this update will reset all tables before running.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "full_refresh_selection", + "description": "A list of tables to update with fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "parameters", + "description": "Key/value map of parameters to pass to the pipeline execution", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_selection", + "description": "A list of tables to update without fullRefresh. If both refresh_selection and\nfull_refresh_selection are empty, this is a full graph update. Full Refresh on a table means\nthat the states of the table will be reset before the refresh.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "replace_where_overrides", + "description": "A list of predicate overrides for replace_where flows in this update.\nOnly replace_where flows may be specified. Flows not listed use their original predicate.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ReplaceWhereOverrideList", + "array_value": { + "pascal_name": "ReplaceWhereOverride", + "is_object": true + } + } + }, + { + "name": "reset_checkpoint_selection", + "description": "A list of flows for which this update should reset the streaming checkpoint. This selection will not clear\nthe data in the flow's target table. Flows in this list may also appear in refresh_selection and full_refresh_selection.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "rewind_spec", + "description": "The information about the requested rewind operation.\nIf specified this is a rewind mode update.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RewindSpec", + "is_object": true + } + }, + { + "name": "validate_only", + "description": "If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Stop", + "description": "Stops the pipeline by canceling the active update. If there is no active update for the pipeline, this request is a no-op.", + "summary": "Stop a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}/stop", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StopRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StopPipelineResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "IDLE" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "GetPipelineResponse" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Cause" + } + ], + "message_path_head": { + "pascal_name": "Cause" + } + } + }, + { + "name": "Update", + "description": "Updates a pipeline with the supplied configuration.", + "summary": "Edit a pipeline.", + "path": "/api/2.0/pipelines/{pipeline_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EditPipeline", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "Unique identifier for this pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "Unique identifier for this pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditPipelineResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "allow_duplicate_names", + "description": "If false, deployment will fail if name has changed and conflicts the name of another pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "budget_policy_id", + "description": "Budget policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "channel", + "description": "SDP Release Channel that specifies which version to use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "clusters", + "description": "Cluster settings for this pipeline deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineClusterList", + "array_value": { + "pascal_name": "PipelineCluster", + "is_object": true + } + } + }, + { + "name": "configuration", + "description": "String-String configuration for this pipeline execution.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "continuous", + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "deployment", + "description": "Deployment type of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineDeployment", + "is_object": true + } + }, + { + "name": "development", + "description": "Whether the pipeline is in Development mode. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "edition", + "description": "Pipeline product edition.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "environment", + "description": "Environment specification for this pipeline used to install dependencies.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelinesEnvironment", + "is_object": true + } + }, + { + "name": "event_log", + "description": "Event log configuration for this pipeline", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EventLogSpec", + "is_object": true + } + }, + { + "name": "expected_last_modified", + "description": "If present, the last-modified time of the pipeline settings before the edit.\nIf the settings were modified after that time, then the request will fail with\na conflict.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "filters", + "description": "Filters on which Pipeline packages to include in the deployed graph.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Filters", + "is_object": true + } + }, + { + "name": "gateway_definition", + "description": "The definition of a gateway pipeline to support change data capture.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionGatewayPipelineDefinition", + "is_object": true + } + }, + { + "name": "id", + "description": "Unique identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ingestion_definition", + "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IngestionPipelineDefinition", + "is_object": true + } + }, + { + "name": "libraries", + "description": "Libraries or code needed by this deployment.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineLibraryList", + "array_value": { + "pascal_name": "PipelineLibrary", + "is_object": true + } + } + }, + { + "name": "name", + "description": "Friendly identifier for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notifications", + "description": "List of notification settings for this pipeline.", + "is_request_body_field": true, + "entity": { + "pascal_name": "NotificationsList", + "array_value": { + "pascal_name": "Notifications", + "is_object": true + } + } + }, + { + "name": "parameters", + "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "photon", + "description": "Whether Photon is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "pipeline_id", + "description": "Unique identifier for this pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "restart_window", + "description": "Restart window of this pipeline.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestartWindow", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RunAs", + "is_object": true + } + }, + { + "name": "schema", + "description": "The default schema (database) where tables are read from or published to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "serverless", + "description": "Whether serverless compute is enabled for this pipeline.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "storage", + "description": "DBFS root directory for storing checkpoints and tables.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "target", + "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "trigger", + "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PipelineTrigger", + "is_object": true + } + }, + { + "name": "usage_policy_id", + "description": "Usage policy of this pipeline.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "Unique identifier for this pipeline.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a pipeline. Pipelines can inherit permissions from their root object.", + "summary": "Update pipeline permissions.", + "path": "/api/2.0/permissions/pipelines/{pipeline_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PipelinePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PipelinePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "PipelineAccessControlRequestList", + "array_value": { + "pascal_name": "PipelineAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "pipeline_id", + "description": "The pipeline for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.Policies", + "name": "Policies", + "description": "Attribute-Based Access Control (ABAC) provides high leverage governance for enforcing compliance policies in Unity Catalog. With ABAC policies, access is controlled in a hierarchical and scalable manner, based on data attributes rather than specific resources, enabling more flexible and comprehensive access control. ABAC policies in Unity Catalog support conditions on securable properties, governance tags, and environment contexts. Callers must have the `MANAGE` privilege on a securable to view, create, update, or delete ABAC policies.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListPoliciesRequest" + } + }, + "methods": [ + { + "name": "CreatePolicy", + "description": "Creates a new policy on a securable.\nThe new policy applies to the securable and all its descendants.", + "summary": "Create an ABAC policy.", + "path": "/api/2.1/unity-catalog/policies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "policy_info", + "description": "Required. The policy to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy_info", + "description": "Required. The policy to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy_info", + "description": "Required. The policy to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "policy_info", + "description": "Required. The policy to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + } + }, + { + "name": "column_mask", + "description": "Options for column mask policies. Valid only if `policy_type` is `POLICY_TYPE_COLUMN_MASK`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ColumnMaskOptions", + "is_object": true + } + }, + { + "name": "comment", + "description": "Optional description of the policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Time at which the policy was created, in epoch milliseconds. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "Username of the user who created the policy. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "except_principals", + "description": "Optional list of user or group names that should be excluded from the policy.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "id", + "description": "Unique identifier of the policy. This field is output only and is generated by the system.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "match_columns", + "description": "Optional list of condition expressions used to match table columns.\nOnly valid when `for_securable_type` is `TABLE`.\nWhen specified, the policy only applies to tables whose columns satisfy all match conditions.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MatchColumnList", + "array_value": { + "pascal_name": "MatchColumn", + "is_object": true + } + } + }, + { + "name": "name", + "description": "Name of the policy. Required on create and optional on update.\nTo rename the policy, set `name` to a different value on update.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Full name of the securable on which the policy is defined.\nRequired on create.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Type of the securable on which the policy is defined.\nOnly `CATALOG`, `SCHEMA` and `TABLE` are supported at this moment.\nRequired on create.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + }, + { + "name": "row_filter", + "description": "Options for row filter policies. Valid only if `policy_type` is `POLICY_TYPE_ROW_FILTER`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RowFilterOptions", + "is_object": true + } + }, + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "updated_at", + "description": "Time at which the policy was last modified, in epoch milliseconds. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "updated_by", + "description": "Username of the user who last modified the policy. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "when_condition", + "description": "Optional condition when the policy should take effect.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + }, + { + "name": "DeletePolicy", + "description": "Delete an ABAC policy defined on a securable.", + "summary": "Delete an ABAC policy.", + "path": "/api/2.1/unity-catalog/policies/{on_securable_type}/{on_securable_fullname}/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeletePolicyResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The name of the policy to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Required. The type of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to delete the policy from.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to delete", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPolicy", + "description": "Get the policy definition on a securable", + "summary": "Get an ABAC policy.", + "path": "/api/2.1/unity-catalog/policies/{on_securable_type}/{on_securable_fullname}/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to retrieve the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to retrieve policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to retrieve the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to retrieve policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The name of the policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to retrieve policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Required. The type of the securable to retrieve the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to retrieve the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to retrieve policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to retrieve.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListPolicies", + "description": "List all policies defined on a securable.\nOptionally, the list can include inherited policies defined on the securable's parent schema or catalog.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List ABAC policies.", + "path": "/api/2.1/unity-catalog/policies/{on_securable_type}/{on_securable_fullname}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPoliciesRequest", + "is_object": true, + "required_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_inherited", + "description": "Optional. Whether to include policies defined on parent securables.\nBy default, the inherited policies are not included.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Optional. Maximum number of policies to return on a single page (page length).\n- When not set or set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Required. The type of the securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Optional. Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of securable to list policies for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Optional. Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdatePolicy", + "description": "Update an ABAC policy on a securable.", + "summary": "Update an ABAC policy.", + "path": "/api/2.1/unity-catalog/policies/{on_securable_type}/{on_securable_fullname}/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdatePolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_info", + "description": "Optional fields to update. This is the request body for updating a policy.\nUse `update_mask` field to specify which fields in the request is to be updated.\n- If `update_mask` is empty or \"*\", all specified fields will be updated.\n- If `update_mask` is specified, only the fields specified in the `update_mask` will be updated.\nIf a field is specified in `update_mask` and not set in the request, the field will be cleared.\nUsers can use the update mask to explicitly unset optional fields such as\n`exception_principals` and `when_condition`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy_info", + "description": "Optional fields to update. This is the request body for updating a policy.\nUse `update_mask` field to specify which fields in the request is to be updated.\n- If `update_mask` is empty or \"*\", all specified fields will be updated.\n- If `update_mask` is specified, only the fields specified in the `update_mask` will be updated.\nIf a field is specified in `update_mask` and not set in the request, the field will be cleared.\nUsers can use the update mask to explicitly unset optional fields such as\n`exception_principals` and `when_condition`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy_info", + "description": "Optional fields to update. This is the request body for updating a policy.\nUse `update_mask` field to specify which fields in the request is to be updated.\n- If `update_mask` is empty or \"*\", all specified fields will be updated.\n- If `update_mask` is specified, only the fields specified in the `update_mask` will be updated.\nIf a field is specified in `update_mask` and not set in the request, the field will be cleared.\nUsers can use the update mask to explicitly unset optional fields such as\n`exception_principals` and `when_condition`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The name of the policy to update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Required. The type of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_info", + "description": "Optional fields to update. This is the request body for updating a policy.\nUse `update_mask` field to specify which fields in the request is to be updated.\n- If `update_mask` is empty or \"*\", all specified fields will be updated.\n- If `update_mask` is specified, only the fields specified in the `update_mask` will be updated.\nIf a field is specified in `update_mask` and not set in the request, the field will be cleared.\nUsers can use the update mask to explicitly unset optional fields such as\n`exception_principals` and `when_condition`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + } + }, + { + "name": "update_mask", + "description": "Optional. The update mask field for specifying user intentions on which\nfields to update in the request.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "column_mask", + "description": "Options for column mask policies. Valid only if `policy_type` is `POLICY_TYPE_COLUMN_MASK`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ColumnMaskOptions", + "is_object": true + } + }, + { + "name": "comment", + "description": "Optional description of the policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Time at which the policy was created, in epoch milliseconds. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "Username of the user who created the policy. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "except_principals", + "description": "Optional list of user or group names that should be excluded from the policy.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "id", + "description": "Unique identifier of the policy. This field is output only and is generated by the system.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "match_columns", + "description": "Optional list of condition expressions used to match table columns.\nOnly valid when `for_securable_type` is `TABLE`.\nWhen specified, the policy only applies to tables whose columns satisfy all match conditions.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MatchColumnList", + "array_value": { + "pascal_name": "MatchColumn", + "is_object": true + } + } + }, + { + "name": "name", + "description": "Name of the policy. Required on create and optional on update.\nTo rename the policy, set `name` to a different value on update.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Full name of the securable on which the policy is defined.\nRequired on create.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_type", + "description": "Type of the securable on which the policy is defined.\nOnly `CATALOG`, `SCHEMA` and `TABLE` are supported at this moment.\nRequired on create.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + }, + { + "name": "row_filter", + "description": "Options for row filter policies. Valid only if `policy_type` is `POLICY_TYPE_ROW_FILTER`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RowFilterOptions", + "is_object": true + } + }, + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "updated_at", + "description": "Time at which the policy was last modified, in epoch milliseconds. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "updated_by", + "description": "Username of the user who last modified the policy. Output only.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "when_condition", + "description": "Optional condition when the policy should take effect.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "on_securable_type", + "description": "Required. The type of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "on_securable_fullname", + "description": "Required. The fully qualified name of the securable to update the policy for.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Required. The name of the policy to update.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "to_principals", + "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "for_securable_type", + "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SecurableType", + "enum": [ + { + "content": "CATALOG" + }, + { + "content": "CLEAN_ROOM" + }, + { + "content": "CONNECTION" + }, + { + "content": "CREDENTIAL" + }, + { + "content": "EXTERNAL_LOCATION" + }, + { + "content": "EXTERNAL_METADATA" + }, + { + "content": "FUNCTION" + }, + { + "content": "METASTORE" + }, + { + "content": "PIPELINE" + }, + { + "content": "PROVIDER" + }, + { + "content": "RECIPIENT" + }, + { + "content": "SCHEMA" + }, + { + "content": "SHARE" + }, + { + "content": "STAGING_TABLE" + }, + { + "content": "STORAGE_CREDENTIAL" + }, + { + "content": "TABLE" + }, + { + "content": "VOLUME" + } + ] + } + }, + { + "name": "policy_type", + "description": "Type of the policy. Required on create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PolicyType", + "enum": [ + { + "content": "POLICY_TYPE_COLUMN_MASK" + }, + { + "content": "POLICY_TYPE_ROW_FILTER" + } + ] + } + } + ] + } + ] + }, + { + "id": "compute.PolicyComplianceForClusters", + "name": "PolicyComplianceForClusters", + "description": "The policy compliance APIs allow you to view and manage the policy compliance status\nof clusters in your workspace.\n\nA cluster is compliant with its policy if its configuration satisfies all its policy rules.\nClusters could be out of compliance if their policy was updated after the cluster was last edited.\n\nThe get and list compliance APIs allow you to view the policy compliance status of a cluster.\nThe enforce compliance API allows you to update a cluster to be compliant with the current version\nof its policy.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "EnforceCompliance", + "description": "Updates a cluster to be compliant with the current version of its policy.\nA cluster can be updated if it is in a `RUNNING` or `TERMINATED` state.\n\nIf a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes can take effect.\n\nIf a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`.\nThe next time the cluster is started, the new attributes will take effect.\n\nClusters created by the Databricks Jobs, SDP, or Models services cannot be enforced by this API.\nInstead, use the \"Enforce job policy compliance\" API to enforce policy compliance on jobs.", + "summary": "Enforce cluster policy compliance.", + "path": "/api/2.0/policies/clusters/enforce-compliance", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EnforceClusterComplianceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnforceClusterComplianceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "validate_only", + "description": "If set, previews the changes that would be made to a cluster\nto enforce compliance but does not update the cluster.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The ID of the cluster you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCompliance", + "description": "Returns the policy compliance status of a cluster. Clusters could be out\nof compliance if their policy was updated after the cluster was last edited.", + "summary": "Get cluster policy compliance.", + "path": "/api/2.0/policies/clusters/get-compliance", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetClusterComplianceRequest", + "is_object": true, + "required_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to get the compliance status", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to get the compliance status", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetClusterComplianceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to get the compliance status", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "cluster_id", + "description": "The ID of the cluster to get the compliance status", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListCompliance", + "description": "Returns the policy compliance status of all clusters that use a\ngiven policy. Clusters could be out of compliance if their policy was\nupdated after the cluster was last edited.", + "summary": "List cluster policy compliance.", + "path": "/api/2.0/policies/clusters/list-compliance", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListClusterCompliancesRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListClusterCompliancesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "jobs.PolicyComplianceForJobs", + "name": "PolicyComplianceForJobs", + "description": "The compliance APIs allow you to view and manage the policy compliance status of jobs\nin your workspace. This API currently only supports compliance controls for cluster policies.\n\nA job is in compliance if its cluster configurations satisfy the rules of all their respective\ncluster policies. A job could be out of compliance if a cluster policy it uses was updated after\nthe job was last edited. The job is considered out of compliance if any of its clusters no longer\ncomply with their updated policies.\n\nThe get and list compliance APIs allow you to view the policy compliance status of a job.\nThe enforce compliance API allows you to update a job so that it becomes compliant with all of its policies.", + "package": { + "name": "jobs" + }, + "docs_group": "lakeflow", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "EnforceCompliance", + "description": "Updates a job so the job clusters that are created when running\nthe job (specified in `new_cluster`) are compliant with the\ncurrent versions of their respective cluster policies.\nAll-purpose clusters used in the job will not be updated.", + "summary": "Enforce job policy compliance.", + "path": "/api/2.0/policies/jobs/enforce-compliance", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EnforcePolicyComplianceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "job_id", + "description": "The ID of the job you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "job_id", + "description": "The ID of the job you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "EnforcePolicyComplianceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The ID of the job you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "validate_only", + "description": "If set, previews changes made to the job to comply with its policy, but\ndoes not update the job.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The ID of the job you want to enforce policy compliance on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetCompliance", + "description": "Returns the policy compliance status of a job. Jobs could be out of\ncompliance if a cluster policy they use was updated after the job was\nlast edited and some of its job clusters no longer comply with\ntheir updated policies.", + "summary": "Get job policy compliance.", + "path": "/api/2.0/policies/jobs/get-compliance", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPolicyComplianceRequest", + "is_object": true, + "required_fields": [ + { + "name": "job_id", + "description": "The ID of the job whose compliance status you are requesting.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "job_id", + "description": "The ID of the job whose compliance status you are requesting.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "GetPolicyComplianceResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "job_id", + "description": "The ID of the job whose compliance status you are requesting.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "job_id", + "description": "The ID of the job whose compliance status you are requesting.", + "required": true, + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ListCompliance", + "description": "Returns the policy compliance status of all jobs that use a\ngiven policy. Jobs could be out of compliance if a cluster policy they\nuse was updated after the job was last edited and its job\nclusters no longer comply with the updated policy.", + "summary": "List job policy compliance.", + "path": "/api/2.0/policies/jobs/list-compliance", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListJobComplianceRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListJobComplianceForPolicyResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_id", + "description": "Canonical unique identifier for the cluster policy.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "compute.PolicyFamilies", + "name": "PolicyFamilies", + "description": "View available policy families. A policy family contains a policy definition providing best\npractices for configuring clusters for a particular use case.\n\nDatabricks manages and provides policy families for several common cluster use cases. You\ncannot create, edit, or delete policy families.\n\nPolicy families cannot be used directly to create clusters. Instead, you create cluster\npolicies using a policy family. Cluster policies created using a policy family inherit the\npolicy family's policy definition.", + "package": { + "name": "compute" + }, + "docs_group": "compute", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListPolicyFamiliesRequest" + } + }, + "methods": [ + { + "name": "Get", + "description": "Retrieve the information for an policy family based on its identifier and version", + "summary": "Get policy family information.", + "path": "/api/2.0/policy-families/{policy_family_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPolicyFamilyRequest", + "is_object": true, + "required_fields": [ + { + "name": "policy_family_id", + "description": "The family ID about which to retrieve information.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "policy_family_id", + "description": "The family ID about which to retrieve information.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PolicyFamily", + "is_object": true + }, + "all_fields": [ + { + "name": "policy_family_id", + "description": "The family ID about which to retrieve information.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "The version number for the family to fetch. Defaults to the latest version.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "policy_family_id", + "description": "The family ID about which to retrieve information.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Returns the list of policy definition types available to use at their latest version. This API is paginated.", + "summary": "List policy families.", + "path": "/api/2.0/policy-families", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPolicyFamiliesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListPolicyFamiliesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of policy families to return.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "page_token", + "description": "A token that can be used to get the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A token that can be used to get the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "postgres.Postgres", + "name": "Postgres", + "description": "Use the Postgres API to create and manage Lakebase Autoscaling Postgres infrastructure, including projects, branches, compute endpoints, and roles.\n\nThis API manages database infrastructure only. To query or modify data, use the Data API or direct SQL connections.\n\n**About resource IDs and names**\n\nResources are identified by hierarchical resource names like `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`. The `name` field on each resource contains this full path and is output-only. Note that `name` refers to this resource path, not the user-visible `display_name`.", + "package": { + "name": "postgres" + }, + "docs_group": "postgres", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListBranchesRequest" + } + }, + "methods": [ + { + "name": "CreateBranch", + "description": "Creates a new database branch in the project.", + "summary": "Create a Branch.", + "path": "/api/2.0/postgres/{parent=projects/*}/branches", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateBranchRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The Project where this Branch will be created.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "branch", + "description": "The Branch to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + { + "name": "branch_id", + "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `development` becomes `projects/my-app/branches/development`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Project where this Branch will be created.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "branch_id", + "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `development` becomes `projects/my-app/branches/development`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "branch", + "description": "The Branch to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "branch", + "description": "The Branch to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "branch", + "description": "The Branch to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + { + "name": "branch_id", + "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `development` becomes `projects/my-app/branches/development`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Project where this Branch will be created.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "replace_existing", + "description": "If true, update the branch if it already exists instead of returning an error.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the branch was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The project containing this branch (API resource hierarchy).\nFormat: projects/{project_id}\n\nNote: This field indicates where the branch exists in the resource hierarchy.\nFor point-in-time branching from another branch, see `status.source_branch`.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the branch configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BranchSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The current status of a Branch.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BranchStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the branch.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the branch was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Project where this Branch will be created.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "branch_id", + "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `development` becomes `projects/my-app/branches/development`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateCatalog", + "description": "Register a Postgres database in the Unity Catalog.", + "summary": "Register a Database in UC.", + "path": "/api/2.0/postgres/catalogs", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateCatalogRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Catalog", + "is_object": true + } + }, + { + "name": "catalog_id", + "description": "The ID in the Unity Catalog.\nIt becomes the full resource name, for example \"my_catalog\" becomes \"catalogs/my_catalog\".", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_id", + "description": "The ID in the Unity Catalog.\nIt becomes the full resource name, for example \"my_catalog\" becomes \"catalogs/my_catalog\".", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Catalog", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Catalog", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Catalog", + "is_object": true + } + }, + { + "name": "catalog_id", + "description": "The ID in the Unity Catalog.\nIt becomes the full resource name, for example \"my_catalog\" becomes \"catalogs/my_catalog\".", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the catalog was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the catalog.\n\nFormat: \"catalogs/{catalog_id}\".", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The desired state of the Catalog.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CatalogCatalogSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The observed state of the Catalog.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CatalogCatalogStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique identifier for the catalog.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the catalog was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_id", + "description": "The ID in the Unity Catalog.\nIt becomes the full resource name, for example \"my_catalog\" becomes \"catalogs/my_catalog\".", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateDatabase", + "description": "Create a Database.\n\nCreates a database in the specified branch. A branch can have multiple databases.", + "summary": "Create a Database.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/databases", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateDatabaseRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch where this Database will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "database", + "description": "The desired specification of a Database.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch where this Database will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database", + "description": "The desired specification of a Database.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database", + "description": "The desired specification of a Database.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "database", + "description": "The desired specification of a Database.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + }, + { + "name": "database_id", + "description": "The ID to use for the Database, which will become the final component of\nthe database's resource name.\nThis ID becomes the database name in postgres.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch where this Database will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the database was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The branch containing this database.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The desired state of the Database.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseDatabaseSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The observed state of the Database.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseDatabaseStatus", + "is_object": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the database was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch where this Database will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateEndpoint", + "description": "Creates a new compute endpoint in the branch.", + "summary": "Create an Endpoint.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/endpoints", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateEndpointRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch where this Endpoint will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint", + "description": "The Endpoint to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + { + "name": "endpoint_id", + "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch where this Endpoint will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_id", + "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "endpoint", + "description": "The Endpoint to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "endpoint", + "description": "The Endpoint to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint", + "description": "The Endpoint to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + { + "name": "endpoint_id", + "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch where this Endpoint will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "replace_existing", + "description": "If true, update the endpoint if it already exists instead of returning an error.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the compute endpoint was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The branch containing this endpoint (API resource hierarchy).\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Current operational status of the compute endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the compute endpoint was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch where this Endpoint will be created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_id", + "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateProject", + "description": "Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.", + "summary": "Create a Project.", + "path": "/api/2.0/postgres/projects", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateProjectRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "project", + "description": "The Project to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + { + "name": "project_id", + "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "project_id", + "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "project", + "description": "The Project to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "project", + "description": "The Project to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "project", + "description": "The Project to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + { + "name": "project_id", + "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the project was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "delete_time", + "description": "A timestamp indicating when the project was soft-deleted.\nEmpty if the project is not deleted, otherwise set to a timestamp in the past.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "initial_endpoint_spec", + "description": "Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly\ncreated project. If omitted, the initial endpoint created will have default settings, without high availability\nconfigured. This field does not apply to any endpoints created after project creation. Use\nspec.default_endpoint_settings to configure default settings for endpoints created after project creation.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "InitialEndpointSpec", + "is_object": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge_time", + "description": "A timestamp indicating when the project is scheduled for permanent deletion.\nEmpty if the project is not deleted, otherwise set to a timestamp in the future.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "spec", + "description": "The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ProjectSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The current status of a Project.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ProjectStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the project.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the project was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "project_id", + "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateRole", + "description": "Creates a new Postgres role in the branch.", + "summary": "Create a Postgres Role for a Branch.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/roles", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateRoleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch where this Role is created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "role", + "description": "The desired specification of a Role.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch where this Role is created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "role", + "description": "The desired specification of a Role.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "role", + "description": "The desired specification of a Role.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "parent", + "description": "The Branch where this Role is created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "role", + "description": "The desired specification of a Role.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + }, + { + "name": "role_id", + "description": "The ID to use for the Role, which will become the final component of\nthe role's resource name.\nThis ID becomes the role in Postgres.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch where this Role exists.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the role configuration, including identity type, authentication method, and role attributes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RoleRoleSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Current status of the role, including its identity type, authentication method, and role attributes.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RoleRoleStatus", + "is_object": true + } + }, + { + "name": "update_time", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch where this Role is created.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "CreateSyncedTable", + "description": "Create a Synced Table.", + "summary": "Create a Synced Database Table.", + "path": "/api/2.0/postgres/synced_tables", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateSyncedTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedTable", + "is_object": true + } + }, + { + "name": "synced_table_id", + "description": "The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.\nID is required and is the synced table name, containing (catalog, schema, table) tuple.\nElements of the tuple are the UC entity names.\n\nExample: \"{catalog}.{schema}.{table}\"\n\nsynced_table_id represents both of the following:\n\n1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.\n2. Postgres table named \"{table}\" in schema \"{schema}\" in the connected Postgres database", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "synced_table_id", + "description": "The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.\nID is required and is the synced table name, containing (catalog, schema, table) tuple.\nElements of the tuple are the UC entity names.\n\nExample: \"{catalog}.{schema}.{table}\"\n\nsynced_table_id represents both of the following:\n\n1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.\n2. Postgres table named \"{table}\" in schema \"{schema}\" in the connected Postgres database", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedTable", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedTable", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "synced_table", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SyncedTable", + "is_object": true + } + }, + { + "name": "synced_table_id", + "description": "The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.\nID is required and is the synced table name, containing (catalog, schema, table) tuple.\nElements of the tuple are the UC entity names.\n\nExample: \"{catalog}.{schema}.{table}\"\n\nsynced_table_id represents both of the following:\n\n1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.\n2. Postgres table named \"{table}\" in schema \"{schema}\" in the connected Postgres database", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The Full resource name of the synced table in Postgres\nwhere (catalog, schema, table) are the UC entity names.\n\nFormat \"synced_tables/{catalog}.{schema}.{table}\"\n\nFor the corresponding source table in the Unity catalog look for the \"source_table_full_name\" attribute.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Configuration details of the synced table, such as the source table, scheduling policy, etc.\nThis attribute is specified at creation time and most fields are returned as is on subsequent queries.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableSyncedTableSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Synced Table data synchronization status.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SyncedTableSyncedTableStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "The Unity Catalog table ID for this synced table.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "synced_table_id", + "description": "The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.\nID is required and is the synced table name, containing (catalog, schema, table) tuple.\nElements of the tuple are the UC entity names.\n\nExample: \"{catalog}.{schema}.{table}\"\n\nsynced_table_id represents both of the following:\n\n1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.\n2. Postgres table named \"{table}\" in schema \"{schema}\" in the connected Postgres database", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "DeleteBranch", + "description": "Deletes the specified database branch.", + "summary": "Delete a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteBranchRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to delete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to delete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to delete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge", + "description": "If true, permanently delete the branch; if false, soft delete.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the branch to delete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteCatalog", + "description": "Delete a Database Catalog.", + "summary": "Delete a Database Catalog.", + "path": "/api/2.0/postgres/{name=catalogs/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to delete.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to delete.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to delete.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the catalog to delete.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteDatabase", + "description": "Delete a Database.", + "summary": "Delete a Database.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteDatabaseRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the postgres database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the postgres database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the postgres database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the postgres database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteEndpoint", + "description": "Deletes the specified compute endpoint.", + "summary": "Delete an Endpoint.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/endpoints/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the endpoint to delete.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteProject", + "description": "Deletes the specified database project.", + "summary": "Delete a Project.", + "path": "/api/2.0/postgres/{name=projects/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteProjectRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the project to delete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the project to delete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the project to delete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge", + "description": "If true, permanently deletes the project (hard delete).\nIf false or unset, performs a soft delete.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the project to delete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteRole", + "description": "Deletes the specified Postgres role.", + "summary": "Delete a Postgres Role from a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/roles/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteRoleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the role to delete.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the role to delete.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the role to delete.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "reassign_owned_to", + "description": "Reassign objects. If this is set, all objects owned by the role are\nreassigned to the role specified in this parameter.\n\nNOTE: setting this requires spinning up a compute to succeed, since it involves running\nSQL queries.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the role to delete.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "DeleteSyncedTable", + "description": "Delete a Synced Table.", + "summary": "Delete a Synced Database Table.", + "path": "/api/2.0/postgres/{name=synced_tables/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteSyncedTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table, of the format \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the UC entity names.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table, of the format \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the UC entity names.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table, of the format \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the UC entity names.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The Full resource name of the synced table, of the format \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the UC entity names.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "GenerateDatabaseCredential", + "description": "Generate OAuth credentials for a Postgres database.", + "summary": "Generate OAuth credentials for a Postgres database.", + "path": "/api/2.0/postgres/credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GenerateDatabaseCredentialRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "endpoint", + "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "endpoint", + "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DatabaseCredential", + "is_object": true + }, + "all_fields": [ + { + "name": "claims", + "description": "The returned token will be scoped to UC tables with the specified permissions.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RequestedClaimsList", + "array_value": { + "pascal_name": "RequestedClaims", + "is_object": true + } + } + }, + { + "name": "endpoint", + "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint", + "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetBranch", + "description": "Retrieves information about the specified database branch.", + "summary": "Get a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetBranchRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Branch", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the branch to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetCatalog", + "description": "Get a Database Catalog.", + "summary": "Get a Database Catalog.", + "path": "/api/2.0/postgres/{name=catalogs/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetCatalogRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to retrieve.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to retrieve.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Catalog", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the catalog to retrieve.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the catalog to retrieve.\n\nFormat: \"catalogs/{catalog_id}\".", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDatabase", + "description": "Get a Database.", + "summary": "Get a Database.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetDatabaseRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the Database to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the Database to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Database", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the Database to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the Database to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetEndpoint", + "description": "Retrieves information about the specified compute endpoint, including its connection details and operational state.", + "summary": "Get an Endpoint.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/endpoints/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Endpoint", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the endpoint to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the endpoint to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetOperation", + "description": "Retrieves the status of a long-running operation.", + "summary": "Get an Operation.", + "path": "/api/2.0/postgres/{name=projects/*/operations/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetOperationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the operation resource.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetProject", + "description": "Retrieves information about the specified database project.", + "summary": "Get a Project.", + "path": "/api/2.0/postgres/{name=projects/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetProjectRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the project to retrieve.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the project to retrieve.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Project", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the project to retrieve.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the project to retrieve.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRole", + "description": "Retrieves information about the specified Postgres role, including its authentication method and permissions.", + "summary": "Get a Postgres Role for a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/roles/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetRoleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the role to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the role to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Role", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the role to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the role to retrieve.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSyncedTable", + "description": "Get a Synced Table.", + "summary": "Get a Synced Database Table.", + "path": "/api/2.0/postgres/{name=synced_tables/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSyncedTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table.\nFormat: \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the entity names in the Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table.\nFormat: \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the entity names in the Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SyncedTable", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The Full resource name of the synced table.\nFormat: \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the entity names in the Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The Full resource name of the synced table.\nFormat: \"synced_tables/{catalog}.{schema}.{table}\",\nwhere (catalog, schema, table) are the entity names in the Unity Catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListBranches", + "description": "Returns a paginated list of database branches in the project.", + "summary": "List Branches.", + "path": "/api/2.0/postgres/{parent=projects/*}/branches", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListBranchesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The Project that owns this collection of branches.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Project that owns this collection of branches.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListBranchesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned. Cannot be negative.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Project that owns this collection of branches.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "show_deleted", + "description": "Whether to include soft-deleted branches in the response.\nWhen true, deleted branches are included alongside active branches.\nPurged branches are never returned.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Project that owns this collection of branches.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListDatabases", + "description": "List Databases.", + "summary": "List postgres databases in a branch.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/databases", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListDatabasesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of databases.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of databases.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListDatabasesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of Databases. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch that owns this collection of databases.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch that owns this collection of databases.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of Databases. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListEndpoints", + "description": "Returns a paginated list of compute endpoints in the branch.", + "summary": "List Endpoints.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/endpoints", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListEndpointsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of endpoints.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of endpoints.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListEndpointsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned. Cannot be negative.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch that owns this collection of endpoints.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch that owns this collection of endpoints.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListProjects", + "description": "Returns a paginated list of database projects in the workspace that the user has permission to access.", + "summary": "List Projects.", + "path": "/api/2.0/postgres/projects", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListProjectsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListProjectsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned. Cannot be negative. The maximum value is 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "show_deleted", + "description": "Whether to include soft-deleted projects in the response.\nWhen true, soft-deleted projects are included alongside active projects.\nHard-deleted and already-purged projects are never returned.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListRoles", + "description": "Returns a paginated list of Postgres roles in the branch.", + "summary": "List Postgres Roles for a Branch.", + "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/roles", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListRolesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of roles.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "The Branch that owns this collection of roles.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListRolesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Upper bound for items returned. Cannot be negative.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch that owns this collection of roles.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "The Branch that owns this collection of roles.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous response. If not provided, returns the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UndeleteBranch", + "description": "Undeletes the specified database branch.", + "summary": "Undelete a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*}/undelete", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UndeleteBranchRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to undelete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to undelete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the branch to undelete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the branch to undelete.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "UndeleteProject", + "description": "Undeletes a soft-deleted project.", + "summary": "Undelete a Project.", + "path": "/api/2.0/postgres/{name=projects/*}/undelete", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UndeleteProjectRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The full resource path of the project to undelete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The full resource path of the project to undelete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The full resource path of the project to undelete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The full resource path of the project to undelete.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": { + "is_empty_response": true + } + } + }, + { + "name": "UpdateBranch", + "description": "Updates the specified database branch. You can set this branch as the project's default branch, or protect/unprotect it.", + "summary": "Update a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateBranchRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "branch", + "description": "The Branch to update.\n\nThe branch's `name` field is used to identify the branch to update.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "branch", + "description": "The Branch to update.\n\nThe branch's `name` field is used to identify the branch to update.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "branch", + "description": "The Branch to update.\n\nThe branch's `name` field is used to identify the branch to update.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "branch", + "description": "The Branch to update.\n\nThe branch's `name` field is used to identify the branch to update.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Branch", + "is_object": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the branch was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The project containing this branch (API resource hierarchy).\nFormat: projects/{project_id}\n\nNote: This field indicates where the branch exists in the resource hierarchy.\nFor point-in-time branching from another branch, see `status.source_branch`.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the branch configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BranchSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The current status of a Branch.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BranchStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the branch.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the branch was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "UpdateDatabase", + "description": "Update a Database.", + "summary": "Update a Database.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateDatabaseRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "database", + "description": "The Database to update.\n\nThe database's `name` field is used to identify the database to update.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "database", + "description": "The Database to update.\n\nThe database's `name` field is used to identify the database to update.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "database", + "description": "The Database to update.\n\nThe database's `name` field is used to identify the database to update.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "database", + "description": "The Database to update.\n\nThe database's `name` field is used to identify the database to update.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Database", + "is_object": true + } + }, + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the database was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The branch containing this database.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The desired state of the Database.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseDatabaseSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The observed state of the Database.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabaseDatabaseStatus", + "is_object": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the database was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "UpdateEndpoint", + "description": "Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or enable/disable the compute endpoint.", + "summary": "Update an Endpoint.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/endpoints/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateEndpointRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint", + "description": "The Endpoint to update.\n\nThe endpoint's `name` field is used to identify the endpoint to update.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "endpoint", + "description": "The Endpoint to update.\n\nThe endpoint's `name` field is used to identify the endpoint to update.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "endpoint", + "description": "The Endpoint to update.\n\nThe endpoint's `name` field is used to identify the endpoint to update.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint", + "description": "The Endpoint to update.\n\nThe endpoint's `name` field is used to identify the endpoint to update.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Endpoint", + "is_object": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the compute endpoint was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The branch containing this endpoint (API resource hierarchy).\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Current operational status of the compute endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the compute endpoint was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "UpdateProject", + "description": "Updates the specified database project.", + "summary": "Update a Project.", + "path": "/api/2.0/postgres/{name=projects/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateProjectRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "project", + "description": "The Project to update.\n\nThe project's `name` field is used to identify the project to update.\nFormat: projects/{project_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "project", + "description": "The Project to update.\n\nThe project's `name` field is used to identify the project to update.\nFormat: projects/{project_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "project", + "description": "The Project to update.\n\nThe project's `name` field is used to identify the project to update.\nFormat: projects/{project_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "project", + "description": "The Project to update.\n\nThe project's `name` field is used to identify the project to update.\nFormat: projects/{project_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Project", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "A timestamp indicating when the project was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "delete_time", + "description": "A timestamp indicating when the project was soft-deleted.\nEmpty if the project is not deleted, otherwise set to a timestamp in the past.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "initial_endpoint_spec", + "description": "Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly\ncreated project. If omitted, the initial endpoint created will have default settings, without high availability\nconfigured. This field does not apply to any endpoints created after project creation. Use\nspec.default_endpoint_settings to configure default settings for endpoints created after project creation.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "InitialEndpointSpec", + "is_object": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge_time", + "description": "A timestamp indicating when the project is scheduled for permanent deletion.\nEmpty if the project is not deleted, otherwise set to a timestamp in the future.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "spec", + "description": "The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ProjectSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "The current status of a Project.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ProjectStatus", + "is_object": true + } + }, + { + "name": "uid", + "description": "System-generated unique ID for the project.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "A timestamp indicating when the project was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Output only. The full resource path of the project.\nFormat: projects/{project_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "UpdateRole", + "description": "Update a role for a branch.", + "summary": "Update a Postgres Role for a Branch.", + "path": "/api/2.0/postgres/{name=projects/*/branches/*/roles/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateRoleRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "role", + "description": "The Postgres Role to update.\n\nThe role's `name` field is used to identify the role to update.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update in Postgres Role.\nIf unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update in Postgres Role.\nIf unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "role", + "description": "The Postgres Role to update.\n\nThe role's `name` field is used to identify the role to update.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "role", + "description": "The Postgres Role to update.\n\nThe role's `name` field is used to identify the role to update.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "role", + "description": "The Postgres Role to update.\n\nThe role's `name` field is used to identify the role to update.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Role", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update in Postgres Role.\nIf unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "The Branch where this Role exists.\nFormat: projects/{project_id}/branches/{branch_id}", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The spec contains the role configuration, including identity type, authentication method, and role attributes.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RoleRoleSpec", + "is_object": true + } + }, + { + "name": "status", + "description": "Current status of the role, including its identity type, authentication method, and role attributes.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RoleRoleStatus", + "is_object": true + } + }, + { + "name": "update_time", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The list of fields to update in Postgres Role.\nIf unspecified, all fields will be updated when possible.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + } + ] + }, + { + "id": "provisioning.PrivateAccess", + "name": "PrivateAccess", + "description": "These APIs manage private access settings for this account.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a private access settings configuration, which represents\nnetwork access restrictions for workspace resources. Private access\nsettings configure whether workspaces can be accessed from the public\ninternet or only from private endpoints.", + "summary": "Create private access settings.", + "path": "/api/2.0/accounts/{account_id}/private-access-settings", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePrivateAccessSettingsRequest", + "is_object": true + }, + "response": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + }, + "all_fields": [ + { + "name": "allowed_vpc_endpoint_ids", + "description": "An array of Databricks VPC endpoint IDs. This is the Databricks ID returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\nOnly used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints registered in your Databricks account that can connect to your workspace over AWS PrivateLink.\nNote: If hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "private_access_level", + "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object.\n`ACCOUNT` level access (the default) allows only VPC endpoints that are registered in your Databricks account connect to your workspace.\n`ENDPOINT` level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessLevel", + "enum": [ + { + "content": "ACCOUNT" + }, + { + "content": "ENDPOINT" + } + ] + } + }, + { + "name": "private_access_settings_name", + "description": "The human-readable name of the private access settings object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "public_access_enabled", + "description": "Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "region", + "description": "The AWS region for workspaces attached to this private access settings object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Databricks private access settings configuration, both specified by ID.", + "summary": "Delete private access settings.", + "path": "/api/2.0/accounts/{account_id}/private-access-settings/{private_access_settings_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePrivateAccesRequest", + "is_object": true, + "required_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + }, + "all_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Databricks private access settings configuration, both specified by ID.", + "summary": "Get private access settings.", + "path": "/api/2.0/accounts/{account_id}/private-access-settings/{private_access_settings_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPrivateAccesRequest", + "is_object": true, + "required_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + }, + "all_fields": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "private_access_settings_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks private access settings for an account.", + "summary": "List private access settings.", + "path": "/api/2.0/accounts/{account_id}/private-access-settings", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPrivateAccessRequest", + "is_object": true + }, + "response": { + "pascal_name": "PrivateAccessSettingsList", + "array_value": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + } + } + }, + { + "name": "Replace", + "description": "Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property.\nThis operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change. If public_access_enabled, private_access_level, or allowed_vpc_endpoint_ids are updated, effects of these changes might take several minutes to propagate to the workspace API.\nYou can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.\nBefore configuring PrivateLink, read the Databricks article about PrivateLink.", + "summary": "Update private access settings.", + "path": "/api/2.0/accounts/{account_id}/private-access-settings/{private_access_settings_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ReplacePrivateAccessSettingsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "private_access_settings_id", + "description": "Databricks private access settings ID.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "customer_facing_private_access_settings", + "description": "Properties of the new private access settings object.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "private_access_settings_id", + "description": "Databricks private access settings ID.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "customer_facing_private_access_settings", + "description": "Properties of the new private access settings object.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "customer_facing_private_access_settings", + "description": "Properties of the new private access settings object.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + } + }, + "response": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + }, + "all_fields": [ + { + "name": "customer_facing_private_access_settings", + "description": "Properties of the new private access settings object.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessSettings", + "is_object": true + } + }, + { + "name": "private_access_settings_id", + "description": "Databricks private access settings ID.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + }, + { + "name": "account_id", + "description": "The Databricks account ID that hosts the private access settings.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "allowed_vpc_endpoint_ids", + "description": "An array of Databricks VPC endpoint IDs. This is the Databricks ID that is returned when registering the VPC endpoint configuration in your Databricks account. This is not the ID of the VPC endpoint in AWS.\nOnly used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink.\nIf hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "private_access_level", + "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object.\n`ACCOUNT` level access (the default) allows only VPC endpoints that are registered in your Databricks account connect to your workspace.\n`ENDPOINT` level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PrivateAccessLevel", + "enum": [ + { + "content": "ACCOUNT" + }, + { + "content": "ENDPOINT" + } + ] + } + }, + { + "name": "private_access_settings_id", + "description": "Databricks private access settings ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "private_access_settings_name", + "description": "The human-readable name of the private access settings object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "public_access_enabled", + "description": "Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "region", + "description": "The AWS region for workspaces attached to this private access settings object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "private_access_settings_id", + "description": "Databricks private access settings ID.", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderExchangeFilters", + "name": "ProviderExchangeFilters", + "description": "Marketplace exchanges filters curate which groups can access an exchange.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ExchangeFilterNameToIdMap" + }, + "request": { + "pascal_name": "ListExchangeFiltersRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Add an exchange filter.", + "summary": "Create a new exchange filter.", + "path": "/api/2.0/marketplace-exchange/filters", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateExchangeFilterRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreateExchangeFilterResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete an exchange filter", + "summary": "Delete an exchange filter.", + "path": "/api/2.0/marketplace-exchange/filters/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteExchangeFilterRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteExchangeFilterResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List exchange filter", + "summary": "List exchange filters.", + "path": "/api/2.0/marketplace-exchange/filters", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListExchangeFiltersRequest", + "is_object": true, + "required_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListExchangeFiltersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update an exchange filter.", + "summary": "Update exchange filter.", + "path": "/api/2.0/marketplace-exchange/filters/{id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateExchangeFilterRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateExchangeFilterResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExchangeFilter", + "is_object": true + } + }, + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderExchanges", + "name": "ProviderExchanges", + "description": "Marketplace exchanges allow providers to share their listings with a curated set of customers.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ExchangeNameToIdMap" + }, + "request": { + "pascal_name": "ListExchangesRequest" + } + }, + "methods": [ + { + "name": "AddListingToExchange", + "description": "Associate an exchange with a listing", + "summary": "Add an exchange for listing.", + "path": "/api/2.0/marketplace-exchange/exchanges-for-listing", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "AddExchangeForListingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "exchange_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "listing_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "exchange_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AddExchangeForListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "exchange_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "exchange_id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Create an exchange", + "summary": "Create an exchange.", + "path": "/api/2.0/marketplace-exchange/exchanges", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateExchangeRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreateExchangeResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "This removes a listing from marketplace.", + "summary": "Delete an exchange.", + "path": "/api/2.0/marketplace-exchange/exchanges/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteExchangeRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteExchangeResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteListingFromExchange", + "description": "Disassociate an exchange with a listing", + "summary": "Remove an exchange for listing.", + "path": "/api/2.0/marketplace-exchange/exchanges-for-listing/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "RemoveExchangeForListingRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RemoveExchangeForListingResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get an exchange.", + "summary": "Get an exchange.", + "path": "/api/2.0/marketplace-exchange/exchanges/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetExchangeRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetExchangeResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List exchanges visible to provider", + "summary": "List exchanges.", + "path": "/api/2.0/marketplace-exchange/exchanges", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListExchangesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListExchangesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListExchangesForListing", + "description": "List exchanges associated with a listing", + "summary": "List exchanges for listing.", + "path": "/api/2.0/marketplace-exchange/exchanges-for-listing", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListExchangesForListingRequest", + "is_object": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListExchangesForListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListListingsForExchange", + "description": "List listings associated with an exchange", + "summary": "List listings for exchange.", + "path": "/api/2.0/marketplace-exchange/listings-for-exchange", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListListingsForExchangeRequest", + "is_object": true, + "required_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListListingsForExchangeResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "exchange_id", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update an exchange", + "summary": "Update exchange.", + "path": "/api/2.0/marketplace-exchange/exchanges/{id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateExchangeRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateExchangeResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "exchange", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Exchange", + "is_object": true + } + }, + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderFiles", + "name": "ProviderFiles", + "description": "Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "FileInfoDisplayNameToIdMap" + }, + "request": { + "pascal_name": "ListFilesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a file. Currently, only provider icons and attached notebooks are supported.", + "summary": "Create a file.", + "path": "/api/2.0/marketplace-provider/files", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateFileRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "file_parent", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + }, + { + "name": "marketplace_file_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MarketplaceFileType", + "enum": [ + { + "content": "APP" + }, + { + "content": "EMBEDDED_NOTEBOOK" + }, + { + "content": "PROVIDER_ICON" + } + ] + } + }, + { + "name": "mime_type", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "file_parent", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + }, + { + "name": "marketplace_file_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MarketplaceFileType", + "enum": [ + { + "content": "APP" + }, + { + "content": "EMBEDDED_NOTEBOOK" + }, + { + "content": "PROVIDER_ICON" + } + ] + } + }, + { + "name": "mime_type", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateFileResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "display_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "file_parent", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + }, + { + "name": "marketplace_file_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MarketplaceFileType", + "enum": [ + { + "content": "APP" + }, + { + "content": "EMBEDDED_NOTEBOOK" + }, + { + "content": "PROVIDER_ICON" + } + ] + } + }, + { + "name": "mime_type", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a file", + "summary": "Delete a file.", + "path": "/api/2.0/marketplace-provider/files/{file_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteFileRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteFileResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a file", + "summary": "Get a file.", + "path": "/api/2.0/marketplace-provider/files/{file_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetFileRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetFileResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "file_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List files attached to a parent entity.", + "summary": "List files.", + "path": "/api/2.0/marketplace-provider/files", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListFilesRequest", + "is_object": true, + "required_fields": [ + { + "name": "file_parent", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "file_parent", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "ListFilesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "file_parent", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "FileParent", + "is_object": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "marketplace.ProviderListings", + "name": "ProviderListings", + "description": "Listings are the core entities in the Marketplace. They represent the products that are available for consumption.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ListingSummaryNameToIdMap" + }, + "request": { + "pascal_name": "GetListingsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a new listing", + "summary": "Create a listing.", + "path": "/api/2.0/marketplace-provider/listing", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateListingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreateListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a listing", + "summary": "Delete a listing.", + "path": "/api/2.0/marketplace-provider/listings/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteListingRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteListingResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a listing", + "summary": "Get a listing.", + "path": "/api/2.0/marketplace-provider/listings/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetListingRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List listings owned by this provider", + "summary": "List listings.", + "path": "/api/2.0/marketplace-provider/listings", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetListingsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetListingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update a listing", + "summary": "Update listing.", + "path": "/api/2.0/marketplace-provider/listings/{id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateListingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateListingResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "listing", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Listing", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderPersonalizationRequests", + "name": "ProviderPersonalizationRequests", + "description": "Personalization requests are an alternate to instantly available listings. Control the lifecycle of personalized solutions.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListAllPersonalizationRequestsRequest" + } + }, + "methods": [ + { + "name": "List", + "description": "List personalization requests to this provider.\nThis will return all personalization requests, regardless of which listing they are for.", + "summary": "All personalization requests across all listings.", + "path": "/api/2.0/marketplace-provider/personalization-requests", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListAllPersonalizationRequestsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAllPersonalizationRequestsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update personalization request. This method only permits updating the status of the request.", + "summary": "Update personalization request status.", + "path": "/api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdatePersonalizationRequestRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalizationRequestStatus", + "enum": [ + { + "content": "DENIED" + }, + { + "content": "FULFILLED" + }, + { + "content": "NEW" + }, + { + "content": "REQUEST_PENDING" + } + ] + } + } + ], + "required_in_url_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "status", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalizationRequestStatus", + "enum": [ + { + "content": "DENIED" + }, + { + "content": "FULFILLED" + }, + { + "content": "NEW" + }, + { + "content": "REQUEST_PENDING" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "UpdatePersonalizationRequestResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "reason", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "share", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ShareInfo", + "is_object": true + } + }, + { + "name": "status", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalizationRequestStatus", + "enum": [ + { + "content": "DENIED" + }, + { + "content": "FULFILLED" + }, + { + "content": "NEW" + }, + { + "content": "REQUEST_PENDING" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "listing_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PersonalizationRequestStatus", + "enum": [ + { + "content": "DENIED" + }, + { + "content": "FULFILLED" + }, + { + "content": "NEW" + }, + { + "content": "REQUEST_PENDING" + } + ] + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderProviderAnalyticsDashboards", + "name": "ProviderProviderAnalyticsDashboards", + "description": "Manage templated analytics solution for providers.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Create", + "description": "Create provider analytics dashboard. Returns Marketplace specific `id`. Not to be confused with the Lakeview dashboard id.", + "summary": "Create provider analytics dashboard.", + "path": "/api/2.0/marketplace-provider/analytics_dashboard", + "is_legacy_empty_request": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateProviderAnalyticsDashboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "ProviderAnalyticsDashboard", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "Get", + "description": "Get provider analytics dashboard.", + "summary": "Get provider analytics dashboard.", + "path": "/api/2.0/marketplace-provider/analytics_dashboard", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListProviderAnalyticsDashboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListProviderAnalyticsDashboardResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "dashboard_id will be used to open Lakeview dashboard.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "dashboard_id will be used to open Lakeview dashboard.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "GetLatestVersion", + "description": "Get latest version of provider analytics dashboard.", + "summary": "Get latest version of provider analytics dashboard.", + "path": "/api/2.0/marketplace-provider/analytics_dashboard/latest", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetLatestVersionProviderAnalyticsDashboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetLatestVersionProviderAnalyticsDashboardResponse", + "is_object": true + } + }, + { + "name": "Update", + "description": "Update provider analytics dashboard.", + "summary": "Update provider analytics dashboard.", + "path": "/api/2.0/marketplace-provider/analytics_dashboard/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateProviderAnalyticsDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "id is immutable property and can't be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "id is immutable property and can't be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateProviderAnalyticsDashboardResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "description": "id \u0026 version should be the same as the request", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "this is newly created Lakeview dashboard for the user", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "id", + "description": "id \u0026 version should be the same as the request", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dashboard_id", + "description": "this is newly created Lakeview dashboard for the user", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "id", + "description": "id is immutable property and can't be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "this is the version of the dashboard template we want to update our user to\ncurrent expectation is that it should be equal to latest version of the dashboard template", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "id is immutable property and can't be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "marketplace.ProviderProviders", + "name": "ProviderProviders", + "description": "Providers are entities that manage assets in Marketplace.", + "package": { + "name": "marketplace" + }, + "docs_group": "marketplace", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "named_id_map": { + "pascal_name": "ProviderInfoNameToIdMap" + }, + "request": { + "pascal_name": "ListProvidersRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a provider", + "summary": "Create a provider.", + "path": "/api/2.0/marketplace-provider/provider", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateProviderRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "CreateProviderResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete provider", + "summary": "Delete provider.", + "path": "/api/2.0/marketplace-provider/providers/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteProviderRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteProviderResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get provider profile", + "summary": "Get provider.", + "path": "/api/2.0/marketplace-provider/providers/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetProviderRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetProviderResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List provider profiles for account.", + "summary": "List providers.", + "path": "/api/2.0/marketplace-provider/providers", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListProvidersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListProvidersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update provider profile", + "summary": "Update provider.", + "path": "/api/2.0/marketplace-provider/providers/{id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateProviderRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateProviderResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ProviderInfo", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sharing.Providers", + "name": "Providers", + "description": "A data provider is an object representing the organization in the real world who shares the\ndata. A provider contains shares which further contain the shared data.", + "package": { + "name": "sharing" + }, + "docs_group": "sharing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ProviderInfoNameToMetastoreIdMap" + }, + "request": { + "pascal_name": "ListProvidersRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new authentication provider minimally based on a name and authentication type.\nThe caller must be an admin on the metastore.", + "summary": "Create an auth provider.", + "path": "/api/2.1/unity-catalog/providers", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateProvider", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the Provider.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the Provider.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "ProviderInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + }, + { + "name": "comment", + "description": "Description about the provider.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the Provider.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_profile_str", + "description": "This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the Provider.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.", + "summary": "Delete a provider.", + "path": "/api/2.1/unity-catalog/providers/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteProviderRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a specific authentication provider.\nThe caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.", + "summary": "Get a provider.", + "path": "/api/2.1/unity-catalog/providers/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetProviderRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ProviderInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of available authentication providers.\nThe caller must either be a metastore admin, have the **USE_PROVIDER** privilege on the providers,\nor be the owner of the providers. Providers not owned by the caller and for which the caller does\nnot have the **USE_PROVIDER** privilege are not included in the response.\nThere is no guarantee of a specific ordering of the elements in the array.", + "summary": "List providers.", + "path": "/api/2.1/unity-catalog/providers", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListProvidersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListProvidersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "data_provider_global_metastore_id", + "description": "If not provided, all providers will be returned.\nIf no providers exist with this ID, no results will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of providers to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid providers are returned (not recommended).\n- Note: The number of returned providers might be less than the specified max_results size, even zero.\nThe only definitive indication that no further providers can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of providers to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid providers are returned (not recommended).\n- Note: The number of returned providers might be less than the specified max_results size, even zero.\nThe only definitive indication that no further providers can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "ListProviderShareAssets", + "description": "Get arrays of assets associated with a specified provider's share.\nThe caller is the recipient of the share.", + "summary": "List assets by provider share.", + "path": "/api/2.1/data-sharing/providers/{provider_name}/shares/{share_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListProviderShareAssetsRequest", + "is_object": true, + "required_fields": [ + { + "name": "provider_name", + "description": "The name of the provider who owns the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "share_name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "provider_name", + "description": "The name of the provider who owns the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "share_name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListProviderShareAssetsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "function_max_results", + "description": "Maximum number of functions to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "notebook_max_results", + "description": "Maximum number of notebooks to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "provider_name", + "description": "The name of the provider who owns the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "share_name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_max_results", + "description": "Maximum number of tables to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "volume_max_results", + "description": "Maximum number of volumes to return.", + "is_query": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "provider_name", + "description": "The name of the provider who owns the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "share_name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListShares", + "description": "Gets an array of a specified provider's shares within the metastore where:\n\n* the caller is a metastore admin, or\n* the caller is the owner.", + "summary": "List shares by Provider.", + "path": "/api/2.1/unity-catalog/providers/{name}/shares", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSharesRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the provider in which to list shares.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the provider in which to list shares.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListProviderSharesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "Name of the provider in which to list shares.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the provider in which to list shares.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider.\nIf the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.", + "summary": "Update a provider.", + "path": "/api/2.1/unity-catalog/providers/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateProvider", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ProviderInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "Description about the provider.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the provider.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of Provider owner.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_profile_str", + "description": "This field is required when the __authentication_type__ is **TOKEN**, **OAUTH_CLIENT_CREDENTIALS** or not provided.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the provider.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.PublishedAppIntegration", + "name": "PublishedAppIntegration", + "description": "These APIs enable administrators to manage published OAuth app integrations, which is required for\nadding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS cloud.", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListPublishedAppIntegrationsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create Published OAuth App Integration.\n\nYou can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.", + "summary": "Create Published OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreatePublishedAppIntegration", + "is_object": true + }, + "response": { + "pascal_name": "CreatePublishedAppIntegrationOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "app_id", + "description": "App id of the OAuth published app integration.\nFor example power-bi, tableau-deskop", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "token_access_policy", + "description": "Token access policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TokenAccessPolicy", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete an existing Published OAuth App Integration.\nYou can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.", + "summary": "Delete Published OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeletePublishedAppIntegrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeletePublishedAppIntegrationOutput", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the Published OAuth App Integration for the given integration id.", + "summary": "Get OAuth Published App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetPublishedAppIntegrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetPublishedAppIntegrationOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Get the list of published OAuth app integrations for the specified Databricks account", + "summary": "Get published oauth app integrations.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListPublishedAppIntegrationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetPublishedAppIntegrationsOutput", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates an existing published OAuth App Integration.\nYou can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.", + "summary": "Updates Published OAuth App Integration.", + "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdatePublishedAppIntegration", + "is_object": true, + "required_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdatePublishedAppIntegrationOutput", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "token_access_policy", + "description": "Token access policy to be updated in the published OAuth app integration", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TokenAccessPolicy", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "integration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "qualitymonitorv2.QualityMonitorV2", + "name": "QualityMonitorV2", + "description": "Deprecated: Please use the Data Quality Monitoring API instead (REST: /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support `schema`).", + "package": { + "name": "qualitymonitorv2" + }, + "docs_group": "qualitymonitor", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListQualityMonitorRequest" + } + }, + "methods": [ + { + "name": "CreateQualityMonitor", + "description": "Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors).\nCreate a quality monitor on UC object.", + "summary": "Create a quality monitor.", + "path": "/api/2.0/quality-monitors", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateQualityMonitorRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "anomaly_detection_config", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AnomalyDetectionConfig", + "is_object": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "validity_check_configurations", + "description": "Validity check configurations for anomaly detection.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ValidityCheckConfigurationList", + "array_value": { + "pascal_name": "ValidityCheckConfiguration", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteQualityMonitor", + "description": "Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors).\nDelete a quality monitor on UC object.", + "summary": "Delete a quality monitor.", + "path": "/api/2.0/quality-monitors/{object_type}/{object_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteQualityMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetQualityMonitor", + "description": "Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors).\nRead a quality monitor on UC object.", + "summary": "Read a quality monitor.", + "path": "/api/2.0/quality-monitors/{object_type}/{object_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetQualityMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListQualityMonitor", + "description": "Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors).\n(Unimplemented) List quality monitors.", + "summary": "List quality monitors.", + "path": "/api/2.0/quality-monitors", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListQualityMonitorRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListQualityMonitorResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateQualityMonitor", + "description": "Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors).\n(Unimplemented) Update a quality monitor on UC object.", + "summary": "Update a quality monitor.", + "path": "/api/2.0/quality-monitors/{object_type}/{object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateQualityMonitorRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quality_monitor", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "QualityMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "anomaly_detection_config", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AnomalyDetectionConfig", + "is_object": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "validity_check_configurations", + "description": "Validity check configurations for anomaly detection.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ValidityCheckConfigurationList", + "array_value": { + "pascal_name": "ValidityCheckConfiguration", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_type", + "description": "The type of the monitored object. Can be one of the following: schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "object_id", + "description": "The uuid of the request object. For example, schema id.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.QualityMonitors", + "name": "QualityMonitors", + "description": "Deprecated: Please use the Data Quality Monitors API instead (REST: /api/data-quality/v1/monitors), which manages both Data Profiling and Anomaly Detection.\n\nA monitor computes and monitors data or model quality metrics for a table over time.\nIt generates metrics tables and a dashboard that you can use to monitor table health and set alerts.\nMost write operations require the user to be the owner of the table (or its parent schema or parent catalog).\nViewing the dashboard, computed metrics, or monitor configuration only requires the user to have **SELECT**\nprivileges on the table (along with **USE_SCHEMA** and **USE_CATALOG**).", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "CancelRefresh", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nCancels an already-initiated refresh job.", + "summary": "Cancel refresh.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes/{refresh_id}/cancel", + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CancelRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "CancelRefreshResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "refresh_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Create", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nCreates a new monitor for the specified table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on the table\n2. have **USE_CATALOG** on the table's parent catalog, be an owner of the table's parent schema, and have **SELECT** access on the table.\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- be an owner of the table.\n\nWorkspace assets, such as the dashboard, will be created in the workspace where\nthis call was made.", + "summary": "Create a table monitor.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "assets_dir", + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "assets_dir", + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "assets_dir", + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "baseline_table_name", + "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_metrics", + "description": "[Create:OPT Update:OPT] Custom metrics.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorMetricList", + "array_value": { + "pascal_name": "MonitorMetric", + "is_object": true + } + } + }, + { + "name": "data_classification_config", + "description": "[Create:OPT Update:OPT] Data classification related config.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorDataClassificationConfig", + "is_object": true + } + }, + { + "name": "inference_log", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorInferenceLog", + "is_object": true + } + }, + { + "name": "latest_monitor_failure_msg", + "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notifications", + "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorNotifications", + "is_object": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "[Create:OPT Update:OPT] The monitor schedule.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorCronSchedule", + "is_object": true + } + }, + { + "name": "skip_builtin_dashboard", + "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "slicing_exprs", + "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "snapshot", + "description": "Configuration for monitoring snapshot tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorSnapshot", + "is_object": true + } + }, + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_series", + "description": "Configuration for monitoring time series tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorTimeSeries", + "is_object": true + } + }, + { + "name": "warehouse_id", + "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "assets_dir", + "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nDeletes a monitor for the specified table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- be an owner of the table.\n\nAdditionally, the call must be made from the workspace where the monitor was created.\n\nNote that the metric tables and dashboard will not be deleted as part of this call; those\nassets must be manually cleaned up (if desired).", + "summary": "Delete a table monitor.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteQualityMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteMonitorResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nGets a monitor for the specified table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema.\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- **SELECT** privilege on the table.\n\nThe returned information includes configuration values, as well as information on\nassets created by the monitor. Some information (e.g., dashboard) may be filtered out\nif the caller is in a different workspace than where the monitor was created.", + "summary": "Get a table monitor.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetQualityMonitorRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetRefresh", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nGets info about a specific monitor refresh using the given refresh ID.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- **SELECT** privilege on the table.\n\nAdditionally, the call must be made from the workspace where the monitor was created.", + "summary": "Get refresh.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes/{refresh_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "ID of the refresh.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "ID of the refresh.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorRefreshInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorRefreshInfoState", + "enum": [ + { + "content": "CANCELED" + }, + { + "content": "FAILED" + }, + { + "content": "PENDING" + }, + { + "content": "RUNNING" + }, + { + "content": "SUCCESS" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "start_time_ms", + "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorRefreshInfoState", + "enum": [ + { + "content": "CANCELED" + }, + { + "content": "FAILED" + }, + { + "content": "PENDING" + }, + { + "content": "RUNNING" + }, + { + "content": "SUCCESS" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "start_time_ms", + "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "refresh_id", + "description": "ID of the refresh.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "table_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "refresh_id", + "description": "ID of the refresh.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ListRefreshes", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nGets an array containing the history of the most recent refreshes (up to 25) for this table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- **SELECT** privilege on the table.\n\nAdditionally, the call must be made from the workspace where the monitor was created.", + "summary": "List refreshes.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListRefreshesRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorRefreshListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RegenerateDashboard", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nRegenerates the monitoring dashboard for the specified table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- be an owner of the table\n\nThe call must be made from the workspace where the monitor was created. The dashboard will be regenerated in\nthe assets directory that was specified when the monitor was created.", + "summary": "Regenerate a monitoring dashboard.", + "path": "/api/2.1/quality-monitoring/tables/{table_name}/monitor/dashboard", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "RegenerateDashboardRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegenerateDashboardResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Optional argument to specify the warehouse for dashboard regeneration. If not specified, the first running\nwarehouse will be used.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RunRefresh", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nQueues a metric refresh on the monitor for the specified table.\nThe refresh will execute in the background.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- be an owner of the table\n\nAdditionally, the call must be made from the workspace where the monitor was created.", + "summary": "Run refresh.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor/refreshes", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RunRefreshRequest", + "is_object": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorRefreshInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorRefreshInfoState", + "enum": [ + { + "content": "CANCELED" + }, + { + "content": "FAILED" + }, + { + "content": "PENDING" + }, + { + "content": "RUNNING" + }, + { + "content": "SUCCESS" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "start_time_ms", + "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "refresh_id", + "description": "Unique id of the refresh operation.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "state", + "description": "The current state of the refresh.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorRefreshInfoState", + "enum": [ + { + "content": "CANCELED" + }, + { + "content": "FAILED" + }, + { + "content": "PENDING" + }, + { + "content": "RUNNING" + }, + { + "content": "SUCCESS" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "start_time_ms", + "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\ntable_name is case insensitive and spaces are disallowed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Deprecated: Use Data Quality Monitors API instead (/api/data-quality/v1/monitors).\nUpdates a monitor for the specified table.\n\nThe caller must either:\n1. be an owner of the table's parent catalog\n2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema\n3. have the following permissions:\n- **USE_CATALOG** on the table's parent catalog\n- **USE_SCHEMA** on the table's parent schema\n- be an owner of the table.\n\nAdditionally, the call must be made from the workspace where the monitor was created, and the caller must be\nthe original creator of the monitor.\n\nCertain configuration fields, such as output asset identifiers, cannot be updated.", + "summary": "Update a table monitor.", + "path": "/api/2.1/unity-catalog/tables/{table_name}/monitor", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateMonitor", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MonitorInfo", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name", + "description": "[Create:ERR Update:IGN] UC table to monitor. Format: `catalog.schema.table_name`", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "status", + "description": "[Create:ERR Update:IGN] The monitor status.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorInfoStatus", + "enum": [ + { + "content": "MONITOR_STATUS_ACTIVE" + }, + { + "content": "MONITOR_STATUS_DELETE_PENDING" + }, + { + "content": "MONITOR_STATUS_ERROR" + }, + { + "content": "MONITOR_STATUS_FAILED" + }, + { + "content": "MONITOR_STATUS_PENDING" + } + ] + } + }, + { + "name": "profile_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "drift_metrics_table_name", + "description": "[Create:ERR Update:IGN] Table that stores drift metrics data. Format: `catalog.schema.table_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "monitor_version", + "description": "[Create:ERR Update:IGN] Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\nmonitor_version numbers.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "baseline_table_name", + "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_metrics", + "description": "[Create:OPT Update:OPT] Custom metrics.", + "is_request_body_field": true, + "entity": { + "pascal_name": "MonitorMetricList", + "array_value": { + "pascal_name": "MonitorMetric", + "is_object": true + } + } + }, + { + "name": "dashboard_id", + "description": "[Create:ERR Update:OPT] Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "data_classification_config", + "description": "[Create:OPT Update:OPT] Data classification related config.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorDataClassificationConfig", + "is_object": true + } + }, + { + "name": "inference_log", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorInferenceLog", + "is_object": true + } + }, + { + "name": "latest_monitor_failure_msg", + "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "notifications", + "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorNotifications", + "is_object": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schedule", + "description": "[Create:OPT Update:OPT] The monitor schedule.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorCronSchedule", + "is_object": true + } + }, + { + "name": "slicing_exprs", + "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "snapshot", + "description": "Configuration for monitoring snapshot tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorSnapshot", + "is_object": true + } + }, + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "time_series", + "description": "Configuration for monitoring time series tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MonitorTimeSeries", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "table_name", + "description": "UC table name in format `catalog.schema.table_name`.\nThis field corresponds to the {full_table_name_arg} arg in the endpoint path.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "output_schema_name", + "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.Queries", + "name": "Queries", + "description": "The queries API can be used to perform CRUD operations on queries. A query is a Databricks SQL\nobject that includes the target SQL warehouse, query text, name, description, tags, and parameters.\nQueries can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ListQueryObjectsResponseQueryDisplayNameToIdMap" + }, + "request": { + "pascal_name": "ListQueriesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a query.", + "summary": "Create a query.", + "path": "/api/2.0/sql/queries", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateQueryRequest", + "is_object": true + }, + "response": { + "pascal_name": "Query", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_resolve_display_name", + "description": "If true, automatically resolve query display name conflicts. Otherwise, fail the request if the query's display name conflicts with an existing query's display name.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "query", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateQueryRequestQuery", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days.", + "summary": "Delete a query.", + "path": "/api/2.0/sql/queries/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TrashQueryRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Empty", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a query.", + "summary": "Get a query.", + "path": "/api/2.0/sql/queries/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetQueryRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Query", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.", + "summary": "List queries.", + "path": "/api/2.0/sql/queries", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListQueriesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListQueryObjectsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListVisualizations", + "description": "Gets a list of visualizations on a query.", + "summary": "List visualizations on a query.", + "path": "/api/2.0/sql/queries/{id}/visualizations", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListVisualizationsForQueryRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListVisualizationsForQueryResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Updates a query.", + "summary": "Update a query.", + "path": "/api/2.0/sql/queries/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateQueryRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Query", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_resolve_display_name", + "description": "If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "query", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateQueryRequestQuery", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.QueriesLegacy", + "name": "QueriesLegacy", + "description": "These endpoints are used for CRUD operations on query definitions. Query definitions include\nthe target SQL warehouse, query text, name, description, tags, parameters, and visualizations.\nQueries can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.\n\n**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request.\n\nThe `data_source_id` field specifies the ID of the SQL warehouse to run this query against. You can use the Data Sources API to see a complete list of available SQL warehouses. Or you can copy the `data_source_id` from an existing query.\n\n**Note**: You cannot add a visualization until you create the query.\n\n**Warning**: This API is deprecated. Please use :method:queries/create instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Create a new query definition.", + "path": "/api/2.0/preview/sql/queries", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryPostContent", + "is_object": true + }, + "response": { + "pascal_name": "LegacyQuery", + "is_object": true + }, + "all_fields": [ + { + "name": "data_source_id", + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "General description that conveys additional information about this query such as usage notes.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "parent", + "description": "The identifier of the workspace folder containing the object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query", + "description": "The text of the query to be run.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as_role", + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "is_request_body_field": true, + "entity": { + "pascal_name": "RunAsRole", + "enum": [ + { + "content": "owner" + }, + { + "content": "viewer" + } + ] + } + }, + { + "name": "tags", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "Delete", + "description": "Moves a query to the trash.\nTrashed queries immediately disappear from searches and list views, and they cannot be used for alerts.\nThe trash is deleted after 30 days.\n\n**Warning**: This API is deprecated. Please use :method:queries/delete instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Delete a query.", + "path": "/api/2.0/preview/sql/queries/{query_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteQueriesLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieve a query object definition along with contextual permissions information about the currently authenticated user.\n\n**Warning**: This API is deprecated. Please use :method:queries/get instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get a query definition.", + "path": "/api/2.0/preview/sql/queries/{query_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetQueriesLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LegacyQuery", + "is_object": true + }, + "all_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of queries. Optionally, this list can be filtered by a search term.\n\n**Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.\n\n**Warning**: This API is deprecated. Please use :method:queries/list instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Get a list of queries.", + "path": "/api/2.0/preview/sql/queries", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListQueriesLegacyRequest", + "is_object": true + }, + "response": { + "pascal_name": "QueryList", + "is_object": true + }, + "all_fields": [ + { + "name": "order", + "description": "Name of query attribute to order by. Default sort order is ascending. Append a dash (`-`) to order descending instead.\n\n- `name`: The name of the query.\n\n- `created_at`: The timestamp the query was created.\n\n- `runtime`: The time it took to run this query. This is blank for parameterized queries. A blank value is treated as the highest value for sorting.\n\n- `executed_at`: The timestamp when the query was last run.\n\n- `created_by`: The user name of the user that created the query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page", + "description": "Page number to retrieve.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_size", + "description": "Number of queries to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "q", + "description": "Full text search term", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "offset": { + "name": "page", + "description": "Page number to retrieve.", + "is_query": true, + "entity": { + "is_int": true + } + }, + "limit": { + "name": "page_size", + "description": "Number of queries to return per page.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Restore", + "description": "Restore a query that has been moved to the trash.\nA restored query appears in list views and searches. You can use restored queries for alerts.\n\n**Warning**: This API is deprecated. Please see the latest version. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Restore a query.", + "path": "/api/2.0/preview/sql/queries/trash/{query_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RestoreQueriesLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestoreResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Modify this query definition.\n\n**Note**: You cannot undo this operation.\n\n**Warning**: This API is deprecated. Please use :method:queries/update instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Change a query definition.", + "path": "/api/2.0/preview/sql/queries/{query_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryEditContent", + "is_object": true, + "required_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LegacyQuery", + "is_object": true + }, + "all_fields": [ + { + "name": "data_source_id", + "description": "Data source ID maps to the ID of the data source used by the resource and is distinct from the warehouse ID. [Learn more](https://docs.databricks.com/api/workspace/datasources/list)", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "General description that conveys additional information about this query such as usage notes.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The title of this query that appears in list views, widget headings, and on the query page.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "Exclusively used for storing a list parameter definitions. A parameter is an object with `title`, `name`, `type`, and `value` properties. The `value` field here is the default value. It can be overridden at runtime.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "query", + "description": "The text of the query to be run.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as_role", + "description": "Sets the **Run as** role for the object. Must be set to one of `\"viewer\"` (signifying \"run as viewer\" behavior) or `\"owner\"` (signifying \"run as owner\" behavior)", + "is_request_body_field": true, + "entity": { + "pascal_name": "RunAsRole", + "enum": [ + { + "content": "owner" + }, + { + "content": "viewer" + } + ] + } + }, + { + "name": "tags", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "query_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.QueryHistory", + "name": "QueryHistory", + "description": "A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute.", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "List", + "description": "List the history of queries through SQL warehouses, and serverless compute.\n\nYou can filter by user ID, warehouse ID, status, and time range.\nMost recently started queries are returned first (up to max_results in request).\nThe pagination token returned in response can be used to list subsequent query statuses.", + "summary": "List Queries.", + "path": "/api/2.0/sql/history/queries", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListQueryHistoryRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListQueriesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter_by", + "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", + "is_query": true, + "is_optional_object": true, + "entity": { + "pascal_name": "QueryFilter", + "is_object": true + } + }, + { + "name": "include_metrics", + "description": "Whether to include the query metrics with each query.\nOnly use this for a small subset of queries (max_results).\nDefaults to false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Limit the number of results returned in one page. Must be less than 1000 and the default is 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.QueryVisualizations", + "name": "QueryVisualizations", + "description": "This is an evolving API that facilitates the addition and removal of visualizations from existing queries in the Databricks Workspace. Data structures can change over time.", + "package": { + "name": "sql" + }, + "is_hidden_cli": true, + "docs_group": "sql", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "Create", + "description": "Adds a visualization to a query.", + "summary": "Add a visualization to a query.", + "path": "/api/2.0/sql/visualizations", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateVisualizationRequest", + "is_object": true + }, + "response": { + "pascal_name": "Visualization", + "is_object": true + }, + "all_fields": [ + { + "name": "visualization", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateVisualizationRequestVisualization", + "is_object": true + } + } + ] + }, + { + "name": "Delete", + "description": "Removes a visualization.", + "summary": "Remove a visualization.", + "path": "/api/2.0/sql/visualizations/{id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteVisualizationRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Empty", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates a visualization.", + "summary": "Update a visualization.", + "path": "/api/2.0/sql/visualizations/{id}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateVisualizationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Visualization", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "visualization", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateVisualizationRequestVisualization", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.QueryVisualizationsLegacy", + "name": "QueryVisualizationsLegacy", + "description": "This is an evolving API that facilitates the addition and removal of vizualisations from existing\nqueries within the Databricks Workspace. Data structures may change over time.\n\n**Warning**: This API is deprecated. Please see the latest version of the Databricks SQL API. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "package": { + "name": "sql" + }, + "is_hidden_cli": true, + "docs_group": "sql", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "Create", + "description": "Creates visualization in the query.\n\n**Warning**: This API is deprecated. Please use :method:queryvisualizations/create instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Add visualization to a query.", + "path": "/api/2.0/preview/sql/visualizations", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateQueryVisualizationsLegacyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "options", + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "query_id", + "description": "The identifier returned by :method:queries/create", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of visualization: chart, table, pivot table, and so on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "options", + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "query_id", + "description": "The identifier returned by :method:queries/create", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of visualization: chart, table, pivot table, and so on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "LegacyVisualization", + "is_object": true + }, + "all_fields": [ + { + "name": "description", + "description": "A short description of this visualization. This is not displayed in the UI.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the visualization that appears on dashboards and the query screen.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "query_id", + "description": "The identifier returned by :method:queries/create", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of visualization: chart, table, pivot table, and so on.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Removes a visualization from the query.\n\n**Warning**: This API is deprecated. Please use :method:queryvisualizations/delete instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Remove visualization.", + "path": "/api/2.0/preview/sql/visualizations/{id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteQueryVisualizationsLegacyRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:queryvisualizations/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:queryvisualizations/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Widget ID returned by :method:queryvisualizations/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Widget ID returned by :method:queryvisualizations/create", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates visualization in the query.\n\n**Warning**: This API is deprecated. Please use :method:queryvisualizations/update instead. [Learn more](https://docs.databricks.com/en/sql/dbsql-api-latest.html)", + "summary": "Edit existing visualization.", + "path": "/api/2.0/preview/sql/visualizations/{id}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "LegacyVisualization", + "is_object": true + }, + "response": { + "pascal_name": "LegacyVisualization", + "is_object": true + }, + "all_fields": [ + { + "name": "created_at", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "A short description of this visualization. This is not displayed in the UI.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "The UUID for this visualization.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the visualization that appears on dashboards and the query screen.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "options", + "description": "The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "query", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "LegacyQuery", + "is_object": true + } + }, + { + "name": "type", + "description": "The type of visualization: chart, table, pivot table, and so on.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_at", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sharing.RecipientActivation", + "name": "RecipientActivation", + "description": "The Recipient Activation API is only applicable in the open sharing model where the\nrecipient object has the authentication type of `TOKEN`. The data recipient follows\nthe activation link shared by the data provider to download the credential file that\nincludes the access token. The recipient will then use the credential file to establish\na secure connection with the provider to receive the shared data.\n\nNote that you can download the credential file only once. Recipients should treat the\ndownloaded credential as a secret and must not share it outside of their organization.", + "package": { + "name": "sharing" + }, + "docs_group": "sharing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GetActivationUrlInfo", + "description": "Gets an activation URL for a share.", + "summary": "Get a share activation URL.", + "path": "/api/2.1/unity-catalog/public/data_sharing_activation_info/{activation_url}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetActivationUrlInfoRequest", + "is_object": true, + "required_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetActivationUrlInfoResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RetrieveToken", + "description": "Retrieve access token with an activation url.\nThis is a public API without any authentication.", + "summary": "Get an access token.", + "path": "/api/2.1/unity-catalog/public/data_sharing_activation/{activation_url}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RetrieveTokenRequest", + "is_object": true, + "required_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RetrieveTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "activation_url", + "description": "The one time activation url. It also accepts activation token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sharing.RecipientFederationPolicies", + "name": "RecipientFederationPolicies", + "description": "The Recipient Federation Policies APIs are only applicable in the open sharing model where the recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from Databricks to non-Databricks recipients.\nOIDC Token Federation enables secure, secret-less authentication for accessing Delta Sharing servers. Users and applications authenticate using short-lived OIDC tokens issued by their own Identity Provider (IdP), such as Azure Entra ID or Okta, without the need for managing static credentials or client secrets.\nA federation policy defines how non-Databricks recipients authenticate using OIDC tokens. It validates the OIDC claims in federated tokens and is set at the recipient level. The caller must be the owner of the recipient to create or manage a federation policy.\nFederation policies support the following scenarios:\n- User-to-Machine (U2M) flow: A user accesses Delta Shares using their own identity, such as connecting through PowerBI Delta Sharing Client.\n- Machine-to-Machine (M2M) flow: An application accesses Delta Shares using its own identity, typically for automation tasks like nightly jobs through Python Delta Sharing Client.\nOIDC Token Federation enables fine-grained access control, supports Multi-Factor Authentication (MFA), and enhances security by minimizing the risk of credential leakage through the use of short-lived, expiring tokens. It is designed for strong identity governance, secure cross-platform data sharing, and reduced operational overhead for credential management.\n\nFor more information, see https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security and https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed", + "package": { + "name": "sharing" + }, + "docs_group": "sharing", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListFederationPoliciesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients.\nThe caller must be the owner of the recipient.\nWhen sharing data from Databricks to non-Databricks clients,\nyou can define a federation policy to authenticate non-Databricks recipients.\nThe federation policy validates OIDC claims in federated tokens and is defined at the recipient level.\nThis enables secretless sharing clients to authenticate using OIDC tokens.\n\nSupported scenarios for federation policies:\n1. **User-to-Machine (U2M) flow** (e.g., PowerBI): A user accesses a resource using their own identity.\n2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An OAuth App accesses a resource using its own identity,\ntypically for tasks like running nightly jobs.\n\nFor an overview, refer to:\n- Blog post: Overview of feature: https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security\n\nFor detailed configuration guides based on your use case:\n- Creating a Federation Policy as a provider: https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed\n- Configuration and usage for Machine-to-Machine (M2M) applications (e.g., Python Delta Sharing Client): https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-m2m\n- Configuration and usage for User-to-Machine (U2M) applications (e.g., PowerBI): https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-u2m", + "summary": "Create recipient federation policy.", + "path": "/api/2.0/data-sharing/recipients/{recipient_name}/federation-policies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateFederationPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being created.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy", + "description": "Name of the policy. This is the name of the policy to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being created.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "description": "Name of the policy. This is the name of the policy to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "description": "Name of the policy. This is the name of the policy to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "description": "Name of the policy. This is the name of the policy to be created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being created.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "Description of the policy. This is a user-provided description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "System-generated timestamp indicating when the policy was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique, immutable system-generated identifier for the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the federation policy. A recipient can have multiple policies with different names.\nThe name must contain only lowercase alphanumeric characters, numbers, and hyphens.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oidc_policy", + "description": "Specifies the policy to use for validating OIDC claims in the federated tokens.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OidcFederationPolicy", + "is_object": true + } + }, + { + "name": "update_time", + "description": "System-generated timestamp indicating when the policy was last updated.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being created.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes an existing federation policy for an OIDC_FEDERATION recipient.\nThe caller must be the owner of the recipient.", + "summary": "Delete recipient federation policy.", + "path": "/api/2.0/data-sharing/recipients/{recipient_name}/federation-policies/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetFederationPolicy", + "description": "Reads an existing federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients.\nThe caller must have read access to the recipient.", + "summary": "Get recipient federation policy.", + "path": "/api/2.0/data-sharing/recipients/{recipient_name}/federation-policies/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policy is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the policy. This is the name of the policy to be retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists federation policies for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients.\nThe caller must have read access to the recipient.", + "summary": "List recipient federation policies.", + "path": "/api/2.0/data-sharing/recipients/{recipient_name}/federation-policies", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListFederationPoliciesRequest", + "is_object": true, + "required_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policies are being listed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policies are being listed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListFederationPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policies are being listed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "recipient_name", + "description": "Name of the recipient. This is the name of the recipient for which the policies are being listed.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "sharing.Recipients", + "name": "Recipients", + "description": "A recipient is an object you create using :method:recipients/create to represent an\norganization which you want to allow access shares. The way how sharing works differs\ndepending on whether or not your recipient has access to a Databricks workspace that is\nenabled for Unity Catalog:\n\n- For recipients with access to a Databricks workspace that is enabled for Unity Catalog,\nyou can create a recipient object along with a unique sharing identifier you get from the\nrecipient. The sharing identifier is the key identifier that enables the secure connection.\nThis sharing mode is called **Databricks-to-Databricks sharing**.\n\n- For recipients without access to a Databricks workspace that is enabled for Unity Catalog,\nwhen you create a recipient object, Databricks generates an activation link you can send\nto the recipient. The recipient follows the activation link to download the credential file,\nand then uses the credential file to establish a secure connection to receive the shared data.\nThis sharing mode is called **open sharing**.", + "package": { + "name": "sharing" + }, + "docs_group": "sharing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListRecipientsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new recipient with the delta sharing authentication type in the metastore.\nThe caller must be a metastore admin or have the **CREATE_RECIPIENT** privilege on the metastore.", + "summary": "Create a share recipient.", + "path": "/api/2.1/unity-catalog/recipients", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateRecipient", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of Recipient.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of Recipient.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "RecipientInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + }, + { + "name": "comment", + "description": "Description about the recipient.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "data_recipient_global_metastore_id", + "description": "The global Unity Catalog metastore id provided by the data recipient.\nThis field is only present when the __authentication_type__ is **DATABRICKS**.\nThe identifier is of format __cloud__:__region__:__metastore-uuid__.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "expiration_time", + "description": "Expiration timestamp of the token, in epoch milliseconds.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "id", + "description": "[Create,Update:IGN] common - id of the recipient", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_access_list", + "description": "IP Access List", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IpAccessList", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of Recipient.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of the recipient owner.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties_kvpairs", + "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SecurablePropertiesKvPairs", + "is_object": true + } + }, + { + "name": "sharing_code", + "description": "The one-time sharing code provided by the data recipient. This field is only present when the __authentication_type__ is **DATABRICKS**.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of Recipient.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "authentication_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AuthenticationType", + "enum": [ + { + "content": "DATABRICKS" + }, + { + "content": "OAUTH_CLIENT_CREDENTIALS" + }, + { + "content": "OIDC_FEDERATION" + }, + { + "content": "TOKEN" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the specified recipient from the metastore. The caller must be the owner of the recipient.", + "summary": "Delete a share recipient.", + "path": "/api/2.1/unity-catalog/recipients/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRecipientRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a share recipient from the metastore. The caller must be one of:\n* A user with **USE_RECIPIENT** privilege on the metastore\n* The owner of the share recipient\n* A metastore admin", + "summary": "Get a share recipient.", + "path": "/api/2.1/unity-catalog/recipients/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRecipientRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RecipientInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of all share recipients within the current metastore where:\n\n* the caller is a metastore admin, or\n* the caller is the owner.\nThere is no guarantee of a specific ordering of the elements in the array.", + "summary": "List share recipients.", + "path": "/api/2.1/unity-catalog/recipients", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListRecipientsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListRecipientsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "data_recipient_global_metastore_id", + "description": "If not provided, all recipients will be returned.\nIf no recipients exist with this ID, no results will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_results", + "description": "Maximum number of recipients to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid recipients are returned (not recommended).\n- Note: The number of returned recipients might be less than the specified max_results size, even zero.\nThe only definitive indication that no further recipients can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of recipients to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid recipients are returned (not recommended).\n- Note: The number of returned recipients might be less than the specified max_results size, even zero.\nThe only definitive indication that no further recipients can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "RotateToken", + "description": "Refreshes the specified recipient's delta sharing authentication token with the provided token info.\nThe caller must be the owner of the recipient.", + "summary": "Rotate a token.", + "path": "/api/2.1/unity-catalog/recipients/{name}/rotate-token", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RotateRecipientToken", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "existing_token_expire_in_seconds", + "description": "The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time\nof existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to\nexpire the existing token immediately, negative number will return an error.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "existing_token_expire_in_seconds", + "description": "The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time\nof existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to\nexpire the existing token immediately, negative number will return an error.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "RecipientInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "existing_token_expire_in_seconds", + "description": "The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time\nof existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to\nexpire the existing token immediately, negative number will return an error.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "existing_token_expire_in_seconds", + "description": "The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time\nof existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to\nexpire the existing token immediately, negative number will return an error.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "SharePermissions", + "description": "Gets the share permissions for the specified Recipient. The caller must have the **USE_RECIPIENT** privilege on the metastore or be the owner of the Recipient.", + "summary": "Get recipient share permissions.", + "path": "/api/2.1/unity-catalog/recipients/{name}/share-permissions", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SharePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetRecipientSharePermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of permissions to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid permissions are returned (not recommended).\n- Note: The number of returned permissions might be less than the specified max_results size, even zero.\nThe only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient.\nIf the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient.", + "summary": "Update a share recipient.", + "path": "/api/2.1/unity-catalog/recipients/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateRecipient", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RecipientInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "Description about the recipient.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "expiration_time", + "description": "Expiration timestamp of the token, in epoch milliseconds.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "id", + "description": "[Create,Update:IGN] common - id of the recipient", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "ip_access_list", + "description": "IP Access List", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IpAccessList", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the recipient.\n.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of the recipient owner.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties_kvpairs", + "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SecurablePropertiesKvPairs", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sql.RedashConfig", + "name": "RedashConfig", + "description": "Redash V2 service for workspace configurations (internal)", + "package": { + "name": "sql" + }, + "is_hidden_cli": true, + "docs_group": "sql", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "methods": [ + { + "name": "GetConfig", + "description": "Read workspace configuration for Redash-v2.", + "summary": "Read workspace configuration for Redash-v2.", + "path": "/api/2.0/redash-v2/config", + "is_legacy_empty_request": true, + "is_crud_read": true, + "is_hidden_cli": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetConfigRequest", + "is_object": true + }, + "response": { + "pascal_name": "ClientConfig", + "is_object": true + } + } + ] + }, + { + "id": "catalog.RegisteredModels", + "name": "RegisteredModels", + "description": "Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.\nModels in Unity Catalog provide centralized access control, auditing, lineage, and discovery of\nML models across Databricks workspaces.\n\nAn MLflow registered model resides in the third layer of Unity Catalog’s three-level namespace.\nRegistered models contain model versions, which correspond to actual ML models (MLflow models). Creating new\nmodel versions currently requires use of the MLflow Python client. Once model versions are created, you can\nload them for batch inference using MLflow Python client APIs, or deploy them for real-time serving using\nDatabricks Model Serving.\n\nAll operations on registered models and model versions require USE_CATALOG permissions on the enclosing catalog\nand USE_SCHEMA permissions on the enclosing schema. In addition, the following additional privileges are\nrequired for various operations:\n\n* To create a registered model, users must additionally have the CREATE_MODEL permission on the target schema.\n* To view registered model or model version metadata, model version data files, or invoke a model version,\nusers must additionally have the EXECUTE permission on the registered model\n* To update registered model or model version tags, users must additionally have APPLY TAG permissions on the registered model\n* To update other registered model or model version metadata (comments, aliases)\ncreate a new model version, or update permissions on the registered model, users must be owners of the\nregistered model.\n\nNote: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants) that specify\na securable type, use FUNCTION as the securable type.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "RegisteredModelInfoNameToFullNameMap" + }, + "request": { + "pascal_name": "ListRegisteredModelsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new registered model in Unity Catalog.\n\nFile storage for model versions in the registered model\nwill be located in the default location which is specified by the parent schema,\nor the parent catalog, or the Metastore.\n\nFor registered model creation to succeed, the user must satisfy the following conditions:\n- The caller must be a metastore admin, or be the owner of the parent catalog and schema,\nor have the **USE_CATALOG** privilege on the parent catalog\nand the **USE_SCHEMA** privilege on the parent schema.\n- The caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on the parent schema.", + "summary": "Create a Registered Model.", + "path": "/api/2.1/unity-catalog/models", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateRegisteredModelRequest", + "is_object": true + }, + "response": { + "pascal_name": "RegisteredModelInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aliases", + "description": "List of aliases associated with the registered model", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegisteredModelAliasList", + "array_value": { + "pascal_name": "RegisteredModelAlias", + "is_object": true + } + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the registered model reside", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "The comment attached to the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "The identifier of the user who created the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The unique identifier of the metastore", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The identifier of the user who owns the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the registered model resides", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_location", + "description": "The storage location on the cloud under which model version data files are stored", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_at", + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "updated_by", + "description": "The identifier of the user who updated the registered model last time", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a registered model and all its model versions from the specified parent catalog and schema.\n\nThe caller must be a metastore admin or an owner of the registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Delete a Registered Model.", + "path": "/api/2.1/unity-catalog/models/{full_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRegisteredModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteAlias", + "description": "Deletes a registered model alias.\n\nThe caller must be a metastore admin or an owner of the registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Delete a Registered Model Alias.", + "path": "/api/2.1/unity-catalog/models/{full_name}/aliases/{alias}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAliasRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a registered model.\n\nThe caller must be a metastore admin or an owner of (or have the **EXECUTE**\nprivilege on) the registered model. For the latter case, the caller must also be the owner\nor have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege\non the parent schema.", + "summary": "Get a Registered Model.", + "path": "/api/2.1/unity-catalog/models/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRegisteredModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_aliases", + "description": "Whether to include registered model aliases in the response", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_browse", + "description": "Whether to include registered models in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List registered models. You can list registered models under a particular schema,\nor list all registered models in the current metastore.\n\nThe returned models are filtered based on the privileges of the calling user.\nFor example, the metastore admin is able to list all the registered models.\nA regular user needs to be the owner or have the **EXECUTE** privilege\non the registered model to recieve the registered models in the response.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nThere is no guarantee of a specific ordering of the elements in the response.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List Registered Models.", + "path": "/api/2.1/unity-catalog/models", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListRegisteredModelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListRegisteredModelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "The identifier of the catalog under which to list registered models.\nIf specified, schema_name must be specified.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include registered models in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Max number of registered models to return.\n\nIf both catalog and schema are specified:\n- when max_results is not specified, the page length is set to a server configured value (10000, as of 4/2/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 4/2/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 4/2/2024);\n- when set to a value less than 0, an invalid parameter error is returned;\n\nIf neither schema nor catalog is specified:\n- when max_results is not specified, the page length is set to a server configured value (100, as of 4/2/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (1000, as of 4/2/2024);\n- when set to 0, the page length is set to a server configured value (100, as of 4/2/2024);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token to send for the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The identifier of the schema under which to list registered models.\nIf specified, catalog_name must be specified.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque token to send for the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetAlias", + "description": "Set an alias on the specified registered model.\n\nThe caller must be a metastore admin or an owner of the registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Set a Registered Model Alias.", + "path": "/api/2.1/unity-catalog/models/{full_name}/aliases/{alias}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetRegisteredModelAliasRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_num", + "description": "The version number of the model version to which the alias points", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "version_num", + "description": "The version number of the model version to which the alias points", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelAlias", + "is_object": true + }, + "all_fields": [ + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_num", + "description": "The version number of the model version to which the alias points", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "The name of the alias", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "version_num", + "description": "The version number of the model version to which the alias points", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the specified registered model.\n\nThe caller must be a metastore admin or an owner of the registered model.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nCurrently only the name, the owner or the comment of the registered model can be updated.", + "summary": "Update a Registered Model.", + "path": "/api/2.1/unity-catalog/models/{full_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateRegisteredModelRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RegisteredModelInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aliases", + "description": "List of aliases associated with the registered model", + "is_request_body_field": true, + "entity": { + "pascal_name": "RegisteredModelAliasList", + "array_value": { + "pascal_name": "RegisteredModelAlias", + "is_object": true + } + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the registered model reside", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "The comment attached to the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "created_at", + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by", + "description": "The identifier of the user who created the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The unique identifier of the metastore", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the registered model.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The identifier of the user who owns the registered model", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the registered model resides", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_location", + "description": "The storage location on the cloud under which model version data files are stored", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updated_at", + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "updated_by", + "description": "The identifier of the user who updated the registered model last time", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the registered model", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "workspace.Repos", + "name": "Repos", + "description": "The Repos API allows users to manage their git repos. Users can use the API to access all\nrepos that they have manage permissions on.\n\nDatabricks Repos is a visual Git client in Databricks. It supports common Git operations\nsuch a cloning a repository, committing and pushing, pulling, branch management, and visual\ncomparison of diffs when committing.\n\nWithin Repos you can develop code in notebooks or other files and follow data science and\nengineering code development best practices using Git for version control, collaboration,\nand CI/CD.", + "package": { + "name": "workspace" + }, + "docs_group": "workspace", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "RepoInfoPathToIdMap" + }, + "request": { + "pascal_name": "ListReposRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a repo in the workspace and links it to the remote Git repo specified.\nNote that repos created programmatically must be linked to a remote Git repo, unlike repos\ncreated in the browser.", + "summary": "Create a repo.", + "path": "/api/2.0/repos", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateRepoRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "url", + "description": "URL of the Git repository to be linked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "url", + "description": "URL of the Git repository to be linked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateRepoResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "path", + "description": "Desired path for the repo in the workspace. Almost any path in the workspace can be chosen.\nIf repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "sparse_checkout", + "description": "If specified, the repo will be created with sparse checkout enabled. You cannot enable/disable\nsparse checkout after the repo is created.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SparseCheckout", + "is_object": true + } + }, + { + "name": "url", + "description": "URL of the Git repository to be linked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "url", + "description": "URL of the Git repository to be linked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "provider", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`\n(deprecated by AWS, not accepting new customers).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the specified repo.", + "summary": "Delete a repo.", + "path": "/api/2.0/repos/{repo_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteRepoRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "The ID for the corresponding repo to delete.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "The ID for the corresponding repo to delete.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteRepoResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "repo_id", + "description": "The ID for the corresponding repo to delete.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "The ID for the corresponding repo to delete.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Returns the repo with the given repo ID.", + "summary": "Get a repo.", + "path": "/api/2.0/repos/{repo_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRepoRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "GetRepoResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get repo permission levels.", + "path": "/api/2.0/permissions/repos/{repo_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRepoPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetRepoPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a repo. Repos can inherit permissions from their root object.", + "summary": "Get repo permissions.", + "path": "/api/2.0/permissions/repos/{repo_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetRepoPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RepoPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Returns repos that the calling user has Manage permissions on.\nUse `next_page_token` to iterate through additional pages.", + "summary": "Get repos.", + "path": "/api/2.0/repos", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListReposRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListReposResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "next_page_token", + "description": "Token used to get the next page of results. If not specified, returns the first page of\nresults as well as a next page token if there are more results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "path_prefix", + "description": "Filters repos that have paths starting with the given path prefix.\nIf not provided or when provided an effectively empty prefix (`/` or `/Workspace`)\nGit folders (repos) from `/Workspace/Repos` will be served.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "next_page_token", + "description": "Token used to get the next page of results. If not specified, returns the first page of\nresults as well as a next page token if there are more results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set repo permissions.", + "path": "/api/2.0/permissions/repos/{repo_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RepoPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RepoPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "RepoAccessControlRequestList", + "array_value": { + "pascal_name": "RepoAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the repo to a different branch or tag, or updates the repo to the latest commit on\nthe same branch.", + "summary": "Update a repo.", + "path": "/api/2.0/repos/{repo_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateRepoRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateRepoResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "branch", + "description": "Branch that the local version of the repo is checked out to.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "sparse_checkout", + "description": "If specified, update the sparse checkout settings. The update will fail if sparse checkout is\nnot enabled for the repo.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "SparseCheckoutUpdate", + "is_object": true + } + }, + { + "name": "tag", + "description": "Tag that the local version of the repo is checked out to. Updating the repo to a tag puts\nthe repo in a detached HEAD state. Before committing new changes, you must update the repo to\na branch instead of the detached HEAD.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "ID of the Git folder (repo) object in the workspace.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a repo. Repos can inherit permissions from their root object.", + "summary": "Update repo permissions.", + "path": "/api/2.0/permissions/repos/{repo_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RepoPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RepoPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "RepoAccessControlRequestList", + "array_value": { + "pascal_name": "RepoAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "repo_id", + "description": "The repo for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.ResourceQuotas", + "name": "ResourceQuotas", + "description": "Unity Catalog enforces resource quotas on all securable objects, which limits the number of resources that can be created. Quotas are expressed in terms of a resource type and a parent (for example, tables per metastore or schemas per catalog). The resource quota APIs enable you to monitor your current usage and limits. For more information on resource quotas see the [Unity Catalog documentation](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#resource-quotas).", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListQuotasRequest" + } + }, + "methods": [ + { + "name": "GetQuota", + "description": "The GetQuota API returns usage information for a single resource quota, defined as a\nchild-parent pair. This API also refreshes the quota count if it is out of date.\nRefreshes are triggered asynchronously. The updated count might not be returned in the first call.", + "summary": "Get information for a single resource quota.", + "path": "/api/2.1/unity-catalog/resource-quotas/{parent_securable_type}/{parent_full_name}/{quota_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetQuotaRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent_securable_type", + "description": "Securable type of the quota parent.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_full_name", + "description": "Full name of the parent resource. Provide the metastore ID if the parent is a metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quota_name", + "description": "Name of the quota. Follows the pattern of the quota type, with \"-quota\" added as a suffix.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent_securable_type", + "description": "Securable type of the quota parent.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_full_name", + "description": "Full name of the parent resource. Provide the metastore ID if the parent is a metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quota_name", + "description": "Name of the quota. Follows the pattern of the quota type, with \"-quota\" added as a suffix.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetQuotaResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "parent_full_name", + "description": "Full name of the parent resource. Provide the metastore ID if the parent is a metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_securable_type", + "description": "Securable type of the quota parent.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quota_name", + "description": "Name of the quota. Follows the pattern of the quota type, with \"-quota\" added as a suffix.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent_securable_type", + "description": "Securable type of the quota parent.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent_full_name", + "description": "Full name of the parent resource. Provide the metastore ID if the parent is a metastore.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "quota_name", + "description": "Name of the quota. Follows the pattern of the quota type, with \"-quota\" added as a suffix.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListQuotas", + "description": "ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the counts\nreturned. This API does not trigger a refresh of quota counts.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List all resource quotas under a metastore.", + "path": "/api/2.1/unity-catalog/resource-quotas/all-resource-quotas", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListQuotasRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListQuotasResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "The number of quotas to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token for the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque token for the next page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "settings.RestrictWorkspaceAdmins", + "name": "RestrictWorkspaceAdmins", + "description": "The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.\nWith the setting status set to ALLOW_ALL, workspace admins can create service principal personal access\ntokens on behalf of any service principal in their workspace. Workspace admins can also change a job owner to\nany user in their workspace. And they can change the job run_as setting to any user in their workspace or to a\nservice principal on which they have the Service Principal User role. With the setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS,\nworkspace admins can only create personal access tokens on behalf of service principals they have the\nService Principal User role on. They can also only change a job owner to themselves. And they can change the job\nrun_as setting to themselves or to a service principal on which they have the Service Principal User role.", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs\nto be provided in `DELETE` requests (as a query parameter). The etag can be retrieved by making a `GET` request\nbefore the DELETE request. If the setting is updated/deleted concurrently, `DELETE` fails with 409 and the\nrequest must be retried by using the fresh etag in the 409 response.", + "summary": "Delete the restrict workspace admins setting.", + "path": "/api/2.0/settings/types/restrict_workspace_admins/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteRestrictWorkspaceAdminsSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteRestrictWorkspaceAdminsSettingResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the restrict workspace admins setting.", + "summary": "Get the restrict workspace admins setting.", + "path": "/api/2.0/settings/types/restrict_workspace_admins/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetRestrictWorkspaceAdminsSettingRequest", + "is_object": true + }, + "response": { + "pascal_name": "RestrictWorkspaceAdminsSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "restrict_workspace_admins", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "restrict_workspace_admins", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the restrict workspace admins setting for the workspace. A fresh etag needs\nto be provided in `PATCH` requests (as part of the setting field). The etag can be retrieved by making a GET\nrequest before the `PATCH` request. If the setting is updated concurrently, `PATCH` fails with 409 and the\nrequest must be retried by using the fresh etag in the 409 response.", + "summary": "Update the restrict workspace admins setting.", + "path": "/api/2.0/settings/types/restrict_workspace_admins/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateRestrictWorkspaceAdminsSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsSetting", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RestrictWorkspaceAdminsSetting", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "restrict_workspace_admins", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "restrict_workspace_admins", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsSetting", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "catalog.Rfa", + "name": "Rfa", + "description": "Request for Access enables users to request access for Unity Catalog securables.\n\nThese APIs provide a standardized way for securable owners (or users with MANAGE privileges) to manage access request destinations.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "BatchCreateAccessRequests", + "description": "Creates access requests for Unity Catalog permissions for a specified principal on a securable object.\nThis Batch API can take in multiple principals, securable objects,\nand permissions as the input and returns the access request destinations for each.\nPrincipals must be unique across the API call.\n\nThe supported securable types are: \"metastore\", \"catalog\", \"schema\", \"table\",\n\"external_location\", \"connection\", \"credential\", \"function\", \"registered_model\", and \"volume\".", + "summary": "Create Access Requests.", + "path": "/api/3.0/rfa/requests", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "BatchCreateAccessRequestsRequest", + "is_object": true + }, + "response": { + "pascal_name": "BatchCreateAccessRequestsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "requests", + "description": "A list of individual access requests, where each request corresponds to\na set of permissions being requested on a list of securables for a specified principal.\n\nAt most 30 requests per API call.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateAccessRequestList", + "array_value": { + "pascal_name": "CreateAccessRequest", + "is_object": true + } + } + } + ] + }, + { + "name": "GetAccessRequestDestinations", + "description": "Gets an array of access request destinations for the specified securable.\nAny caller can see URL destinations or the destinations on the metastore.\nOtherwise, only those with **BROWSE** permissions on the securable can see destinations.\n\nThe supported securable types are: \"metastore\", \"catalog\", \"schema\", \"table\",\n\"external_location\", \"connection\", \"credential\", \"function\", \"registered_model\", and \"volume\".", + "summary": "Get Access Request Destinations.", + "path": "/api/3.0/rfa/destinations/{securable_type}/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetAccessRequestDestinationsRequest", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "The type of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The full name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "The type of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The full name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccessRequestDestinations", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "full_name", + "description": "The full name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "The type of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "The type of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The full name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateAccessRequestDestinations", + "description": "Updates the access request destinations for the given securable.\nThe caller must be a metastore admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable in order to assign destinations.\nDestinations cannot be updated for securables underneath schemas (tables, volumes, functions, and models). For these securable types, destinations are inherited from the parent securable.\nA maximum of 5 emails and 5 external notification destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be assigned to a securable.\nIf a URL destination is assigned, no other destinations can be set.\n\nThe supported securable types are: \"metastore\", \"catalog\", \"schema\", \"table\",\n\"external_location\", \"connection\", \"credential\", \"function\", \"registered_model\", and \"volume\".", + "summary": "Update Access Request Destinations.", + "path": "/api/3.0/rfa/destinations", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateAccessRequestDestinationsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "access_request_destinations", + "description": "The access request destinations to assign to the securable.\nFor each destination, a **destination_id** and **destination_type** must be defined.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessRequestDestinations", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "access_request_destinations", + "description": "The access request destinations to assign to the securable.\nFor each destination, a **destination_id** and **destination_type** must be defined.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessRequestDestinations", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "access_request_destinations", + "description": "The access request destinations to assign to the securable.\nFor each destination, a **destination_id** and **destination_type** must be defined.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessRequestDestinations", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ] + } + }, + "response": { + "pascal_name": "AccessRequestDestinations", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "access_request_destinations", + "description": "The access request destinations to assign to the securable.\nFor each destination, a **destination_id** and **destination_type** must be defined.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AccessRequestDestinations", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "are_any_destinations_hidden", + "description": "Indicates whether any destinations are hidden from the caller due to a lack of permissions.\nThis value is true if the caller does not have permission to see all destinations.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "destination_source_securable", + "description": "The source securable from which the destinations are inherited. Either the same value as securable (if destination\nis set directly on the securable) or the nearest parent securable with destinations set.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + }, + { + "name": "destinations", + "description": "The access request destinations for the securable.", + "is_request_body_field": true, + "entity": { + "pascal_name": "NotificationDestinationList", + "array_value": { + "pascal_name": "NotificationDestination", + "is_object": true + } + } + }, + { + "name": "full_name", + "description": "The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + }, + { + "name": "securable_type", + "description": "The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable", + "description": "The securable for which the access request destinations are being modified or read.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Securable", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "catalog.Schemas", + "name": "Schemas", + "description": "A schema (also called a database) is the second layer of Unity Catalog’s three-level\nnamespace. A schema organizes tables, views and functions. To access (or list) a table or view in\na schema, users must have the USE_SCHEMA data permission on the schema and its parent catalog,\nand they must have the SELECT permission on the table or view.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListSchemasRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new schema for catalog in the Metastore.\nThe caller must be a metastore admin, or have the **CREATE_SCHEMA** privilege in the parent catalog.", + "summary": "Create a schema.", + "path": "/api/2.1/unity-catalog/schemas", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateSchema", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of schema, relative to parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of schema, relative to parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SchemaInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of schema, relative to parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "storage_root", + "description": "Storage root URL for managed tables within schema.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of schema, relative to parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes the specified schema from the parent catalog.\nThe caller must be the owner of the schema or an owner of the parent catalog.", + "summary": "Delete a schema.", + "path": "/api/2.1/unity-catalog/schemas/{full_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteSchemaRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the schema is not empty.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the specified schema within the metastore.\nThe caller must be a metastore admin, the owner of the schema, or a user that has the **USE_SCHEMA** privilege on the schema.", + "summary": "Get a schema.", + "path": "/api/2.1/unity-catalog/schemas/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetSchemaRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SchemaInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of schemas for a catalog in the metastore.\nIf the caller is the metastore admin or the owner of the parent catalog, all schemas for the catalog will be retrieved.\nOtherwise, only schemas owned by the caller (or for which the caller has the **USE_SCHEMA** privilege) will be retrieved.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List schemas.", + "path": "/api/2.1/unity-catalog/schemas", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSchemasRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Parent catalog for schemas of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Parent catalog for schemas of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSchemasResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Parent catalog for schemas of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of schemas to return.\nIf not set, all the schemas are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Parent catalog for schemas of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of schemas to return.\nIf not set, all the schemas are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin.\nIf the caller is a metastore admin, only the __owner__ field can be changed in the update.\nIf the __name__ field must be updated, the caller must be a metastore admin or have the **CREATE_SCHEMA** privilege on the parent catalog.", + "summary": "Update a schema.", + "path": "/api/2.1/unity-catalog/schemas/{full_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateSchema", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SchemaInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_predictive_optimization", + "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EnablePredictiveOptimization", + "enum": [ + { + "content": "DISABLE" + }, + { + "content": "ENABLE" + }, + { + "content": "INHERIT" + } + ] + } + }, + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the schema.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of schema.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "workspace.Secrets", + "name": "Secrets", + "description": "The Secrets API allows you to manage secrets, secret scopes, and access permissions.\n\nSometimes accessing data requires that you authenticate to external data sources through JDBC.\nInstead of directly entering your credentials into a notebook, use Databricks secrets to store\nyour credentials and reference them in notebooks and jobs.\n\nAdministrators, secret creators, and users granted permission can read Databricks secrets.\nWhile Databricks makes an effort to redact secret values that might be displayed in notebooks,\nit is not possible to prevent such users from reading secrets.", + "package": { + "name": "workspace" + }, + "docs_group": "workspace", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListSecretsRequest" + } + }, + "methods": [ + { + "name": "CreateScope", + "description": "Creates a new secret scope.\n\nThe scope name must consist of alphanumeric characters, dashes, underscores, and\nperiods, and may not exceed 128 characters.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-simple-databricks-scope\",\n\"initial_manage_principal\": \"users\"\n\"scope_backend_type\": \"databricks|azure_keyvault\",\n# below is only required if scope type is azure_keyvault\n\"backend_azure_keyvault\": {\n\"resource_id\": \"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx\",\n\"tenant_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\"dns_name\": \"https://xxxx.vault.azure.net/\",\n}\n}\n\nIf ``initial_manage_principal`` is specified, the initial ACL applied to the scope is\napplied to the supplied principal (user or group) with ``MANAGE`` permissions.\nThe only supported principal for this option is the group ``users``, which\ncontains all users in the workspace. If ``initial_manage_principal`` is not specified,\nthe initial ACL with ``MANAGE`` permission applied to the scope is assigned to the\nAPI request issuer's user identity.\n\nIf ``scope_backend_type`` is ``azure_keyvault``, a secret scope is created with secrets\nfrom a given Azure KeyVault. The caller must provide the keyvault_resource_id and the tenant_id\nfor the key vault. If ``scope_backend_type`` is ``databricks`` or is unspecified, an empty\nsecret scope is created and stored in Databricks's own storage.\n\nThrows ``RESOURCE_ALREADY_EXISTS`` if a scope with the given name already exists.\nThrows ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of scopes in the workspace is exceeded.\nThrows ``INVALID_PARAMETER_VALUE`` if the scope name is invalid.\nThrows ``BAD_REQUEST`` if request violated constraints.\nThrows ``CUSTOMER_UNAUTHORIZED`` if normal user attempts to create a scope with name reserved for databricks internal usage.\nThrows ``UNAUTHENTICATED`` if unable to verify user access permission on Azure KeyVault", + "summary": "Create a new secret scope.", + "path": "/api/2.0/secrets/scopes/create", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateScope", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "Scope name requested by the user. Scope names are unique.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "Scope name requested by the user. Scope names are unique.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "backend_azure_keyvault", + "description": "The metadata for the secret scope if the type is ``AZURE_KEYVAULT``", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureKeyVaultSecretScopeMetadata", + "is_object": true + } + }, + { + "name": "initial_manage_principal", + "description": "The principal that is initially granted ``MANAGE`` permission to the created scope.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "Scope name requested by the user. Scope names are unique.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope_backend_type", + "description": "The backend type the scope will be created with. If not specified, will default to ``DATABRICKS``", + "is_request_body_field": true, + "entity": { + "pascal_name": "ScopeBackendType", + "enum": [ + { + "content": "AZURE_KEYVAULT" + }, + { + "content": "DATABRICKS" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "Scope name requested by the user. Scope names are unique.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteAcl", + "description": "Deletes the given ACL on the given scope.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-secret-scope\",\n\"principal\": \"data-scientists\"\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope, principal, or ACL exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.", + "summary": "Delete an ACL.", + "path": "/api/2.0/secrets/acls/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAcl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to remove permissions from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to remove an existing ACL from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "The name of the scope to remove permissions from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to remove an existing ACL from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "principal", + "description": "The principal to remove an existing ACL from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope to remove permissions from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to remove permissions from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to remove an existing ACL from.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteScope", + "description": "Deletes a secret scope.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-secret-scope\"\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if the scope does not exist.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``BAD_REQUEST`` if system user attempts to delete internal secret scope.", + "summary": "Delete a secret scope.", + "path": "/api/2.0/secrets/scopes/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteScope", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "Name of the scope to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "Name of the scope to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "scope", + "description": "Name of the scope to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "Name of the scope to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSecret", + "description": "Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``\npermission on the Secret Scope.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-secret-scope\",\n\"key\": \"my-secret-key\"\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``BAD_REQUEST`` if system user attempts to delete an internal secret, or request is made against Azure KeyVault backed scope.", + "summary": "Delete a secret.", + "path": "/api/2.0/secrets/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteSecret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteSecretResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope that contains the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to delete.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetAcl", + "description": "Describes the details about the given ACL, such as the group and permission.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\n\nExample response:\n\n.. code::\n\n{\n\"principal\": \"data-scientists\",\n\"permission\": \"READ\"\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.", + "summary": "Get secret ACL details.", + "path": "/api/2.0/secrets/acls/get", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAclRequest", + "is_object": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to fetch ACL information for.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to fetch ACL information for.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AclItem", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "principal", + "description": "The principal to fetch ACL information for.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal to fetch ACL information for.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSecret", + "description": "Gets a secret for a given key and scope. This API can only be called from the DBUtils\ninterface. Users need the READ permission to make this call.\n\nExample response:\n\n.. code::\n\n{\n\"key\": \"my-string-key\",\n\"value\": \u003cbytes of the secret value\u003e\n}\n\nNote that the secret value returned is in bytes. The interpretation of the bytes\nis determined by the caller in DBUtils and the type the data is decoded into.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\n\nNote: This is explicitly an undocumented API. It also doesn't need to be supported\nfor the /preview prefix, because it's not a customer-facing API (i.e. only used\nfor DBUtils SecretUtils to fetch secrets).\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.\nThrows ``BAD_REQUEST`` if normal user calls get secret outside of a notebook.\nAKV specific errors:\nThrows ``INVALID_PARAMETER_VALUE`` if secret name is not alphanumeric or too long.\nThrows ``PERMISSION_DENIED`` if secret manager cannot access AKV with 403 error\nThrows ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other 4xx error", + "summary": "Get a secret.", + "path": "/api/2.0/secrets/get", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to fetch value information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to fetch value information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetSecretResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "key", + "description": "Name of the secret to fetch value information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope that contains the secret.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope that contains the secret.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "Name of the secret to fetch value information.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListAcls", + "description": "Lists the ACLs set on the given scope.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\n\nExample response:\n\n.. code::\n\n{\n\"acls\": [{\n\"principal\": \"admins\",\n\"permission\": \"MANAGE\"\n},{\n\"principal\": \"data-scientists\",\n\"permission\": \"READ\"\n}]\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", + "summary": "Lists ACLs.", + "path": "/api/2.0/secrets/acls/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAclsRequest", + "is_object": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAclsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to fetch ACL information from.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "ListScopes", + "description": "Lists all secret scopes available in the workspace.\n\nExample response:\n\n.. code::\n\n{\n\"scopes\": [{\n\"name\": \"my-databricks-scope\",\n\"backend_type\": \"DATABRICKS\"\n},{\n\"name\": \"mount-points\",\n\"backend_type\": \"DATABRICKS\"\n}]\n}\n\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", + "summary": "List all scopes.", + "path": "/api/2.0/secrets/scopes/list", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListScopesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListScopesResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "ListSecrets", + "description": "Lists the secret keys that are stored at this scope. This is a metadata-only\noperation; secret data cannot be retrieved using this API. Users need the READ\npermission to make this call.\n\nExample response:\n\n.. code::\n\n{\n\"secrets\": [\n{\n\"key\": \"my-string-key\"\",\n\"last_updated_timestamp\": \"1520467595000\"\n},\n{\n\"key\": \"my-byte-key\",\n\"last_updated_timestamp\": \"1520467595000\"\n},\n]\n}\n\nThe lastUpdatedTimestamp returned is in milliseconds since epoch.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", + "summary": "List secret keys.", + "path": "/api/2.0/secrets/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSecretsRequest", + "is_object": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to list secrets within.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "scope", + "description": "The name of the scope to list secrets within.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSecretsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "scope", + "description": "The name of the scope to list secrets within.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to list secrets within.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "PutAcl", + "description": "Creates or overwrites the ACL associated with the given principal (user or group) on the\nspecified scope point. In general, a user or group will use the most powerful\npermission available to them, and permissions are ordered as follows:\n\n* ``MANAGE`` - Allowed to change ACLs, and read and write to this secret scope.\n* ``WRITE`` - Allowed to read and write to this secret scope.\n* ``READ`` - Allowed to read this secret scope and list what secrets are available.\n\nNote that in general, secret values can only be read from within a command\non a cluster (for example, through a notebook). There is no API to read the actual\nsecret value material outside of a cluster. However, the user's permission will be\napplied based on who is executing the command, and they must have at least READ permission.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-secret-scope\",\n\"principal\": \"data-scientists\",\n\"permission\": \"READ\"\n}\n\nThe principal is a user or group name corresponding to an existing Databricks\nprincipal to be granted or revoked access.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``RESOURCE_ALREADY_EXISTS`` if a permission for the principal already exists.\nThrows ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", + "summary": "Create/update an ACL.", + "path": "/api/2.0/secrets/acls/put", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PutAcl", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to apply permissions to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "The name of the scope to apply permissions to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + }, + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope to apply permissions to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to apply permissions to.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "principal", + "description": "The principal in which the permission is applied.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "permission", + "description": "The permission level applied to the principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "AclPermission", + "enum": [ + { + "content": "MANAGE" + }, + { + "content": "READ" + }, + { + "content": "WRITE" + } + ] + } + } + ] + }, + { + "name": "PutSecret", + "description": "Inserts a secret under the provided scope with the given name. If a secret already\nexists with the same name, this command overwrites the existing secret's value.\nThe server encrypts the secret using the secret scope's encryption settings before\nstoring it. You must have ``WRITE`` or ``MANAGE`` permission on the secret scope.\n\nThe secret key must consist of alphanumeric characters, dashes, underscores,\nand periods, and cannot exceed 128 characters. The maximum allowed secret\nvalue size is 128 KB. The maximum number of secrets in a given scope is\n1000.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-databricks-scope\",\n\"key\": \"my-string-key\",\n\"string_value\": \"foobar\"\n}\n\nThe input fields \"string_value\" or \"bytes_value\"\nspecify the type of the secret, which will determine the value returned when\nthe secret value is requested. Exactly one must be specified.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded.\nThrows ``INVALID_PARAMETER_VALUE`` if the request parameters are invalid.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``MALFORMED_REQUEST`` if request is incorrectly formatted or conflicting.\nThrows ``BAD_REQUEST`` if request is made against Azure KeyVault backed scope.", + "summary": "Add a secret.", + "path": "/api/2.0/secrets/put", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PutSecret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "scope", + "description": "The name of the scope to which the secret will be associated with.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "A unique name to identify the secret.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "scope", + "description": "The name of the scope to which the secret will be associated with.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "A unique name to identify the secret.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "bytes_value", + "description": "If specified, value will be stored as bytes.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "A unique name to identify the secret.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "scope", + "description": "The name of the scope to which the secret will be associated with.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "string_value", + "description": "If specified, note that the value will be stored in UTF-8 (MB4) form.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "scope", + "description": "The name of the scope to which the secret will be associated with.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "key", + "description": "A unique name to identify the secret.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.SecretsUc", + "name": "SecretsUc", + "description": "A secret is a Unity Catalog securable object that stores sensitive credential data (such as passwords, tokens, and keys) within a three-level namespace (**catalog_name.schema_name.secret_name**).\n\nSecrets can be managed using standard Unity Catalog permissions and are scoped to a schema within a catalog.", + "package": { + "name": "catalog" + }, + "is_hidden_cli": true, + "docs_group": "catalog", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListSecretsRequest" + } + }, + "methods": [ + { + "name": "CreateSecret", + "description": "Creates a new secret in Unity Catalog.\n\nYou must be the owner of the parent schema or have the **CREATE_SECRET** and **USE SCHEMA**\nprivileges on the parent schema and **USE CATALOG** on the parent catalog.\n\nThe secret is stored in the specified catalog and schema, and the **value** field\ncontains the sensitive data to be securely stored.", + "summary": "Create a secret.", + "path": "/api/2.1/unity-catalog/secrets", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateSecretRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "secret", + "description": "The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value**\nfields are required.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "secret", + "description": "The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value**\nfields are required.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "secret", + "description": "The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value**\nfields are required.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "secret", + "description": "The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value**\nfields are required.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object\nthrough the **BROWSE** privilege when **include_browse** is enabled in the request.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided free-form text description of the secret.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "The time at which this secret was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The principal that created the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_owner", + "description": "The effective owner of the secret, which may differ from the directly-set **owner** due to\ninheritance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_value", + "description": "The secret value. Only populated in responses when you have the **READ_SECRET**\nprivilege and **include_value** is set to true in the request. The maximum size is 60 KiB.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "expire_time", + "description": "User-provided expiration time of the secret. This field indicates when the secret should no\nlonger be used and may be displayed as a warning in the UI. It is purely informational and\ndoes not trigger any automatic actions or affect the secret's lifecycle.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "external_secret_id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "Unique identifier of the metastore hosting the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The time at which this secret was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "The principal that last updated the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSecret", + "description": "Deletes a secret by its three-level (fully qualified) name.\n\nYou must be the owner of the secret or a metastore admin.", + "summary": "Delete a secret.", + "path": "/api/2.1/unity-catalog/secrets/{full_name}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSecret", + "description": "Gets a secret by its three-level (fully qualified) name.\n\nYou must be a metastore admin, the owner of the secret, or have the **MANAGE**\nprivilege on the secret.\n\nThe secret value isn't returned by default. To retrieve it, you must also have the\n**READ_SECRET** privilege and set **include_value** to true in the request.", + "summary": "Get a secret.", + "path": "/api/2.1/unity-catalog/secrets/{full_name}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include secrets in the response for which you only have the **BROWSE** privilege,\nwhich limits access to metadata.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListSecrets", + "description": "Lists secrets in Unity Catalog.\n\nYou must be a metastore admin, the owner of the secret, or have the\n**MANAGE** privilege on the secret.\n\nBoth **catalog_name** and **schema_name** must be specified together to filter secrets within\na specific schema. Results are paginated; use the **page_token** field from the response\nto retrieve subsequent pages.", + "summary": "List secrets.", + "path": "/api/2.1/unity-catalog/secrets", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListSecretsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListSecretsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "The name of the catalog under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include secrets in the response for which you only have the **BROWSE** privilege,\nwhich limits access to metadata.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_size", + "description": "Maximum number of secrets to return.\n\n- If not specified, at most 10000 secrets are returned.\n- If set to a value greater than 0, the page length is the minimum of this value and 10000.\n- If set to 0, the page length is set to 10000.\n- If set to a value less than 0, an invalid parameter error is returned.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to the next page based on previous query. The maximum page length\nis determined by a server configured value.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to the next page based on previous query. The maximum page length\nis determined by a server configured value.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateSecret", + "description": "Updates an existing secret in Unity Catalog.\n\nYou must be the owner of the secret or a metastore admin. If you are a metastore\nadmin, only the **owner** field can be changed.\n\nUse the **update_mask** field to specify which fields to update. Supported updatable fields\ninclude **value**, **comment**, **owner**, and **expire_time**.", + "summary": "Update a secret.", + "path": "/api/2.1/unity-catalog/secrets/{full_name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateSecretRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret", + "description": "The secret object containing the fields to update. Only fields specified in **update_mask**\nwill be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask specifying which fields of the secret to update. Supported fields: **value**,\n**comment**, **owner**, **expire_time**.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask specifying which fields of the secret to update. Supported fields: **value**,\n**comment**, **owner**, **expire_time**.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "secret", + "description": "The secret object containing the fields to update. Only fields specified in **update_mask**\nwill be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "secret", + "description": "The secret object containing the fields to update. Only fields specified in **update_mask**\nwill be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret", + "description": "The secret object containing the fields to update. Only fields specified in **update_mask**\nwill be updated.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Secret", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The field mask specifying which fields of the secret to update. Supported fields: **value**,\n**comment**, **owner**, **expire_time**.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "browse_only", + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object\nthrough the **BROWSE** privilege when **include_browse** is enabled in the request.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "User-provided free-form text description of the secret.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "The time at which this secret was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The principal that created the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_owner", + "description": "The effective owner of the secret, which may differ from the directly-set **owner** due to\ninheritance.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_value", + "description": "The secret value. Only populated in responses when you have the **READ_SECRET**\nprivilege and **include_value** is set to true in the request. The maximum size is 60 KiB.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "expire_time", + "description": "User-provided expiration time of the secret. This field indicates when the secret should no\nlonger be used and may be displayed as a warning in the UI. It is purely informational and\ndoes not trigger any automatic actions or affect the secret's lifecycle.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "external_secret_id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "Unique identifier of the metastore hosting the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "The time at which this secret was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "The principal that last updated the secret.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "The three-level (fully qualified) name of the secret\n(for example, **catalog_name.schema_name.secret_name**).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask specifying which fields of the secret to update. Supported fields: **value**,\n**comment**, **owner**, **expire_time**.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "name", + "description": "The name of the secret, relative to its parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the secret reside.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the secret resides.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "value", + "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.ServicePrincipalFederationPolicy", + "name": "ServicePrincipalFederationPolicy", + "description": "These APIs manage service principal federation policies.\n\nService principal federation, also known as Workload Identity Federation, allows your automated workloads running outside of Databricks to securely access Databricks APIs without the need for Databricks secrets. With Workload Identity Federation, your application (or workload) authenticates to Databricks as a Databricks service principal, using tokens provided by the workload runtime.\n\nDatabricks strongly recommends using Workload Identity Federation to authenticate to Databricks from automated workloads, over alternatives such as OAuth client secrets or Personal Access Tokens, whenever possible. Workload Identity Federation is supported by many popular services, including Github Actions, Azure DevOps, GitLab, Terraform Cloud, and Kubernetes clusters, among others.\n\nWorkload identity federation is configured in your Databricks account using a service principal federation policy. A service principal federation policy specifies:\n* which IdP, or issuer, the service principal is allowed to authenticate from\n* which workload identity, or subject, is allowed to authenticate as the Databricks service principal\n\nTo configure a federation policy, you provide the following:\n* The required token __issuer__, as specified in the “iss” claim of workload identity tokens. The issuer is an https URL that identifies the workload identity provider.\n* The required token __subject__, as specified in the “sub” claim of workload identity tokens. The subject uniquely identifies the workload in the workload runtime environment.\n* The allowed token __audiences__, as specified in the “aud” claim of workload identity tokens. The audience is intended to represent the recipient of the token. As long as the audience in the token matches at least one audience in the policy, the token is considered a match. If unspecified, the default value is your Databricks account id.\n* Optionally, the public keys used to validate the signature of the workload identity tokens, in JWKS format. If unspecified (recommended), Databricks automatically fetches the public keys from the issuer’s well known endpoint. Databricks strongly recommends relying on the issuer’s well known endpoint for discovering public keys.\n\nAn example service principal federation policy, for a Github Actions workload, is:\n```\nissuer: \"https://token.actions.githubusercontent.com\"\naudiences: [\"https://github.com/my-github-org\"]\nsubject: \"repo:my-github-org/my-repo:environment:prod\"\n```\n\nAn example JWT token body that matches this policy and could be used to authenticate to Databricks is:\n```\n{\n\"iss\": \"https://token.actions.githubusercontent.com\",\n\"aud\": \"https://github.com/my-github-org\",\n\"sub\": \"repo:my-github-org/my-repo:environment:prod\"\n}\n```\n\nYou may also need to configure the workload runtime to generate tokens for your workloads.\n\nYou do not need to configure an OAuth application in Databricks to use token federation.", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListServicePrincipalFederationPoliciesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create account federation policy.", + "summary": "Create service principal federation policy.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/federationPolicies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateServicePrincipalFederationPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "create_time", + "description": "Creation time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the federation policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oidc_policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OidcFederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The ID of the federation policy. Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "uid", + "description": "Unique, immutable id of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Last update time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete account federation policy.", + "summary": "Delete service principal federation policy.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/federationPolicies/{policy_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteServicePrincipalFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Get account federation policy.", + "summary": "Get service principal federation policy.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/federationPolicies/{policy_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetServicePrincipalFederationPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List account federation policies.", + "summary": "List service principal federation policies.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/federationPolicies", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListServicePrincipalFederationPoliciesRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "ListFederationPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Update account federation policy.", + "summary": "Update service principal federation policy.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/federationPolicies/{policy_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateServicePrincipalFederationPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + "response": { + "pascal_name": "FederationPolicy", + "is_object": true + }, + "all_fields": [ + { + "name": "policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "FederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Creation time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of the federation policy.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "oidc_policy", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OidcFederationPolicy", + "is_object": true + } + }, + { + "name": "policy_id", + "description": "The ID of the federation policy. Output only.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "uid", + "description": "Unique, immutable id of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Last update time of the federation policy.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal id for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "policy_id", + "description": "The identifier for the federation policy.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "oauth2.ServicePrincipalSecrets", + "name": "ServicePrincipalSecrets", + "description": "These APIs enable administrators to manage service principal secrets.\n\nYou can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals](https://docs.databricks.com/dev-tools/authentication-oauth.html).\n\nIn addition, the generated secrets can be used to configure the Databricks Terraform Provider to authenticate with the service principal. For more information, see [Databricks Terraform Provider](https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal).", + "package": { + "name": "oauth2" + }, + "is_accounts": true, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListServicePrincipalSecretsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a secret for the given service principal.", + "summary": "Create service principal secret.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateServicePrincipalSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateServicePrincipalSecretResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "lifetime", + "description": "The lifetime of the secret in seconds. If this parameter is not provided, the secret will have a default lifetime of 730 days (63072000s).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a secret from the given service principal.", + "summary": "Delete service principal secret.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets/{secret_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteServicePrincipalSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values.", + "summary": "List service principal secrets.", + "path": "/api/2.0/accounts/{account_id}/servicePrincipals/{service_principal_id}/credentials/secrets", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListServicePrincipalSecretsRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListServicePrincipalSecretsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "oauth2.ServicePrincipalSecretsProxy", + "name": "ServicePrincipalSecretsProxy", + "description": "These APIs enable administrators to manage service principal secrets at the workspace level. To use these APIs, the service principal must be first added to the current workspace.\n\nYou can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals](https://docs.databricks.com/dev-tools/authentication-oauth.html).\n\nIn addition, the generated secrets can be used to configure the Databricks Terraform Providerto authenticate with the service principal. For more information, see [Databricks Terraform Provider](https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal).", + "package": { + "name": "oauth2" + }, + "docs_group": "oauth2", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListServicePrincipalSecretsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Create a secret for the given service principal.", + "summary": "Create service principal secret.", + "path": "/api/2.0/accounts/servicePrincipals/{service_principal_id}/credentials/secrets", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateServicePrincipalSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateServicePrincipalSecretResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "lifetime", + "description": "The lifetime of the secret in seconds. If this parameter is not provided, the secret will have a default lifetime of 730 days (63072000s).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a secret from the given service principal.", + "summary": "Delete service principal secret.", + "path": "/api/2.0/accounts/servicePrincipals/{service_principal_id}/credentials/secrets/{secret_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteServicePrincipalSecretRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "secret_id", + "description": "The secret ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values.", + "summary": "List service principal secrets.", + "path": "/api/2.0/accounts/servicePrincipals/{service_principal_id}/credentials/secrets", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListServicePrincipalSecretsRequest", + "is_object": true, + "required_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListServicePrincipalSecretsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "service_principal_id", + "description": "The service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, + { + "id": "iam.ServicePrincipalsV2", + "name": "ServicePrincipalsV2", + "description": "Identities for use with jobs, automated tools, and systems such as scripts, apps, and\nCI/CD platforms. Databricks recommends creating service principals to run production jobs\nor modify production data. If all processes that act on production data run with service\nprincipals, interactive users do not need any write, delete, or modify privileges in\nproduction. This eliminates the risk of a user overwriting production data by accident.", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListServicePrincipalsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new service principal in the Databricks workspace.", + "summary": "Create a service principal.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateServicePrincipalRequest", + "is_object": true + }, + "response": { + "pascal_name": "ServicePrincipal", + "is_object": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "applicationId", + "description": "UUID relating to the service principal", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks service principal ID.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the List response.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServicePrincipalSchemaList", + "array_value": { + "pascal_name": "ServicePrincipalSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal" + } + ] + } + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a single service principal in the Databricks workspace.", + "summary": "Delete a service principal.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the details for a single service principal define in the Databricks workspace.", + "summary": "Get service principal details.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServicePrincipal", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets the set of service principals associated with a Databricks workspace.", + "summary": "List service principals.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListServicePrincipalsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListServicePrincipalResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates the details of a single service principal in the Databricks workspace.", + "summary": "Update service principal details.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the details of a single service principal.\n\nThis action replaces the existing service principal with the same name.", + "summary": "Replace service principal.", + "path": "/api/2.0/preview/scim/v2/ServicePrincipals/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "applicationId", + "description": "UUID relating to the service principal", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the service principal. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the List response.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServicePrincipalSchemaList", + "array_value": { + "pascal_name": "ServicePrincipalSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.AccountServicePrincipalsV2", + "name": "AccountServicePrincipalsV2", + "description": "Identities for use with jobs, automated tools, and systems such as scripts, apps, and\nCI/CD platforms. Databricks recommends creating service principals to run production jobs\nor modify production data. If all processes that act on production data run with service\nprincipals, interactive users do not need any write, delete, or modify privileges in\nproduction. This eliminates the risk of a user overwriting production data by accident.", + "package": { + "name": "iam" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountServicePrincipalsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new service principal in the Databricks account.", + "summary": "Create a service principal.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAccountServicePrincipalRequest", + "is_object": true + }, + "response": { + "pascal_name": "AccountServicePrincipal", + "is_object": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "applicationId", + "description": "UUID relating to the service principal", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks service principal ID.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + } + ] + }, + { + "name": "Delete", + "description": "Delete a single service principal in the Databricks account.", + "summary": "Delete a service principal.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the details for a single service principal define in the Databricks account.", + "summary": "Get service principal details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountServicePrincipal", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a service principal in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets the set of service principals associated with a Databricks account.", + "summary": "List service principals.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountServicePrincipalsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAccountServicePrincipalsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates the details of a single service principal in the Databricks account.", + "summary": "Update service principal details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PatchAccountServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the details of a single service principal.\n\nThis action replaces the existing service principal with the same name.", + "summary": "Replace service principal.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAccountServicePrincipalRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "applicationId", + "description": "UUID relating to the service principal", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "externalId", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks service principal ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "serving.ServingEndpoints", + "name": "ServingEndpoints", + "description": "The Serving Endpoints API allows you to create, update, and delete model serving endpoints.\n\nYou can use a serving endpoint to serve models from the Databricks Model Registry or from Unity Catalog.\nEndpoints expose the underlying models as scalable REST API endpoints using serverless compute. This means\nthe endpoints and associated compute resources are fully managed by Databricks and will not appear in\nyour cloud account. A serving endpoint can consist of one or more MLflow models from the Databricks\nModel Registry, called served entities. A serving endpoint can have at most ten served entities. You can configure\ntraffic settings to define how requests should be routed to your served entities behind an endpoint.\nAdditionally, you can configure the scale of resources that should be applied to each served entity.", + "package": { + "name": "serving" + }, + "docs_group": "serving", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListServingEndpointsRequest" + } + }, + "methods": [ + { + "name": "BuildLogs", + "description": "Retrieves the build logs associated with the provided served model.", + "summary": "Get build logs for a served model.", + "path": "/api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/build-logs", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "BuildLogsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that build logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that build logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "BuildLogsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "logs", + "description": "The logs associated with building the served entity's environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "logs", + "description": "The logs associated with building the served entity's environment.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that build logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that build logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Create", + "description": "Create a new serving endpoint.", + "summary": "Create a new serving endpoint.", + "path": "/api/2.0/serving-endpoints", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateServingEndpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointDetailed", + "is_object": true + }, + "all_fields": [ + { + "name": "ai_gateway", + "description": "The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AiGatewayConfig", + "is_object": true + } + }, + { + "name": "budget_policy_id", + "description": "The budget policy to be applied to the serving endpoint.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "config", + "description": "The core config of the serving endpoint.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointCoreConfigInput", + "is_object": true + } + }, + { + "name": "description", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "email_notifications", + "description": "Email notification settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EmailNotifications", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "rate_limits", + "description": "Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RateLimitList", + "array_value": { + "pascal_name": "RateLimit", + "is_object": true + } + } + }, + { + "name": "route_optimized", + "description": "Enable route optimization for the serving endpoint.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "tags", + "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointTagList", + "array_value": { + "pascal_name": "EndpointTag", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "NOT_UPDATING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ServingEndpointDetailed" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "ConfigUpdate" + } + ] + } + }, + { + "name": "CreateProvisionedThroughputEndpoint", + "description": "Create a new PT serving endpoint.", + "summary": "Create a new PT serving endpoint.", + "path": "/api/2.0/serving-endpoints/pt", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreatePtEndpointRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "config", + "description": "The core config of the serving endpoint.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "config", + "description": "The core config of the serving endpoint.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointDetailed", + "is_object": true + }, + "all_fields": [ + { + "name": "ai_gateway", + "description": "The AI Gateway configuration for the serving endpoint.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AiGatewayConfig", + "is_object": true + } + }, + { + "name": "budget_policy_id", + "description": "The budget policy associated with the endpoint.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "config", + "description": "The core config of the serving endpoint.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + }, + { + "name": "email_notifications", + "description": "Email notification settings.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EmailNotifications", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tags", + "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointTagList", + "array_value": { + "pascal_name": "EndpointTag", + "is_object": true + } + } + } + ], + "wait": { + "success": [ + { + "content": "NOT_UPDATING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ServingEndpointDetailed" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "ConfigUpdate" + } + ] + } + }, + { + "name": "Delete", + "description": "Delete a serving endpoint.", + "summary": "Delete a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteServingEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ExportMetrics", + "description": "Retrieves the metrics associated with the provided serving endpoint in either Prometheus or OpenMetrics exposition format.", + "summary": "Get metrics of a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/metrics", + "is_crud_read": true, + "is_response_byte_stream": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExportMetricsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint to retrieve metrics for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint to retrieve metrics for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExportMetricsResponse", + "is_object": true + }, + "response_body_field": { + "pascal_name": "Contents" + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint to retrieve metrics for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint to retrieve metrics for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Retrieves the details for a single serving endpoint.", + "summary": "Get a single serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetServingEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointDetailed", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetOpenApi", + "description": "Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes.", + "summary": "Get the schema for a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/openapi", + "is_crud_read": true, + "is_response_byte_stream": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetOpenApiRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetOpenApiResponse", + "is_object": true + }, + "response_body_field": { + "pascal_name": "Contents" + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get serving endpoint permission levels.", + "path": "/api/2.0/permissions/serving-endpoints/{serving_endpoint_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetServingEndpointPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetServingEndpointPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root object.", + "summary": "Get serving endpoint permissions.", + "path": "/api/2.0/permissions/serving-endpoints/{serving_endpoint_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetServingEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "HttpRequest", + "description": "Make external services call using the credentials stored in UC Connection.", + "summary": "Make external services call using the credentials stored in UC Connection.", + "path": "/api/2.0/external-function", + "can_use_json": true, + "is_hidden_cli": true, + "is_response_byte_stream": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ExternalFunctionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "connection_name", + "description": "The connection name to use. This is required to identify the external connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "method", + "description": "The HTTP method to use (e.g., 'GET', 'POST').", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalFunctionRequestHttpMethod", + "enum": [ + { + "content": "DELETE" + }, + { + "content": "GET" + }, + { + "content": "PATCH" + }, + { + "content": "POST" + }, + { + "content": "PUT" + } + ] + } + }, + { + "name": "path", + "description": "The relative path for the API endpoint. This is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "connection_name", + "description": "The connection name to use. This is required to identify the external connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "method", + "description": "The HTTP method to use (e.g., 'GET', 'POST').", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalFunctionRequestHttpMethod", + "enum": [ + { + "content": "DELETE" + }, + { + "content": "GET" + }, + { + "content": "PATCH" + }, + { + "content": "POST" + }, + { + "content": "PUT" + } + ] + } + }, + { + "name": "path", + "description": "The relative path for the API endpoint. This is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "HttpRequestResponse", + "is_object": true + }, + "response_body_field": { + "pascal_name": "Contents" + }, + "all_fields": [ + { + "name": "connection_name", + "description": "The connection name to use. This is required to identify the external connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "headers", + "description": "Additional headers for the request. If not provided, only auth headers from connections would be passed.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "json", + "description": "The JSON payload to send in the request body.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "method", + "description": "The HTTP method to use (e.g., 'GET', 'POST').", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalFunctionRequestHttpMethod", + "enum": [ + { + "content": "DELETE" + }, + { + "content": "GET" + }, + { + "content": "PATCH" + }, + { + "content": "POST" + }, + { + "content": "PUT" + } + ] + } + }, + { + "name": "params", + "description": "Query parameters for the request.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "path", + "description": "The relative path for the API endpoint. This is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "sub_domain", + "description": "Optional subdomain to prepend to the connection URL's host. If provided, this will be\nadded as a prefix to the connection URL's host. For example, if the connection URL is\n`https://api.example.com/v1` and `sub_domain` is `\"custom\"`, the resulting URL will be\n`https://custom.api.example.com/v1`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "connection_name", + "description": "The connection name to use. This is required to identify the external connection.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "method", + "description": "The HTTP method to use (e.g., 'GET', 'POST').", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ExternalFunctionRequestHttpMethod", + "enum": [ + { + "content": "DELETE" + }, + { + "content": "GET" + }, + { + "content": "PATCH" + }, + { + "content": "POST" + }, + { + "content": "PUT" + } + ] + } + }, + { + "name": "path", + "description": "The relative path for the API endpoint. This is required.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Get all serving endpoints.", + "summary": "Get all serving endpoints.", + "path": "/api/2.0/serving-endpoints", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListServingEndpointsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListEndpointsResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Logs", + "description": "Retrieves the service logs associated with the provided served model.", + "summary": "Get the latest logs for a served model.", + "path": "/api/2.0/serving-endpoints/{name}/served-models/{served_model_name}/logs", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "LogsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServerLogsResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "logs", + "description": "The most recent log lines of the model server processing invocation requests.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "logs", + "description": "The most recent log lines of the model server processing invocation requests.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint that the served model belongs to. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_model_name", + "description": "The name of the served model that logs will be retrieved for. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Patch", + "description": "Used to batch add and delete tags from a serving endpoint with a single API call.", + "summary": "Update tags of a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/tags", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PatchServingEndpointTags", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint who's tags to patch. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint who's tags to patch. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EndpointTags", + "is_object": true + }, + "all_fields": [ + { + "name": "add_tags", + "description": "List of endpoint tags to add", + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointTagList", + "array_value": { + "pascal_name": "EndpointTag", + "is_object": true + } + } + }, + { + "name": "delete_tags", + "description": "List of tag keys to delete", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "name", + "description": "The name of the serving endpoint who's tags to patch. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint who's tags to patch. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Put", + "description": "Deprecated: Please use AI Gateway to manage rate limits instead.", + "summary": "Update rate limits of a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/rate-limits", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PutRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose rate limits are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose rate limits are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PutResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose rate limits are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rate_limits", + "description": "The list of endpoint rate limits.", + "is_request_body_field": true, + "entity": { + "pascal_name": "RateLimitList", + "array_value": { + "pascal_name": "RateLimit", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint whose rate limits are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "PutAiGateway", + "description": "Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", + "summary": "Update AI Gateway of a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/ai-gateway", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PutAiGatewayRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose AI Gateway is being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose AI Gateway is being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PutAiGatewayResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "fallback_config", + "description": "Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "FallbackConfig", + "is_object": true + } + }, + { + "name": "guardrails", + "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AiGatewayGuardrails", + "is_object": true + } + }, + { + "name": "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.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AiGatewayInferenceTableConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint whose AI Gateway is being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "rate_limits", + "description": "Configuration for rate limits which can be set to limit endpoint traffic.", + "is_request_body_field": true, + "entity": { + "pascal_name": "AiGatewayRateLimitList", + "array_value": { + "pascal_name": "AiGatewayRateLimit", + "is_object": true + } + } + }, + { + "name": "usage_tracking_config", + "description": "Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AiGatewayUsageTrackingConfig", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint whose AI Gateway is being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Query", + "description": "Query a serving endpoint", + "summary": "Query a serving endpoint.", + "path": "/serving-endpoints/{name}/invocations", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryEndpointInput", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "QueryEndpointResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "client_request_id", + "description": "Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataframe_records", + "description": "Pandas Dataframe input in the records orientation.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_any": true + } + } + }, + { + "name": "dataframe_split", + "description": "Pandas Dataframe input in the split orientation.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DataframeSplitInput", + "is_object": true + } + }, + { + "name": "extra_params", + "description": "The extra parameters field used ONLY for __completions, chat,__ and __embeddings external \u0026 foundation\nmodel__ serving endpoints. This is a map of strings and should only be used with other external/foundation\nmodel query fields.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "input", + "description": "The input string (or array of strings) field used ONLY for __embeddings external \u0026 foundation model__\nserving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "inputs", + "description": "Tensor-based input in columnar format.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "instances", + "description": "Tensor-based input in row format.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_any": true + } + } + }, + { + "name": "max_tokens", + "description": "The max tokens field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is an integer and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "messages", + "description": "The messages field used ONLY for __chat external \u0026 foundation model__ serving endpoints.\nThis is an array of ChatMessage objects and should only be used with other chat query fields.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ChatMessageList", + "array_value": { + "pascal_name": "ChatMessage", + "is_object": true + } + } + }, + { + "name": "n", + "description": "The n (number of candidates) field used ONLY for __completions__ and __chat external \u0026 foundation model__\nserving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with\nother chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "prompt", + "description": "The prompt string (or array of strings) field used ONLY for __completions external \u0026 foundation model__\nserving endpoints and should only be used with other completions query fields.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "stop", + "description": "The stop sequences field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a list of strings and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "stream", + "description": "The stream field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving endpoints.\nThis is a boolean defaulting to false and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "temperature", + "description": "The temperature field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other\nchat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_float64": true + } + }, + { + "name": "usage_context", + "description": "Optional user-provided context that will be recorded in the usage tracking table.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set serving endpoint permissions.", + "path": "/api/2.0/permissions/serving-endpoints/{serving_endpoint_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ServingEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServingEndpointAccessControlRequestList", + "array_value": { + "pascal_name": "ServingEndpointAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateConfig", + "description": "Updates any combination of the serving endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. An endpoint that already has an update in progress can not be updated until the current update completes or fails.", + "summary": "Update config of a serving endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/config", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EndpointCoreConfigInput", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointDetailed", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_capture_config", + "description": "Configuration for legacy Inference Tables which automatically log requests and responses to Unity\nCatalog.\nDeprecated: please use AI Gateway inference tables instead. See\nhttps://docs.databricks.com/aws/en/ai-gateway/inference-tables.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AutoCaptureConfigInput", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "served_entities", + "description": "The list of served entities under the serving endpoint config.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServedEntityInputList", + "array_value": { + "pascal_name": "ServedEntityInput", + "is_object": true + } + } + }, + { + "name": "served_models", + "description": "(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServedModelInputList", + "array_value": { + "pascal_name": "ServedModelInput", + "is_object": true + } + } + }, + { + "name": "traffic_config", + "description": "The traffic configuration associated with the serving endpoint config.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "TrafficConfig", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "NOT_UPDATING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ServingEndpointDetailed" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "ConfigUpdate" + } + ] + } + }, + { + "name": "UpdateNotifications", + "description": "Updates the email and webhook notification settings for an endpoint.", + "summary": "Update the email and webhook notification settings for an endpoint.", + "path": "/api/2.0/serving-endpoints/{name}/notifications", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateInferenceEndpointNotifications", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose notifications are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint whose notifications are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateInferenceEndpointNotificationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "email_notifications", + "description": "The email notification settings to update. Specify email addresses to notify when endpoint state changes occur.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EmailNotifications", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint whose notifications are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint whose notifications are being updated. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their root object.", + "summary": "Update serving endpoint permissions.", + "path": "/api/2.0/permissions/serving-endpoints/{serving_endpoint_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ServingEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "ServingEndpointAccessControlRequestList", + "array_value": { + "pascal_name": "ServingEndpointAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "serving_endpoint_id", + "description": "The serving endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateProvisionedThroughputEndpointConfig", + "description": "Updates any combination of the pt endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be updated instantly", + "summary": "Update config of a PT serving endpoint.", + "path": "/api/2.0/serving-endpoints/pt/{name}/config", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateProvisionedThroughputEndpointConfigRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the pt endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the pt endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "ServingEndpointDetailed", + "is_object": true + }, + "all_fields": [ + { + "name": "config", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PtEndpointCoreConfig", + "is_object": true + } + }, + { + "name": "name", + "description": "The name of the pt endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the pt endpoint to update. This field is required.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "NOT_UPDATING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "ServingEndpointDetailed" + } + }, + "status_path": [ + { + "pascal_name": "State" + }, + { + "pascal_name": "ConfigUpdate" + } + ] + } + } + ] + }, + { + "id": "serving.ServingEndpointsDataPlane", + "name": "ServingEndpointsDataPlane", + "description": "Serving endpoints DataPlane provides a set of operations to interact with data plane endpoints for Serving endpoints service.", + "package": { + "name": "serving" + }, + "is_data_plane": true, + "docs_group": "serving", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Query", + "description": "Query a serving endpoint", + "summary": "Query a serving endpoint.", + "path": "/serving-endpoints/{name}/invocations", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryEndpointInput", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "QueryEndpointResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "client_request_id", + "description": "Optional user-provided request identifier that will be recorded in the inference table and the usage tracking table.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "dataframe_records", + "description": "Pandas Dataframe input in the records orientation.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_any": true + } + } + }, + { + "name": "dataframe_split", + "description": "Pandas Dataframe input in the split orientation.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DataframeSplitInput", + "is_object": true + } + }, + { + "name": "extra_params", + "description": "The extra parameters field used ONLY for __completions, chat,__ and __embeddings external \u0026 foundation\nmodel__ serving endpoints. This is a map of strings and should only be used with other external/foundation\nmodel query fields.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "input", + "description": "The input string (or array of strings) field used ONLY for __embeddings external \u0026 foundation model__\nserving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "inputs", + "description": "Tensor-based input in columnar format.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "instances", + "description": "Tensor-based input in row format.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_any": true + } + } + }, + { + "name": "max_tokens", + "description": "The max tokens field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is an integer and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "messages", + "description": "The messages field used ONLY for __chat external \u0026 foundation model__ serving endpoints.\nThis is an array of ChatMessage objects and should only be used with other chat query fields.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ChatMessageList", + "array_value": { + "pascal_name": "ChatMessage", + "is_object": true + } + } + }, + { + "name": "n", + "description": "The n (number of candidates) field used ONLY for __completions__ and __chat external \u0026 foundation model__\nserving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with\nother chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "prompt", + "description": "The prompt string (or array of strings) field used ONLY for __completions external \u0026 foundation model__\nserving endpoints and should only be used with other completions query fields.", + "is_request_body_field": true, + "entity": { + "is_any": true + } + }, + { + "name": "stop", + "description": "The stop sequences field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a list of strings and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "stream", + "description": "The stream field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving endpoints.\nThis is a boolean defaulting to false and should only be used with other chat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "temperature", + "description": "The temperature field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other\nchat/completions query fields.", + "is_request_body_field": true, + "entity": { + "is_float64": true + } + }, + { + "name": "usage_context", + "description": "Optional user-provided context that will be recorded in the usage tracking table.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the serving endpoint. This field is required and is provided via the path parameter.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.Settings", + "name": "Settings", + "description": "Workspace Settings API allows users to manage settings at the workspace level.", + "package": { + "name": "settings" + }, + "has_subservices": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "subservice_ids": [ + "settings.AibiDashboardEmbeddingAccessPolicy", + "settings.AibiDashboardEmbeddingApprovedDomains", + "settings.AutomaticClusterUpdate", + "settings.ComplianceSecurityProfile", + "settings.DashboardEmailSubscriptions", + "settings.DefaultNamespace", + "settings.DefaultWarehouseId", + "settings.DisableLegacyAccess", + "settings.DisableLegacyDbfs", + "settings.EnableExportNotebook", + "settings.EnableNotebookTableClipboard", + "settings.EnableResultsDownloading", + "settings.EnhancedSecurityMonitoring", + "settings.LlmProxyPartnerPoweredWorkspace", + "settings.RestrictWorkspaceAdmins", + "settings.SqlResultsDownload" + ] + }, + { + "id": "settings.AccountSettings", + "name": "AccountSettings", + "description": "Accounts Settings API allows users to manage settings at the account level.", + "package": { + "name": "settings" + }, + "is_accounts": true, + "has_subservices": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "subservice_ids": [ + "settings.CspEnablementAccount", + "settings.DisableLegacyFeatures", + "settings.EnableIpAccessLists", + "settings.EsmEnablementAccount", + "settings.LlmProxyPartnerPoweredAccount", + "settings.LlmProxyPartnerPoweredEnforce", + "settings.PersonalCompute" + ] + }, + { + "id": "settingsv2.AccountSettingsV2", + "name": "AccountSettingsV2", + "description": "APIs to manage account level settings", + "package": { + "name": "settingsv2" + }, + "is_accounts": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListAccountSettingsMetadataRequest" + } + }, + "methods": [ + { + "name": "GetPublicAccountSetting", + "description": "Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.", + "summary": "Get an account setting.", + "path": "/api/2.1/accounts/{account_id}/settings/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPublicAccountSettingRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Setting", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPublicAccountUserPreference", + "description": "Get a user preference for a specific user.\nUser preferences are personal settings that allow individual customization without affecting other users.\nSee :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.", + "summary": "Get a user preference.", + "path": "/api/2.1/accounts/{account_id}/users/{user_id}/settings/{name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetPublicAccountUserPreferenceRequest", + "is_object": true, + "required_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "User Setting name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "User Setting name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UserPreference", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "User Setting name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_id", + "description": "User ID of the user whose setting is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "User Setting name.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListAccountSettingsMetadata", + "description": "List valid setting keys and metadata. These settings are available to be referenced via\nGET :method:settingsv2/getpublicaccountsetting and\nPATCH :method:settingsv2/patchpublicaccountsetting APIs", + "summary": "List valid setting keys and their metadata.", + "path": "/api/2.1/accounts/{account_id}/settings-metadata", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListAccountSettingsMetadataRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAccountSettingsMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListAccountSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountSettingsMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListAccountSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountSettingsMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListAccountUserPreferencesMetadata", + "description": "List valid user preferences and their metadata for a specific user.\nUser preferences are personal settings that allow individual customization without affecting other users.\nThese settings are available to be referenced via\nGET :method:settingsv2/getpublicaccountuserpreference and\nPATCH :method:settingsv2/patchpublicaccountuserpreference APIs", + "summary": "List user preferences and their metadata.", + "path": "/api/2.1/accounts/{account_id}/users/{user_id}/settings-metadata", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListAccountUserPreferencesMetadataRequest", + "is_object": true, + "required_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose settings metadata is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose settings metadata is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAccountUserPreferencesMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListAccountUserPreferencesMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountUserPreferencesMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "user_id", + "description": "User ID of the user whose settings metadata is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "user_id", + "description": "User ID of the user whose settings metadata is being retrieved.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListAccountUserPreferencesMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountUserPreferencesMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "PatchPublicAccountSetting", + "description": "Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.\nTo determine the correct field to include in a patch request, refer to the type field of the setting returned in the :method:settingsv2/listaccountsettingsmetadata response.\n\nNote: Page refresh is required for changes to take effect in UI.", + "summary": "Update an account setting.", + "path": "/api/2.1/accounts/{account_id}/settings/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchPublicAccountSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + }, + "response": { + "pascal_name": "Setting", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + }, + { + "name": "aibi_dashboard_embedding_access_policy", + "description": "Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + }, + { + "name": "aibi_dashboard_embedding_approved_domains", + "description": "Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + }, + { + "name": "allowed_apps_user_api_scopes", + "description": "Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AllowedAppsUserApiScopesMessage", + "is_object": true + } + }, + { + "name": "automatic_cluster_update_workspace", + "description": "Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + }, + { + "name": "boolean_val", + "description": "Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "collaboration_platform_connectivity", + "description": "Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CollaborationPlatformConnectivityMessage", + "is_object": true + } + }, + { + "name": "effective_aibi_dashboard_embedding_access_policy", + "description": "Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + }, + { + "name": "effective_aibi_dashboard_embedding_approved_domains", + "description": "Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + }, + { + "name": "effective_allowed_apps_user_api_scopes", + "description": "Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AllowedAppsUserApiScopesMessage", + "is_object": true + } + }, + { + "name": "effective_automatic_cluster_update_workspace", + "description": "Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + }, + { + "name": "effective_boolean_val", + "description": "Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "effective_collaboration_platform_connectivity", + "description": "Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CollaborationPlatformConnectivityMessage", + "is_object": true + } + }, + { + "name": "effective_integer_val", + "description": "Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IntegerMessage", + "is_object": true + } + }, + { + "name": "effective_operational_email_custom_recipient", + "description": "Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OperationalEmailCustomRecipientMessage", + "is_object": true + } + }, + { + "name": "effective_personal_compute", + "description": "Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + }, + { + "name": "effective_restrict_workspace_admins", + "description": "Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + }, + { + "name": "effective_string_val", + "description": "Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + }, + { + "name": "integer_val", + "description": "Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IntegerMessage", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the setting.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "operational_email_custom_recipient", + "description": "Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OperationalEmailCustomRecipientMessage", + "is_object": true + } + }, + { + "name": "personal_compute", + "description": "Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + }, + { + "name": "restrict_workspace_admins", + "description": "Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + }, + { + "name": "string_val", + "description": "Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "PatchPublicAccountUserPreference", + "description": "Update a user preference for a specific user.\nUser preferences are personal settings that allow individual customization without affecting other users.\nSee :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.\n\nNote: Page refresh is required for changes to take effect in UI.", + "summary": "Update a user preference.", + "path": "/api/2.1/accounts/{account_id}/users/{user_id}/settings/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "PatchPublicAccountUserPreferenceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UserPreference", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UserPreference", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UserPreference", + "is_object": true + } + }, + "response": { + "pascal_name": "UserPreference", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "UserPreference", + "is_object": true + } + }, + { + "name": "user_id", + "description": "User ID of the user whose setting is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "boolean_val", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "effective_boolean_val", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "effective_string_val", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the setting.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "string_val", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + }, + { + "name": "user_id", + "description": "User ID of the user.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "user_id", + "description": "User ID of the user whose setting is being updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "sharing.Shares", + "name": "Shares", + "description": "A share is a container instantiated with :method:shares/create. Once created you can\niteratively register a collection of existing data assets defined within the metastore\nusing :method:shares/update. You can register data assets under their original name,\nqualified by their original schema, or provide alternate exposed names.", + "package": { + "name": "sharing" + }, + "docs_group": "sharing", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "SharesListRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new share for data objects. Data objects can be added after creation with **update**.\nThe caller must be a metastore admin or have the **CREATE_SHARE** privilege on the metastore.", + "summary": "Create a share.", + "path": "/api/2.1/unity-catalog/shares", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateShare", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the share.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the share.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ShareInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Name of the share.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_root", + "description": "Storage root URL for the share.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the share.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a data object share from the metastore. The caller must be an owner of the share.", + "summary": "Delete a share.", + "path": "/api/2.1/unity-catalog/shares/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteShareRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a data object share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share.", + "summary": "Get a share.", + "path": "/api/2.1/unity-catalog/shares/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetShareRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ShareInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "include_shared_data", + "description": "Query for data to include in the share.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListShares", + "description": "Gets an array of data object shares from the metastore. If the caller has the USE_SHARE privilege on the metastore, all shares are returned. Otherwise, only shares owned by the caller are returned.\nThere is no guarantee of a specific ordering of the elements in the array.", + "summary": "List shares.", + "path": "/api/2.1/unity-catalog/shares", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SharesListRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListSharesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "SharePermissions", + "description": "Gets the permissions for a data share from the metastore.\nThe caller must have the USE_SHARE privilege on the metastore or be the owner of the share.", + "summary": "Get permissions.", + "path": "/api/2.1/unity-catalog/shares/{name}/permissions", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SharePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetSharePermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of permissions to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid permissions are returned (not recommended).\n- Note: The number of returned permissions might be less than the specified max_results size, even zero.\nThe only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the Recipient.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the share with the changes and data objects in the request.\nThe caller must be the owner of the share or a metastore admin.\n\nWhen the caller is a metastore admin, only the __owner__ field can be updated.\n\nIn the case the share name is changed, **updateShare** requires that the caller is the owner of the share\nand has the CREATE_SHARE privilege.\n\nIf there are notebook files in the share, the __storage_root__ field cannot be updated.\n\nFor each table that is added through this method, the share owner must also have **SELECT** privilege on the table.\nThis privilege must be maintained indefinitely for recipients to be able to access the table.\nTypically, you should use a group as the share owner.\n\nTable removals through **update** do not require additional privileges.", + "summary": "Update a share.", + "path": "/api/2.1/unity-catalog/shares/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateShare", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ShareInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "User-provided free-form text description.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the share.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of share.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_root", + "description": "Storage root URL for the share.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "updates", + "description": "Array of shared data object updates.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SharedDataObjectUpdateList", + "array_value": { + "pascal_name": "SharedDataObjectUpdate", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions for a data share in the metastore.\nThe caller must have both the USE_SHARE and SET_SHARE_PERMISSION privileges on the metastore,\nor be the owner of the share.\n\nFor new recipient grants, the user must also be the owner of the recipients.\nrecipient revocations do not require additional privileges.", + "summary": "Update permissions.", + "path": "/api/2.1/unity-catalog/shares/{name}/permissions", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateSharePermissions", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateSharePermissionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "changes", + "description": "Array of permissions change objects.", + "is_request_body_field": true, + "entity": { + "pascal_name": "PermissionsChangeList", + "array_value": { + "pascal_name": "PermissionsChange", + "is_object": true + } + } + }, + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "omit_permissions_list", + "description": "Optional. Whether to return the latest permissions list of the share in the response.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the share.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.SqlResultsDownload", + "name": "SqlResultsDownload", + "description": "Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to `true`)", + "package": { + "name": "settings" + }, + "has_parent": true, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "parent_service_id": "settings.Settings", + "methods": [ + { + "name": "Delete", + "description": "Reverts the SQL Results Download setting to its default value.", + "summary": "Delete the SQL Results Download setting.", + "path": "/api/2.0/settings/types/sql_results_download/names/default", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteSqlResultsDownloadRequest", + "is_object": true + }, + "response": { + "pascal_name": "DeleteSqlResultsDownloadResponse", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets the SQL Results Download setting.", + "summary": "Get the SQL Results Download setting.", + "path": "/api/2.0/settings/types/sql_results_download/names/default", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetSqlResultsDownloadRequest", + "is_object": true + }, + "response": { + "pascal_name": "SqlResultsDownload", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "etag", + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the SQL Results Download setting.", + "summary": "Update the SQL Results Download setting.", + "path": "/api/2.0/settings/types/sql_results_download/names/default", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateSqlResultsDownloadRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SqlResultsDownload", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SqlResultsDownload", + "is_object": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SqlResultsDownload", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "boolean_val", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "This should always be set to true for Settings API. Added for AIP compliance.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "field_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SqlResultsDownload", + "is_object": true + } + } + ] + } + ] + }, + { + "id": "sql.StatementExecution", + "name": "StatementExecution", + "description": "The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL warehouse and fetch the result.\n\n**Getting started**\n\nWe suggest beginning with the [Databricks SQL Statement Execution API tutorial](https://docs.databricks.com/sql/api/sql-execution-tutorial.html).\n\n**Overview of statement execution and result fetching**\n\nStatement execution begins by issuing a :method:statementexecution/executeStatement request with a valid\nSQL statement and warehouse ID, along with optional parameters such as the data catalog and output format.\nIf no other parameters are specified, the server will wait for up to 10s before returning a response.\nIf the statement has completed within this timespan, the response will include the result data as a JSON\narray and metadata.\nOtherwise, if no result is available after the 10s timeout expired, the response will provide the\nstatement ID that can be used to poll for results by using a :method:statementexecution/getStatement\nrequest.\n\nYou can specify whether the call should behave synchronously, asynchronously\nor start synchronously with a fallback to asynchronous execution.\nThis is controlled with the `wait_timeout` and `on_wait_timeout` settings.\nIf `wait_timeout` is set between 5-50 seconds (default:\n10s), the call waits for results up to\nthe specified timeout; when set to `0s`, the call is asynchronous and responds immediately with a\nstatement ID. The `on_wait_timeout` setting specifies what should happen when the timeout is reached while\nthe statement execution has not yet finished. This can be set to either `CONTINUE`, to fallback to\nasynchronous mode, or it can be set to `CANCEL`, which cancels the statement.\n\nIn summary:\n- **Synchronous mode** (`wait_timeout=30s` and `on_wait_timeout=CANCEL`):\nThe call waits up to 30 seconds; if the statement execution finishes within this time,\nthe result data is returned directly in the response. If the execution takes longer than 30 seconds,\nthe execution is canceled and the call returns with a `CANCELED` state.\n- **Asynchronous mode** (`wait_timeout=0s` and `on_wait_timeout` is ignored):\nThe call doesn't wait for the statement to finish but returns directly with a statement ID.\nThe status of the statement execution can be polled by issuing :method:statementexecution/getStatement with the statement ID.\nOnce the execution has succeeded, this call also returns the result and metadata in the response.\n- **[Default] Hybrid mode** (`wait_timeout=10s` and `on_wait_timeout=CONTINUE`):\nThe call waits for up to 10 seconds; if the statement execution finishes within this time,\nthe result data is returned directly in the response. If the execution takes longer than 10\nseconds, a statement ID is returned. The statement ID can be used to fetch status and results in\nthe same way as in the asynchronous mode.\n\nDepending on the size, the result can be split into multiple chunks. If the statement execution is\nsuccessful, the statement response contains a manifest and the first chunk of the result. The manifest\ncontains schema information and provides metadata for each chunk in the result. Result chunks can be\nretrieved by index with :method:statementexecution/getStatementResultChunkN which may be called in any\norder and in parallel. For sequential fetching, each chunk, apart from the last, also contains a\n`next_chunk_index` and `next_chunk_internal_link` that point to the next chunk.\n\nA statement can be canceled with :method:statementexecution/cancelExecution.\n\n**Fetching result data: format and disposition**\n\nTo specify the format of the result data, use the `format` field, which can be set to one of the following\noptions: `JSON_ARRAY` (JSON), `ARROW_STREAM`\n([Apache Arrow Columnar](https://arrow.apache.org/overview/)), or `CSV`.\n\nThere are two ways to receive statement results, controlled by the `disposition` setting,\nwhich can be either `INLINE` or `EXTERNAL_LINKS`:\n\n- `INLINE`: In this mode, the result data is directly included in the response. It's best suited for smaller results.\nThis mode can only be used with the `JSON_ARRAY` format.\n\n- `EXTERNAL_LINKS`: In this mode, the response provides links that can be used to download the result data in chunks separately.\nThis approach is ideal for larger results and offers higher throughput.\nThis mode can be used with all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`.\n\nBy default, the API uses `format=JSON_ARRAY` and `disposition=INLINE`.\n\n**Limits and limitations**\n\nNote: The byte limit for INLINE disposition is based on internal storage metrics and will not exactly match the byte count of the actual payload.\n\n- Statements with `disposition=INLINE` are limited to 25 MiB and will fail when this limit is\nexceeded.\n- Statements with `disposition=EXTERNAL_LINKS` are limited to 100 GiB. Result sets larger than\nthis limit will be truncated. Truncation is indicated by the `truncated` field in the result manifest.\n- The maximum query text size is 16 MiB.\n- Cancelation might silently fail. A successful response from a cancel request indicates that the cancel request\nwas successfully received and sent to the processing engine. However, an outstanding statement\nmight have already completed execution when the cancel request arrives. Polling\nfor status until a terminal state is reached is a reliable way to determine the final state.\n- Wait timeouts are approximate, occur server-side, and cannot account for things such as caller delays and network latency from caller to service.\n- To guarantee that the statement is kept alive, you must poll at least once every 15 minutes.\n- The results are only available for one hour after success; polling does not extend this.\n- The SQL Execution API must be used for the entire lifecycle of the statement. For example, you cannot use the Jobs API to execute the command, and then the SQL Execution API to cancel it.", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "CancelExecution", + "description": "Requests that an executing statement be canceled. Callers must poll for status to see the\nterminal state. Cancel response is empty; receiving response indicates successful receipt.", + "summary": "Cancel statement execution.", + "path": "/api/2.0/sql/statements/{statement_id}/cancel", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CancelExecutionRequest", + "is_object": true, + "required_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ExecuteStatement", + "description": "Execute a SQL statement and optionally await its results for a specified time.\n\n**Use case: small result sets with INLINE + JSON_ARRAY**\n\nFor flows that generate small and predictable result sets (\u003c= 25 MiB), `INLINE` responses of `JSON_ARRAY` result\ndata are typically the simplest way to execute and fetch result data.\n\n**Use case: large result sets with EXTERNAL_LINKS**\n\nUsing `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets efficiently.\nThe main differences from using `INLINE` disposition are that the result data is accessed\nwith URLs, and\nthat there are 3 supported formats: `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with\n`INLINE`.\n\n** URLs**\n\nExternal links point to data stored within your workspace's internal storage, in the form of\na URL. The URLs are valid for only a short\nperiod, \u003c= 15 minutes. Alongside each `external_link` is an expiration field indicating the time at which the URL\nis no longer valid. In `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times and in parallel.\n\n----\n\n### **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.**\n\nWhen you use the `EXTERNAL_LINKS` disposition, a\nshort-lived, URL is generated, which can be\nused to download the results directly\nfrom . As a\nshort-lived is\nembedded in this URL, you should protect\nthe URL.\n\nBecause URLs are already generated with\nembedded temporary s,\nyou must not set an `Authorization` header in the download requests.\n\nThe `EXTERNAL_LINKS` disposition can be disabled upon request by creating a support\ncase.\n\nSee also [Security best practices](https://docs.databricks.com/sql/admin/sql-execution-tutorial.html#security-best-practices).\n\n----\n\nStatementResponse contains `statement_id` and `status`; other fields might be absent or present depending on\ncontext. If the SQL warehouse fails to execute the provided statement, a 200 response is returned with\n`status.state` set to `FAILED` (in contrast to a failure when accepting the request, which results in a non-200\nresponse). Details of the error can be found at `status.error` in case of execution failures.", + "summary": "Execute a SQL statement.", + "path": "/api/2.0/sql/statements", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExecuteStatementRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "statement", + "description": "The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.\nThe maximum query text size is 16 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Warehouse upon which to execute a statement. See also\n[What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "statement", + "description": "The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.\nThe maximum query text size is 16 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Warehouse upon which to execute a statement. See also\n[What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StatementResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "byte_limit", + "description": "Applies the given byte limit to the statement's result size. Byte counts are based on internal data\nrepresentations and might not match the final size in the requested `format`. If the result was truncated due to\nthe byte limit, then `truncated` in the response is set to `true`.\nWhen using `EXTERNAL_LINKS` disposition, a default `byte_limit` of 100 GiB is applied if `byte_limit` is not\nexplicitly set.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "catalog", + "description": "Sets default catalog for statement execution, similar to\n[`USE CATALOG`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-catalog.html)\nin SQL.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "disposition", + "description": "The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.\n\nStatements executed with `INLINE` disposition will return result data inline, in `JSON_ARRAY` format, in a series\nof chunks. If a given statement produces a result set with a size larger than 25 MiB,\nthat statement execution is aborted, and no result set will be available.\n\n**NOTE**\nByte limits are computed based upon internal representations of the result set data, and might not match the sizes\nvisible in JSON responses.\n\nStatements executed with `EXTERNAL_LINKS` disposition will return result data as external links: URLs that point\nto cloud storage internal to the workspace. Using `EXTERNAL_LINKS` disposition allows statements to generate\narbitrarily sized result sets for fetching up to 100 GiB. The resulting links have two important properties:\n\n1. They point to resources _external_ to the Databricks compute; therefore any associated authentication\ninformation (typically a personal access token, OAuth token, or similar) _must be removed_ when fetching from\nthese links.\n\n2. These are URLs\nwith a specific expiration, indicated in the response. The behavior when attempting to use an expired link is\ncloud specific.", + "is_request_body_field": true, + "entity": { + "pascal_name": "Disposition", + "enum": [ + { + "content": "EXTERNAL_LINKS" + }, + { + "content": "INLINE" + } + ] + } + }, + { + "name": "format", + "description": "Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and `CSV`.\n\nImportant: The formats `ARROW_STREAM` and `CSV` are supported only with `EXTERNAL_LINKS` disposition.\n`JSON_ARRAY` is supported in `INLINE` and `EXTERNAL_LINKS` disposition.\n\nWhen specifying `format=JSON_ARRAY`, result data will be formatted as an array of arrays of values, where each\nvalue is either the *string representation* of a value, or `null`.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM range(3)` would\nlook like this:\n\n```\n[\n[ \"id-1\", \"1\", null ],\n[ \"id-2\", \"2\", null ],\n[ \"id-3\", \"3\", null ],\n]\n```\n\nWhen specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`, each chunk in the result contains compact\nJSON with no indentation or extra whitespace.\n\nWhen specifying `format=ARROW_STREAM` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be formatted\nas Apache Arrow Stream. See the\n[Apache Arrow streaming format](https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format).\n\nWhen specifying `format=CSV` and `disposition=EXTERNAL_LINKS`, each chunk in the result will be a CSV according to\n[RFC 4180](https://www.rfc-editor.org/rfc/rfc4180) standard.\nAll the columns values will have *string representation* similar to the `JSON_ARRAY` format, and `null` values will\nbe encoded as “null”.\nOnly the first chunk in the result would contain a header row with column names.\nFor example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null as nullCol FROM range(3)` would\nlook like this:\n\n```\nstrCol,intCol,nullCol\nid-1,1,null\nid-2,2,null\nid-3,3,null\n```", + "is_request_body_field": true, + "entity": { + "pascal_name": "Format", + "enum": [ + { + "content": "ARROW_STREAM" + }, + { + "content": "CSV" + }, + { + "content": "JSON_ARRAY" + } + ] + } + }, + { + "name": "on_wait_timeout", + "description": "When `wait_timeout \u003e 0s`, the call will block up to the specified time. If the statement execution doesn't\nfinish within this time, `on_wait_timeout` determines whether the execution should continue or be canceled.\nWhen set to `CONTINUE`, the statement execution continues asynchronously and the call returns a statement ID\nwhich can be used for polling with :method:statementexecution/getStatement. When set to `CANCEL`,\nthe statement execution is canceled and the call returns with a `CANCELED` state.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ExecuteStatementRequestOnWaitTimeout", + "enum": [ + { + "content": "CANCEL" + }, + { + "content": "CONTINUE" + } + ] + } + }, + { + "name": "parameters", + "description": "A list of parameters to pass into a SQL statement containing parameter markers. A\nparameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.\n\nFor example, the following statement contains two parameters, `my_name` and `my_date`:\n\n```\nSELECT * FROM my_table WHERE name = :my_name AND date = :my_date\n```\n\nThe parameters can be passed in the request body as follows:\n\n`\n{\n...,\n\"statement\": \"SELECT * FROM my_table WHERE name = :my_name AND date = :my_date\",\n\"parameters\": [\n{ \"name\": \"my_name\", \"value\": \"the name\" },\n{ \"name\": \"my_date\", \"value\": \"2020-01-01\", \"type\": \"DATE\" }\n]\n}\n`\n\nCurrently, positional parameters denoted by a `?` marker are not supported by the\nDatabricks SQL Statement Execution API.\n\nAlso see the section [Parameter markers](https://docs.databricks.com/sql/language-manual/sql-ref-parameter-marker.html) of the SQL language reference.", + "is_request_body_field": true, + "entity": { + "pascal_name": "StatementParameterListItemList", + "array_value": { + "pascal_name": "StatementParameterListItem", + "is_object": true + } + } + }, + { + "name": "query_tags", + "description": "An array of query tags to annotate a SQL statement. A query tag\nconsists of a non-empty key and, optionally, a value. To represent a NULL\nvalue, either omit the `value` field or manually set it to `null` or white space.\nRefer to the SQL language reference for the format specification of query tags.\nThere's no significance to the order of tags. Only one value per key will be recorded.\nA sequence in excess of 20 query tags will be coerced to 20.\nExample:\n\n{\n...,\n\"query_tags\": [\n{ \"key\": \"team\", \"value\": \"eng\" },\n{ \"key\": \"some key only tag\" }\n]\n}", + "is_request_body_field": true, + "entity": { + "pascal_name": "QueryTagList", + "array_value": { + "pascal_name": "QueryTag", + "is_object": true + } + } + }, + { + "name": "row_limit", + "description": "Applies the given row limit to the statement's result set, but unlike the `LIMIT` clause in SQL,\nit also sets the `truncated` field in the response to indicate whether the result was trimmed due to the limit or\nnot.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "schema", + "description": "Sets default schema for statement execution, similar to\n[`USE SCHEMA`](https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-schema.html)\nin SQL.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "statement", + "description": "The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.\nThe maximum query text size is 16 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "wait_timeout", + "description": "The time in seconds the call will wait for the statement's result set as `Ns`, where `N` can be set to 0 or to a\nvalue between 5 and 50.\n\nWhen set to `0s`, the statement will execute in asynchronous mode and the call will not wait for the execution to\nfinish. In this case, the call returns directly with `PENDING` state and a statement ID which can be used for\npolling with :method:statementexecution/getStatement.\n\nWhen set between 5 and 50 seconds, the call will behave synchronously up to this timeout and wait for the statement\nexecution to finish. If the execution finishes within this time, the call returns immediately with a manifest and\nresult data (or a `FAILED` state in case of an execution error). If the statement takes longer to execute,\n`on_wait_timeout` determines what should happen after the timeout is reached.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Warehouse upon which to execute a statement. See also\n[What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "statement", + "description": "The SQL statement to execute. The statement can optionally be parameterized, see `parameters`.\nThe maximum query text size is 16 MiB.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "warehouse_id", + "description": "Warehouse upon which to execute a statement. See also\n[What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html)", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStatement", + "description": "This request can be used to poll for the statement's status. StatementResponse contains\n`statement_id` and `status`; other fields might be absent or present depending on context.\nWhen the `status.state` field is `SUCCEEDED` it will also return the result manifest and the\nfirst chunk of the result data. When the statement is in the terminal states `CANCELED`,\n`CLOSED` or `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in\nterminal state, the statement is removed from the warehouse and further calls will receive an\nHTTP 404 response.\n\n**NOTE**\nThis call currently might take up to 5 seconds to get the latest status and result.", + "summary": "Get status, manifest, and result first chunk.", + "path": "/api/2.0/sql/statements/{statement_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStatementRequest", + "is_object": true, + "required_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StatementResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStatementResultChunkN", + "description": "After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by\nindex. Whereas the first chunk with `chunk_index=0` is typically fetched with\n:method:statementexecution/executeStatement or :method:statementexecution/getStatement, this\nrequest can be used to fetch subsequent chunks. The response structure is identical to the\nnested `result` element described in the :method:statementexecution/getStatement request, and\nsimilarly includes the `next_chunk_index` and `next_chunk_internal_link` fields for simple\niteration through the result set. Depending on `disposition`, the response returns chunks of\ndata either inline, or as links.", + "summary": "Get result chunk by index.", + "path": "/api/2.0/sql/statements/{statement_id}/result/chunks/{chunk_index}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStatementResultChunkNRequest", + "is_object": true, + "required_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "chunk_index", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ], + "required_in_url_fields": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "chunk_index", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + }, + "response": { + "pascal_name": "ResultData", + "is_object": true + }, + "all_fields": [ + { + "name": "chunk_index", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + }, + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "statement_id", + "description": "The statement ID is returned upon successfully submitting a SQL statement, and is a required\nreference for all subsequent calls.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "chunk_index", + "required": true, + "is_path": true, + "entity": { + "is_int": true + } + } + ] + } + ] + }, + { + "id": "provisioning.Storage", + "name": "Storage", + "description": "These APIs manage storage configurations for this workspace. A root storage S3 bucket in\nyour account is required to store objects like cluster logs, notebook revisions, and job\nresults. You can also use the root storage S3 bucket for storage of non-production DBFS\ndata. A storage configuration encapsulates this bucket information, and its ID is used when\ncreating a new workspace.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a Databricks storage configuration for an account.", + "summary": "Create a storage configuration.", + "path": "/api/2.0/accounts/{account_id}/storage-configurations", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateStorageConfigurationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "storage_configuration_name", + "description": "The human-readable name of the storage configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "root_bucket_info", + "description": "Root S3 bucket information.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RootBucketInfo", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "storage_configuration_name", + "description": "The human-readable name of the storage configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "root_bucket_info", + "description": "Root S3 bucket information.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RootBucketInfo", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "StorageConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "role_arn", + "description": "Optional IAM role that is used to access the workspace catalog which is created during workspace creation\nfor UC by Default. If a storage configuration with this field populated is used to create a workspace,\nthen a workspace catalog is created together with the workspace. The workspace catalog shares the root\nbucket with internal workspace storage (including DBFS root) but uses a dedicated bucket path prefix.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "root_bucket_info", + "description": "Root S3 bucket information.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "RootBucketInfo", + "is_object": true + } + }, + { + "name": "storage_configuration_name", + "description": "The human-readable name of the storage configuration.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace.", + "summary": "Delete a storage configuration.", + "path": "/api/2.0/accounts/{account_id}/storage-configurations/{storage_configuration_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteStorageRequest", + "is_object": true, + "required_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StorageConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a Databricks storage configuration for an account, both specified by ID.", + "summary": "Get a storage configuration.", + "path": "/api/2.0/accounts/{account_id}/storage-configurations/{storage_configuration_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStorageRequest", + "is_object": true, + "required_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StorageConfiguration", + "is_object": true + }, + "all_fields": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "storage_configuration_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks storage configurations for an account, specified by ID.", + "summary": "List storage configurations.", + "path": "/api/2.0/accounts/{account_id}/storage-configurations", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListStorageRequest", + "is_object": true + }, + "response": { + "pascal_name": "StorageConfigurationList", + "array_value": { + "pascal_name": "StorageConfiguration", + "is_object": true + } + } + } + ] + }, + { + "id": "catalog.StorageCredentials", + "name": "StorageCredentials", + "description": "A storage credential represents an authentication and authorization mechanism for accessing\ndata stored on your cloud tenant. Each storage credential is subject to\nUnity Catalog access-control policies that control which users and groups can access\nthe credential. If a user does not have access to a storage credential in Unity Catalog,\nthe request fails and Unity Catalog does not attempt to authenticate to your cloud tenant\non the user’s behalf.\n\nDatabricks recommends using external locations rather than using storage credentials\ndirectly.\n\nTo create storage credentials, you must be a Databricks account admin. The account admin\nwho creates the storage credential can delegate ownership to another user or group to\nmanage permissions on it.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListStorageCredentialsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new storage credential.\n\nThe caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the metastore.", + "summary": "Create a storage credential.", + "path": "/api/2.1/unity-catalog/storage-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateStorageCredential", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StorageCredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "description": "The AWS IAM role configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRoleRequest", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "description": "The Azure managed identity configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentityRequest", + "is_object": true + } + }, + { + "name": "azure_service_principal", + "description": "The Azure service principal configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureServicePrincipal", + "is_object": true + } + }, + { + "name": "cloudflare_api_token", + "description": "The Cloudflare API token configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloudflareApiToken", + "is_object": true + } + }, + { + "name": "comment", + "description": "Comment associated with the credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "databricks_gcp_service_account", + "description": "The Databricks managed GCP service account configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccountRequest", + "is_object": true + } + }, + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Supplying true to this argument skips validation of the created credential.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The credential name. The name must be unique among storage and service\ncredentials within the metastore.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.", + "summary": "Delete a credential.", + "path": "/api/2.1/unity-catalog/storage-credentials/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteStorageCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force an update even if there are dependent external locations or external\ntables (when purpose is **STORAGE**) or dependent services (when purpose is\n**SERVICE**).", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a storage credential from the metastore.\nThe caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential.", + "summary": "Get a credential.", + "path": "/api/2.1/unity-catalog/storage-credentials/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStorageCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StorageCredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of storage credentials (as __StorageCredentialInfo__ objects).\nThe array is limited to only those storage credentials the caller has permission to access.\nIf the caller is a metastore admin, retrieval of credentials is unrestricted.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List credentials.", + "path": "/api/2.1/unity-catalog/storage-credentials", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListStorageCredentialsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListStorageCredentialsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "include_unbound", + "description": "Whether to include credentials not bound to the workspace.\nEffective only if the user has permission to update the credential–workspace binding.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of storage credentials to return.\nIf not set, all the storage credentials are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of\nthis value and a server configured value;\n- when set to 0, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of storage credentials to return.\nIf not set, all the storage credentials are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of\nthis value and a server configured value;\n- when set to 0, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates a storage credential on the metastore.\n\nThe caller must be the owner of the storage credential or a metastore admin.\nIf the caller is a metastore admin, only the **owner** field can be changed.", + "summary": "Update a credential.", + "path": "/api/2.1/unity-catalog/storage-credentials/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateStorageCredential", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StorageCredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "description": "The AWS IAM role configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRoleRequest", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "description": "The Azure managed identity configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentityResponse", + "is_object": true + } + }, + { + "name": "azure_service_principal", + "description": "The Azure service principal configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureServicePrincipal", + "is_object": true + } + }, + { + "name": "cloudflare_api_token", + "description": "The Cloudflare API token configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloudflareApiToken", + "is_object": true + } + }, + { + "name": "comment", + "description": "Comment associated with the credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "databricks_gcp_service_account", + "description": "The Databricks managed GCP service account configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccountRequest", + "is_object": true + } + }, + { + "name": "force", + "description": "Force update even if there are dependent external locations or external\ntables.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "isolation_mode", + "description": "Whether the current securable is accessible from all workspaces or a\nspecific set of workspaces.", + "is_request_body_field": true, + "entity": { + "pascal_name": "IsolationMode", + "enum": [ + { + "content": "ISOLATION_MODE_ISOLATED" + }, + { + "content": "ISOLATION_MODE_OPEN" + } + ] + } + }, + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the storage credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of credential.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Whether the credential is usable only for read operations. Only applicable\nwhen purpose is **STORAGE**.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "skip_validation", + "description": "Supplying true to this argument skips validation of the updated credential.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Validate", + "description": "Validates a storage credential.\nAt least one of __external_location_name__ and __url__ need to be provided. If only one of them is\nprovided, it will be used for validation. And if both are provided, the __url__ will be used for\nvalidation, and __external_location_name__ will be ignored when checking overlapping urls.\n\nEither the __storage_credential_name__ or the cloud-specific credential must be provided.\n\nThe caller must be a metastore admin or the storage credential owner or\nhave the **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.", + "summary": "Validate a storage credential.", + "path": "/api/2.1/unity-catalog/validate-storage-credentials", + "can_use_json": true, + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ValidateStorageCredential", + "is_object": true + }, + "response": { + "pascal_name": "ValidateStorageCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_iam_role", + "description": "The AWS IAM role configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AwsIamRoleRequest", + "is_object": true + } + }, + { + "name": "azure_managed_identity", + "description": "The Azure managed identity configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureManagedIdentityRequest", + "is_object": true + } + }, + { + "name": "azure_service_principal", + "description": "The Azure service principal configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureServicePrincipal", + "is_object": true + } + }, + { + "name": "cloudflare_api_token", + "description": "The Cloudflare API token configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloudflareApiToken", + "is_object": true + } + }, + { + "name": "databricks_gcp_service_account", + "description": "The Databricks created GCP service account configuration.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DatabricksGcpServiceAccountRequest", + "is_object": true + } + }, + { + "name": "external_location_name", + "description": "The name of an existing external location to validate.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "read_only", + "description": "Whether the storage credential is only usable for read operations.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "storage_credential_name", + "description": "Required. The name of an existing credential or long-lived cloud\ncredential to validate.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "url", + "description": "The external location url to validate.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.AccountStorageCredentials", + "name": "AccountStorageCredentials", + "description": "These APIs manage storage credentials for a particular metastore.", + "package": { + "name": "catalog" + }, + "is_accounts": true, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountStorageCredentialsRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new storage credential. The request object is specific to the cloud:\n- **AwsIamRole** for AWS credentials\n- **AzureServicePrincipal** for Azure credentials\n- **GcpServiceAccountKey** for GCP credentials\n\nThe caller must be a metastore admin and have the `CREATE_STORAGE_CREDENTIAL` privilege on the metastore.", + "summary": "Create a storage credential.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsCreateStorageCredential", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsCreateStorageCredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "credential_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CreateAccountsStorageCredential", + "is_object": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "skip_validation", + "description": "Optional, default false.\nSupplying true to this argument skips validation of the created set of credentials.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.", + "summary": "Delete a storage credential.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials/{storage_credential_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountStorageCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsDeleteStorageCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the Storage Credential is not empty. Default is false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the\nstorage credential, or have a level of privilege on the storage credential.", + "summary": "Gets the named storage credential.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials/{storage_credential_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountStorageCredentialRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Required. Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Required. Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsStorageCredentialInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Required. Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Required. Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets a list of all storage credentials that have been assigned to given metastore.", + "summary": "Get all storage credentials assigned to a metastore.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountStorageCredentialsRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAccountStorageCredentialsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "Update", + "description": "Updates a storage credential on the metastore. The caller must be the owner of the storage credential.\nIf the caller is a metastore admin, only the **owner** credential can be changed.", + "summary": "Updates a storage credential.", + "path": "/api/2.0/accounts/{account_id}/metastores/{metastore_id}/storage-credentials/{storage_credential_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "AccountsUpdateStorageCredential", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountsUpdateStorageCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "credential_info", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UpdateAccountsStorageCredential", + "is_object": true + } + }, + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "skip_validation", + "description": "Optional. Supplying true to this argument skips validation of the updated set of credentials.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "Unity Catalog metastore ID", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_credential_name", + "description": "Name of the storage credential.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "supervisoragents.SupervisorAgents", + "name": "SupervisorAgents", + "description": "Manage Supervisor Agents and related resources.", + "package": { + "name": "supervisoragents" + }, + "docs_group": "agentbricks", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListExamplesRequest" + } + }, + "methods": [ + { + "name": "CreateExample", + "description": "Creates an example for a Supervisor Agent.", + "summary": "Create an example for a Supervisor Agent.", + "path": "/api/2.1/{parent=supervisor-agents/*}/examples", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateExampleRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "example", + "description": "The example to create under the parent Supervisor Agent.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "example", + "description": "The example to create under the parent Supervisor Agent.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "example", + "description": "The example to create under the parent Supervisor Agent.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + } + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "all_fields": [ + { + "name": "example", + "description": "The example to create under the parent Supervisor Agent.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + } + }, + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "example_id", + "description": "The universally unique identifier (UUID) of the example.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource where this example will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "CreateSupervisorAgent", + "description": "Creates a new Supervisor Agent.", + "summary": "Create a Supervisor Agent.", + "path": "/api/2.1/supervisor-agents", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateSupervisorAgentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "supervisor_agent", + "description": "The Supervisor Agent to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "supervisor_agent", + "description": "The Supervisor Agent to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "supervisor_agent", + "description": "The Supervisor Agent to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "supervisor_agent", + "description": "The Supervisor Agent to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "Creation timestamp.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The creator of the Supervisor Agent.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "The name of the supervisor agent's serving endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "experiment_id", + "description": "The MLflow experiment ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Deprecated: Use supervisor_agent_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Optional natural-language instructions for the supervisor agent.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "supervisor_agent_id", + "description": "The universally unique identifier (UUID) of the Supervisor Agent.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateTool", + "description": "Creates a Tool under a Supervisor Agent. Specify one of \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"app\", \"volume\", \"dashboard\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\" in the request body. The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "summary": "Create a Tool.", + "path": "/api/2.1/{parent=supervisor-agents/*}/tools", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateToolRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource where this tool will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true + } + }, + { + "name": "tool_id", + "description": "The ID to use for the tool, which will become the final component of\nthe tool's resource name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource where this tool will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_id", + "description": "The ID to use for the tool, which will become the final component of\nthe tool's resource name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tool", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "parent", + "description": "Parent resource where this tool will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "tool_id", + "description": "The ID to use for the tool, which will become the final component of\nthe tool's resource name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "app", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + }, + { + "name": "description", + "description": "Description of what this tool does (user-facing).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "genie_space", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GenieSpace", + "is_object": true + } + }, + { + "name": "id", + "description": "Deprecated: Use tool_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "knowledge_assistant", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + }, + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_id", + "description": "User specified id of the Tool.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "uc_connection", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcConnection", + "is_object": true + } + }, + { + "name": "uc_function", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcFunction", + "is_object": true + } + }, + { + "name": "volume", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Volume", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource where this tool will be created.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_id", + "description": "The ID to use for the tool, which will become the final component of\nthe tool's resource name.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteExample", + "description": "Deletes an example from a Supervisor Agent.", + "summary": "Delete an example from a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*/examples/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteExampleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example to delete.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSupervisorAgent", + "description": "Deletes a Supervisor Agent.", + "summary": "Delete a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteSupervisorAgentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteTool", + "description": "Deletes a Tool.", + "summary": "Delete a Tool.", + "path": "/api/2.1/{name=supervisor-agents/*/tools/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteToolRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetExample", + "description": "Gets an example from a Supervisor Agent.", + "summary": "Get an example from a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*/examples/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetExampleRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get supervisor agent permission levels.", + "path": "/api/2.0/permissions/supervisor-agents/{supervisor_agent_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSupervisorAgentPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetSupervisorAgentPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a supervisor agent. Supervisor agents can inherit permissions from their root object.", + "summary": "Get supervisor agent permissions.", + "path": "/api/2.0/permissions/supervisor-agents/{supervisor_agent_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSupervisorAgentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SupervisorAgentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSupervisorAgent", + "description": "Gets a Supervisor Agent.", + "summary": "Get a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSupervisorAgentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Supervisor Agent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetTool", + "description": "Gets a Tool.", + "summary": "Get a Tool.", + "path": "/api/2.1/{name=supervisor-agents/*/tools/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetToolRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the Tool.\nFormat: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListExamples", + "description": "Lists examples under a Supervisor Agent.", + "summary": "List examples for a Supervisor Agent.", + "path": "/api/2.1/{parent=supervisor-agents/*}/examples", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListExamplesRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListExamplesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of examples to return.\nIf unspecified, at most 100 examples will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSupervisorAgents", + "description": "Lists Supervisor Agents.", + "summary": "List Supervisor Agents.", + "path": "/api/2.1/supervisor-agents", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListSupervisorAgentsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListSupervisorAgentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of supervisor agents to return.\nIf unspecified, at most 100 supervisor agents will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListSupervisorAgents` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListSupervisorAgents` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListTools", + "description": "Lists Tools under a Supervisor Agent.", + "summary": "List Tools.", + "path": "/api/2.1/{parent=supervisor-agents/*}/tools", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListToolsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListToolsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Parent resource to list from.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set supervisor agent permissions.", + "path": "/api/2.0/permissions/supervisor-agents/{supervisor_agent_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "SupervisorAgentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SupervisorAgentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgentAccessControlRequestList", + "array_value": { + "pascal_name": "SupervisorAgentAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateExample", + "description": "Updates an example in a Supervisor Agent.", + "summary": "Update an example in a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*/examples/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateExampleRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + } + }, + "response": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "all_fields": [ + { + "name": "example", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Example", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_request_body_fields": [ + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + } + }, + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "example_id", + "description": "The universally unique identifier (UUID) of the example.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the example to update.\nFormat: supervisor-agents/{supervisor_agent_id}/examples/{example_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "question", + "description": "The example question.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "guidelines", + "description": "Guidelines for answering the question.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a supervisor agent. Supervisor agents can inherit permissions from their root object.", + "summary": "Update supervisor agent permissions.", + "path": "/api/2.0/permissions/supervisor-agents/{supervisor_agent_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "SupervisorAgentPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SupervisorAgentPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgentAccessControlRequestList", + "array_value": { + "pascal_name": "SupervisorAgentAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "supervisor_agent_id", + "description": "The supervisor agent for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSupervisorAgent", + "description": "Updates a Supervisor Agent. The fields that are required depend on the paths specified in `update_mask`.\nOnly fields included in the mask will be updated.", + "summary": "Update a Supervisor Agent.", + "path": "/api/2.1/{name=supervisor-agents/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateSupervisorAgentRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "supervisor_agent", + "description": "The SupervisorAgent to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "supervisor_agent", + "description": "The SupervisorAgent to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "supervisor_agent", + "description": "The SupervisorAgent to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "supervisor_agent", + "description": "The SupervisorAgent to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SupervisorAgent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Creation timestamp.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "creator", + "description": "The creator of the Supervisor Agent.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "description": "Description of what this agent can do (user-facing).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "The name of the supervisor agent's serving endpoint.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "experiment_id", + "description": "The MLflow experiment ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Deprecated: Use supervisor_agent_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instructions", + "description": "Optional natural-language instructions for the supervisor agent.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "supervisor_agent_id", + "description": "The universally unique identifier (UUID) of the Supervisor Agent.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "display_name", + "description": "The display name of the Supervisor Agent, unique at workspace level.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateTool", + "description": "Updates a Tool. Only the `description` field can be updated.\nTo change immutable fields such as tool type, spec, or tool ID, delete the tool and recreate it.", + "summary": "Update a Tool.", + "path": "/api/2.1/{name=supervisor-agents/*/tools/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateToolRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool", + "description": "The Tool to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool", + "description": "The Tool to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tool", + "description": "The Tool to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool", + "description": "The Tool to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Tool", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "app", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "App", + "is_object": true + } + }, + { + "name": "description", + "description": "Description of what this tool does (user-facing).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "genie_space", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GenieSpace", + "is_object": true + } + }, + { + "name": "id", + "description": "Deprecated: Use tool_id instead.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "knowledge_assistant", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "KnowledgeAssistant", + "is_object": true + } + }, + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_id", + "description": "User specified id of the Tool.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "uc_connection", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcConnection", + "is_object": true + } + }, + { + "name": "uc_function", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "UcFunction", + "is_object": true + } + }, + { + "name": "volume", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Volume", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Field mask for fields to be updated.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "tool_type", + "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.SystemSchemas", + "name": "SystemSchemas", + "description": "A system schema is a schema that lives within the system catalog. A system schema may contain\ninformation about customer usage of Unity Catalog such as audit-logs, billing-logs,\nlineage information, etc.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListSystemSchemasRequest" + } + }, + "methods": [ + { + "name": "Disable", + "description": "Disables the system schema and removes it from the system catalog.\nThe caller must be an account admin or a metastore admin.", + "summary": "Disable a system schema.", + "path": "/api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas/{schema_name}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DisableRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DisableResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Enable", + "description": "Enables the system schema and adds it to the system catalog.\nThe caller must be an account admin or a metastore admin.", + "summary": "Enable a system schema.", + "path": "/api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas/{schema_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "EnableRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EnableResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "the catalog for which the system schema is to enabled in", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "The metastore ID under which the system schema lives.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Full name of the system schema.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of system schemas for a metastore.\nThe caller must be an account admin or a metastore admin.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List system schemas.", + "path": "/api/2.1/unity-catalog/metastores/{metastore_id}/systemschemas", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListSystemSchemasRequest", + "is_object": true, + "required_fields": [ + { + "name": "metastore_id", + "description": "The ID for the metastore in which the system schema resides.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "metastore_id", + "description": "The ID for the metastore in which the system schema resides.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSystemSchemasResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of schemas to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the schemas are returned (not recommended).", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "metastore_id", + "description": "The ID for the metastore in which the system schema resides.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "metastore_id", + "description": "The ID for the metastore in which the system schema resides.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of schemas to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the schemas are returned (not recommended).", + "is_query": true, + "entity": { + "is_int": true + } + } + } + } + ] + }, + { + "id": "catalog.TableConstraints", + "name": "TableConstraints", + "description": "Primary key and foreign key constraints encode relationships between fields in tables.\n\nPrimary and foreign keys are informational only and are not enforced. Foreign keys must reference a primary key in another table.\nThis primary key is the parent constraint of the foreign key and the table this primary key is on is the parent table of the foreign key.\nSimilarly, the foreign key is the child constraint of its referenced primary key; the table of the foreign key is the child table of the primary key.\n\nYou can declare primary keys and foreign keys as part of the table specification during table creation.\nYou can also add or drop constraints on existing tables.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a new table constraint.\n\nFor the table constraint creation to succeed, the user must satisfy both of these conditions:\n- the user must have the **USE_CATALOG** privilege on the table's parent catalog,\nthe **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.\n- if the new constraint is a __ForeignKeyConstraint__,\nthe user must have the **USE_CATALOG** privilege on the referenced parent table's catalog,\nthe **USE_SCHEMA** privilege on the referenced parent table's schema,\nand be the owner of the referenced parent table.", + "summary": "Create a table constraint.", + "path": "/api/2.1/unity-catalog/constraints", + "can_use_json": true, + "must_use_json": true, + "is_crud_create": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateTableConstraint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "full_name_arg", + "description": "The full name of the table referenced by the constraint.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "constraint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableConstraint", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "full_name_arg", + "description": "The full name of the table referenced by the constraint.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "constraint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableConstraint", + "is_object": true + } + } + ] + }, + "response": { + "pascal_name": "TableConstraint", + "is_object": true + }, + "all_fields": [ + { + "name": "constraint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableConstraint", + "is_object": true + } + }, + { + "name": "full_name_arg", + "description": "The full name of the table referenced by the constraint.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a table constraint.\n\nFor the table constraint deletion to succeed, the user must satisfy both of these conditions:\n- the user must have the **USE_CATALOG** privilege on the table's parent catalog,\nthe **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table.\n- if __cascade__ argument is **true**, the user must have the following permissions on all of the child tables:\nthe **USE_CATALOG** privilege on the table's catalog,\nthe **USE_SCHEMA** privilege on the table's schema,\nand be the owner of the table.", + "summary": "Delete a table constraint.", + "path": "/api/2.1/unity-catalog/constraints/{full_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTableConstraintRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the table referenced by the constraint.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "constraint_name", + "description": "The name of the constraint to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cascade", + "description": "If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints.", + "required": true, + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the table referenced by the constraint.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "constraint_name", + "description": "The name of the constraint to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cascade", + "description": "If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints.", + "required": true, + "is_query": true, + "entity": { + "is_bool": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteTableConstraintResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "cascade", + "description": "If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints.", + "required": true, + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "constraint_name", + "description": "The name of the constraint to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "full_name", + "description": "Full name of the table referenced by the constraint.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the table referenced by the constraint.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "constraint_name", + "description": "The name of the constraint to delete.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "cascade", + "description": "If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints.", + "required": true, + "is_query": true, + "entity": { + "is_bool": true + } + } + ] + } + ] + }, + { + "id": "catalog.Tables", + "name": "Tables", + "description": "A table resides in the third layer of Unity Catalog’s three-level namespace. It contains\nrows of data. To create a table, users must have CREATE_TABLE and USE_SCHEMA permissions on the schema,\nand they must have the USE_CATALOG permission on its parent catalog. To query a table, users must\nhave the SELECT permission on the table, and they must have the USE_CATALOG permission on its\nparent catalog and the USE_SCHEMA permission on its parent schema.\n\nA table can be managed or external.\nFrom an API perspective, a __VIEW__ is a particular kind of table (rather than a managed or external table).", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListTablesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new table in the specified catalog and schema.\n\nTo create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema\nand the **EXTERNAL_USE_LOCATION** privilege on the external location. These privileges must always be granted explicitly,\nand cannot be inherited through ownership or **ALL_PRIVILEGES**.\n\nStandard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent catalog (or ownership of\nthe parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent schema (or ownership of the parent schema),\nand **CREATE_EXTERNAL_TABLE** on external location.\n\nThe **columns** field needs to be in a Spark compatible format, so we recommend you use Spark to create these tables.\nThe API itself does not validate the correctness of the column spec. If the spec is not Spark compatible,\nthe tables may not be readable by Databricks Runtime.\n\nNOTE: The Create Table API for external clients only supports creating **external delta tables**. The values shown\nin the respective enums are all values supported by Databricks, however for this specific Create Table API,\nonly **table_type** **EXTERNAL** and **data_source_format** **DELTA** are supported. Additionally, column masks\nare not supported when creating tables through this API.", + "summary": "Create a table.", + "path": "/api/2.1/unity-catalog/tables", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateTableRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of table, relative to parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "EXTERNAL_SHALLOW_CLONE" + }, + { + "content": "FOREIGN" + }, + { + "content": "MANAGED" + }, + { + "content": "MANAGED_SHALLOW_CLONE" + }, + { + "content": "MATERIALIZED_VIEW" + }, + { + "content": "METRIC_VIEW" + }, + { + "content": "STREAMING_TABLE" + }, + { + "content": "VIEW" + } + ] + } + }, + { + "name": "data_source_format", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSourceFormat", + "enum": [ + { + "content": "AVRO" + }, + { + "content": "BIGQUERY_FORMAT" + }, + { + "content": "CSV" + }, + { + "content": "DATABRICKS_FORMAT" + }, + { + "content": "DATABRICKS_ROW_STORE_FORMAT" + }, + { + "content": "DELTA" + }, + { + "content": "DELTASHARING" + }, + { + "content": "DELTA_UNIFORM_HUDI" + }, + { + "content": "DELTA_UNIFORM_ICEBERG" + }, + { + "content": "HIVE" + }, + { + "content": "ICEBERG" + }, + { + "content": "JSON" + }, + { + "content": "MONGODB_FORMAT" + }, + { + "content": "MYSQL_FORMAT" + }, + { + "content": "NETSUITE_FORMAT" + }, + { + "content": "ORACLE_FORMAT" + }, + { + "content": "ORC" + }, + { + "content": "PARQUET" + }, + { + "content": "POSTGRESQL_FORMAT" + }, + { + "content": "REDSHIFT_FORMAT" + }, + { + "content": "SALESFORCE_DATA_CLOUD_FORMAT" + }, + { + "content": "SALESFORCE_FORMAT" + }, + { + "content": "SNOWFLAKE_FORMAT" + }, + { + "content": "SQLDW_FORMAT" + }, + { + "content": "SQLSERVER_FORMAT" + }, + { + "content": "TERADATA_FORMAT" + }, + { + "content": "TEXT" + }, + { + "content": "UNITY_CATALOG" + }, + { + "content": "VECTOR_INDEX_FORMAT" + }, + { + "content": "WORKDAY_RAAS_FORMAT" + } + ] + } + }, + { + "name": "storage_location", + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of table, relative to parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "EXTERNAL_SHALLOW_CLONE" + }, + { + "content": "FOREIGN" + }, + { + "content": "MANAGED" + }, + { + "content": "MANAGED_SHALLOW_CLONE" + }, + { + "content": "MATERIALIZED_VIEW" + }, + { + "content": "METRIC_VIEW" + }, + { + "content": "STREAMING_TABLE" + }, + { + "content": "VIEW" + } + ] + } + }, + { + "name": "data_source_format", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSourceFormat", + "enum": [ + { + "content": "AVRO" + }, + { + "content": "BIGQUERY_FORMAT" + }, + { + "content": "CSV" + }, + { + "content": "DATABRICKS_FORMAT" + }, + { + "content": "DATABRICKS_ROW_STORE_FORMAT" + }, + { + "content": "DELTA" + }, + { + "content": "DELTASHARING" + }, + { + "content": "DELTA_UNIFORM_HUDI" + }, + { + "content": "DELTA_UNIFORM_ICEBERG" + }, + { + "content": "HIVE" + }, + { + "content": "ICEBERG" + }, + { + "content": "JSON" + }, + { + "content": "MONGODB_FORMAT" + }, + { + "content": "MYSQL_FORMAT" + }, + { + "content": "NETSUITE_FORMAT" + }, + { + "content": "ORACLE_FORMAT" + }, + { + "content": "ORC" + }, + { + "content": "PARQUET" + }, + { + "content": "POSTGRESQL_FORMAT" + }, + { + "content": "REDSHIFT_FORMAT" + }, + { + "content": "SALESFORCE_DATA_CLOUD_FORMAT" + }, + { + "content": "SALESFORCE_FORMAT" + }, + { + "content": "SNOWFLAKE_FORMAT" + }, + { + "content": "SQLDW_FORMAT" + }, + { + "content": "SQLSERVER_FORMAT" + }, + { + "content": "TERADATA_FORMAT" + }, + { + "content": "TEXT" + }, + { + "content": "UNITY_CATALOG" + }, + { + "content": "VECTOR_INDEX_FORMAT" + }, + { + "content": "WORKDAY_RAAS_FORMAT" + } + ] + } + }, + { + "name": "storage_location", + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TableInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "columns", + "description": "The array of __ColumnInfo__ definitions of the table's columns.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ColumnInfoList", + "array_value": { + "pascal_name": "ColumnInfo", + "is_object": true + } + } + }, + { + "name": "data_source_format", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSourceFormat", + "enum": [ + { + "content": "AVRO" + }, + { + "content": "BIGQUERY_FORMAT" + }, + { + "content": "CSV" + }, + { + "content": "DATABRICKS_FORMAT" + }, + { + "content": "DATABRICKS_ROW_STORE_FORMAT" + }, + { + "content": "DELTA" + }, + { + "content": "DELTASHARING" + }, + { + "content": "DELTA_UNIFORM_HUDI" + }, + { + "content": "DELTA_UNIFORM_ICEBERG" + }, + { + "content": "HIVE" + }, + { + "content": "ICEBERG" + }, + { + "content": "JSON" + }, + { + "content": "MONGODB_FORMAT" + }, + { + "content": "MYSQL_FORMAT" + }, + { + "content": "NETSUITE_FORMAT" + }, + { + "content": "ORACLE_FORMAT" + }, + { + "content": "ORC" + }, + { + "content": "PARQUET" + }, + { + "content": "POSTGRESQL_FORMAT" + }, + { + "content": "REDSHIFT_FORMAT" + }, + { + "content": "SALESFORCE_DATA_CLOUD_FORMAT" + }, + { + "content": "SALESFORCE_FORMAT" + }, + { + "content": "SNOWFLAKE_FORMAT" + }, + { + "content": "SQLDW_FORMAT" + }, + { + "content": "SQLSERVER_FORMAT" + }, + { + "content": "TERADATA_FORMAT" + }, + { + "content": "TEXT" + }, + { + "content": "UNITY_CATALOG" + }, + { + "content": "VECTOR_INDEX_FORMAT" + }, + { + "content": "WORKDAY_RAAS_FORMAT" + } + ] + } + }, + { + "name": "name", + "description": "Name of table, relative to parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "properties", + "description": "A map of key-value properties attached to the securable.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_location", + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "EXTERNAL_SHALLOW_CLONE" + }, + { + "content": "FOREIGN" + }, + { + "content": "MANAGED" + }, + { + "content": "MANAGED_SHALLOW_CLONE" + }, + { + "content": "MATERIALIZED_VIEW" + }, + { + "content": "METRIC_VIEW" + }, + { + "content": "STREAMING_TABLE" + }, + { + "content": "VIEW" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of table, relative to parent schema.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "catalog_name", + "description": "Name of parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of parent schema relative to its parent catalog.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TableType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "EXTERNAL_SHALLOW_CLONE" + }, + { + "content": "FOREIGN" + }, + { + "content": "MANAGED" + }, + { + "content": "MANAGED_SHALLOW_CLONE" + }, + { + "content": "MATERIALIZED_VIEW" + }, + { + "content": "METRIC_VIEW" + }, + { + "content": "STREAMING_TABLE" + }, + { + "content": "VIEW" + } + ] + } + }, + { + "name": "data_source_format", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DataSourceFormat", + "enum": [ + { + "content": "AVRO" + }, + { + "content": "BIGQUERY_FORMAT" + }, + { + "content": "CSV" + }, + { + "content": "DATABRICKS_FORMAT" + }, + { + "content": "DATABRICKS_ROW_STORE_FORMAT" + }, + { + "content": "DELTA" + }, + { + "content": "DELTASHARING" + }, + { + "content": "DELTA_UNIFORM_HUDI" + }, + { + "content": "DELTA_UNIFORM_ICEBERG" + }, + { + "content": "HIVE" + }, + { + "content": "ICEBERG" + }, + { + "content": "JSON" + }, + { + "content": "MONGODB_FORMAT" + }, + { + "content": "MYSQL_FORMAT" + }, + { + "content": "NETSUITE_FORMAT" + }, + { + "content": "ORACLE_FORMAT" + }, + { + "content": "ORC" + }, + { + "content": "PARQUET" + }, + { + "content": "POSTGRESQL_FORMAT" + }, + { + "content": "REDSHIFT_FORMAT" + }, + { + "content": "SALESFORCE_DATA_CLOUD_FORMAT" + }, + { + "content": "SALESFORCE_FORMAT" + }, + { + "content": "SNOWFLAKE_FORMAT" + }, + { + "content": "SQLDW_FORMAT" + }, + { + "content": "SQLSERVER_FORMAT" + }, + { + "content": "TERADATA_FORMAT" + }, + { + "content": "TEXT" + }, + { + "content": "UNITY_CATALOG" + }, + { + "content": "VECTOR_INDEX_FORMAT" + }, + { + "content": "WORKDAY_RAAS_FORMAT" + } + ] + } + }, + { + "name": "storage_location", + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a table from the specified parent catalog and schema.\nThe caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,\nor be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Delete a table.", + "path": "/api/2.1/unity-catalog/tables/{full_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Exists", + "description": "Gets if a table exists in the metastore for a specific catalog and schema.\nThe caller must satisfy one of the following requirements:\n* Be a metastore admin\n* Be the owner of the parent catalog\n* Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog\n* Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,\nand either be the table owner or have the **SELECT** privilege on the table.\n* Have **BROWSE** privilege on the parent catalog\n* Have **BROWSE** privilege on the parent schema", + "summary": "Get boolean reflecting if table exists.", + "path": "/api/2.1/unity-catalog/tables/{full_name}/exists", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExistsRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TableExistsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a table from the metastore for a specific catalog and schema.\nThe caller must satisfy one of the following requirements:\n* Be a metastore admin\n* Be the owner of the parent catalog\n* Be the owner of the parent schema and have the **USE_CATALOG** privilege on the parent catalog\n* Have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,\nand either be the table owner or have the **SELECT** privilege on the table.", + "summary": "Get a table.", + "path": "/api/2.1/unity-catalog/tables/{full_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TableInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include tables in the response for which the principal can only access selective metadata for.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_delta_metadata", + "description": "Whether delta metadata should be included in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_manifest_capabilities", + "description": "Whether to include a manifest containing table capabilities in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of all tables for the current metastore under the parent catalog and schema.\nThe caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\nThere is no guarantee of a specific ordering of the elements in the array.\n\nNOTE: **view_dependencies** and **table_constraints** are not returned by ListTables queries.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List tables.", + "path": "/api/2.1/unity-catalog/tables", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListTablesRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of tables.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of tables.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListTablesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include tables in the response for which the principal can only access selective metadata for.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "include_manifest_capabilities", + "description": "Whether to include a manifest containing table capabilities in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of tables to return.\nIf not set, all the tables are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "omit_columns", + "description": "Whether to omit the columns of the table from the response or not.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "omit_properties", + "description": "Whether to omit the properties of the table from the response or not.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "omit_username", + "description": "Whether to omit the username of the table (e.g. owner, updated_by, created_by) from the response or not.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "page_token", + "description": "Opaque token to send for the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of tables.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Parent schema of tables.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque token to send for the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of tables to return.\nIf not set, all the tables are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "ListSummaries", + "description": "Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either:\n\n* summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or:\n* summaries for tables and schemas (within the current metastore and parent catalog)\nfor which the user has ownership or the **SELECT** privilege on the table and ownership or **USE_SCHEMA** privilege on the schema,\nprovided that the user also has ownership or the **USE_CATALOG** privilege on the parent catalog.\n\nThere is no guarantee of a specific ordering of the elements in the array.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List table summaries.", + "path": "/api/2.1/unity-catalog/table-summaries", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListSummariesRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListTableSummariesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_manifest_capabilities", + "description": "Whether to include a manifest containing table capabilities in the response.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of summaries for tables to return.\nIf not set, the page length is set to a server configured value (10000, as of 1/5/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/5/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 1/5/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name_pattern", + "description": "A sql LIKE pattern (% and _) for schema names.\nAll schemas will be returned if not set or empty.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "table_name_pattern", + "description": "A sql LIKE pattern (% and _) for table names.\nAll tables will be returned if not set or empty.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of parent catalog for tables of interest.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Update", + "description": "Change the owner of the table.\nThe caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema,\nor be the owner of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Update a table owner.", + "path": "/api/2.1/unity-catalog/tables/{full_name}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateTableRequest", + "is_object": true, + "required_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Username of current owner of table.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "full_name", + "description": "Full name of the table.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "tags.TagPolicies", + "name": "TagPolicies", + "description": "The Tag Policy API allows you to manage policies for governed tags in Databricks. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy). Permissions for tag policies can be managed using the [Account Access Control Proxy API](https://docs.databricks.com/api/workspace/accountaccesscontrolproxy).", + "package": { + "name": "tags" + }, + "docs_group": "tags", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListTagPoliciesRequest" + } + }, + "methods": [ + { + "name": "CreateTagPolicy", + "description": "Creates a new tag policy, making the associated tag key governed. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy). To manage permissions for tag policies, use the [Account Access Control Proxy API](https://docs.databricks.com/api/workspace/accountaccesscontrolproxy).", + "summary": "Create a new tag policy.", + "path": "/api/2.1/tag-policies", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateTagPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "Timestamp when the tag policy was created", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Timestamp when the tag policy was last updated", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "values", + "is_request_body_field": true, + "entity": { + "pascal_name": "ValueList", + "array_value": { + "pascal_name": "Value", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteTagPolicy", + "description": "Deletes a tag policy by its associated governed tag's key, leaving that tag key ungoverned. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy).", + "summary": "Delete a tag policy.", + "path": "/api/2.1/tag-policies/{tag_key}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTagPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetTagPolicy", + "description": "Gets a single tag policy by its associated governed tag's key. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policy). To list granted permissions for tag policies, use the [Account Access Control Proxy API](https://docs.databricks.com/api/workspace/accountaccesscontrolproxy).", + "summary": "Get a tag policy.", + "path": "/api/2.1/tag-policies/{tag_key}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetTagPolicyRequest", + "is_object": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListTagPolicies", + "description": "Lists the tag policies for all governed tags in the account. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policies). To list granted permissions for tag policies, use the [Account Access Control Proxy API](https://docs.databricks.com/api/workspace/accountaccesscontrolproxy).", + "summary": "List tag policies.", + "path": "/api/2.1/tag-policies", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListTagPoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListTagPoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of results to return in this request. Fewer results may be returned than requested. If\nunspecified or set to 0, this defaults to 1000. The maximum value is 1000; values above 1000 will be coerced down\nto 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "An optional page token received from a previous list tag policies call.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "An optional page token received from a previous list tag policies call.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateTagPolicy", + "description": "Updates an existing tag policy for a single governed tag. For Terraform usage, see the [Tag Policy Terraform documentation](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy). To manage permissions for tag policies, use the [Account Access Control Proxy API](https://docs.databricks.com/api/workspace/accountaccesscontrolproxy).", + "summary": "Update an existing tag policy.", + "path": "/api/2.1/tag-policies/{tag_key}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateTagPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_policy", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagPolicy", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Timestamp when the tag policy was created", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "description", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Timestamp when the tag policy was last updated", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "values", + "is_request_body_field": true, + "entity": { + "pascal_name": "ValueList", + "array_value": { + "pascal_name": "Value", + "is_object": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "tag_key", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.TemporaryPathCredentials", + "name": "TemporaryPathCredentials", + "description": "Temporary Path Credentials refer to short-lived, downscoped credentials used to access external cloud storage locations registered in Databricks. These credentials are employed to provide secure and time-limited access to data in cloud environments such as AWS, Azure, and Google Cloud. Each cloud provider has its own type of credentials: AWS uses temporary session tokens via AWS Security Token Service (STS), Azure utilizes Shared Access Signatures (SAS) for its data storage services, and Google Cloud supports temporary credentials through OAuth 2.0.\n\nTemporary path credentials ensure that data access is limited in scope and duration, reducing the risk of unauthorized access or misuse. To use the temporary path credentials API, a metastore admin needs to enable the external_access_enabled flag (off by default) at the metastore level. A user needs to be granted the EXTERNAL USE LOCATION permission by external location owner. For requests on existing external tables and external volumes, user also needs to be granted the EXTERNAL USE SCHEMA permission at the schema level by catalog owner.\n\nNote that EXTERNAL USE SCHEMA is a schema level permission that can only be granted by catalog owner explicitly and is not included in schema ownership or ALL PRIVILEGES on the schema for security reasons. Similarly, EXTERNAL USE LOCATION is an external location level permission that can only be granted by external location owner explicitly and is not included in external location ownership or ALL PRIVILEGES on the external location for security reasons.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GenerateTemporaryPathCredentials", + "description": "Get a short-lived credential for directly accessing cloud storage locations registered in Databricks.\nThe Generate Temporary Path Credentials API is only supported for external storage paths, specifically external\nlocations and external tables. Managed tables are not supported by this API.\nThe metastore must have **external_access_enabled** flag set to true (default false).\nThe caller must have the **EXTERNAL_USE_LOCATION** privilege on the external location; this privilege can only be granted\nby external location owners.\nFor requests on existing external tables, the caller must also have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema;\nthis privilege can only be granted by catalog owners.", + "summary": "Generate a temporary path credential.", + "path": "/api/2.0/unity-catalog/temporary-path-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenerateTemporaryPathCredentialRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "url", + "description": "URL for path-based access.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "operation", + "description": "The operation being performed on the path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PathOperation", + "enum": [ + { + "content": "PATH_CREATE_TABLE" + }, + { + "content": "PATH_READ" + }, + { + "content": "PATH_READ_WRITE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "url", + "description": "URL for path-based access.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "operation", + "description": "The operation being performed on the path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PathOperation", + "enum": [ + { + "content": "PATH_CREATE_TABLE" + }, + { + "content": "PATH_READ" + }, + { + "content": "PATH_READ_WRITE" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "GenerateTemporaryPathCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dry_run", + "description": "Optional. When set to true, the service will not validate that the generated\ncredentials can perform write operations, therefore no new paths will be created\nand the response will not contain valid credentials. Defaults to false.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "operation", + "description": "The operation being performed on the path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PathOperation", + "enum": [ + { + "content": "PATH_CREATE_TABLE" + }, + { + "content": "PATH_READ" + }, + { + "content": "PATH_READ_WRITE" + } + ] + } + }, + { + "name": "url", + "description": "URL for path-based access.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "url", + "description": "URL for path-based access.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "operation", + "description": "The operation being performed on the path.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PathOperation", + "enum": [ + { + "content": "PATH_CREATE_TABLE" + }, + { + "content": "PATH_READ" + }, + { + "content": "PATH_READ_WRITE" + } + ] + } + } + ] + } + ] + }, + { + "id": "catalog.TemporaryTableCredentials", + "name": "TemporaryTableCredentials", + "description": "Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud storage locations where table data is stored in Databricks. These credentials are employed to provide secure and time-limited access to data in cloud environments such as AWS, Azure, and Google Cloud. Each cloud provider has its own type of credentials: AWS uses temporary session tokens via AWS Security Token Service (STS), Azure utilizes Shared Access Signatures (SAS) for its data storage services, and Google Cloud supports temporary credentials through OAuth 2.0.\n\nTemporary table credentials ensure that data access is limited in scope and duration, reducing the risk of unauthorized access or misuse. To use the temporary table credentials API, a metastore admin needs to enable the external_access_enabled flag (off by default) at the metastore level, and user needs to be granted the EXTERNAL USE SCHEMA permission at the schema level by catalog owner. Note that EXTERNAL USE SCHEMA is a schema level permission that can only be granted by catalog owner explicitly and is not included in schema ownership or ALL PRIVILEGES on the schema for security reasons.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GenerateTemporaryTableCredentials", + "description": "Get a short-lived credential for directly accessing the table data on cloud storage.\nThe metastore must have **external_access_enabled** flag set to true (default false).\nThe caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can only be granted\nby catalog owners.", + "summary": "Generate a temporary table credential.", + "path": "/api/2.0/unity-catalog/temporary-table-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GenerateTemporaryTableCredentialRequest", + "is_object": true + }, + "response": { + "pascal_name": "GenerateTemporaryTableCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "operation", + "description": "The operation performed against the table data, either READ or READ_WRITE. If READ_WRITE is specified,\nthe credentials returned will have write permissions, otherwise, it will be read only.", + "is_request_body_field": true, + "entity": { + "pascal_name": "TableOperation", + "enum": [ + { + "content": "READ" + }, + { + "content": "READ_WRITE" + } + ] + } + }, + { + "name": "table_id", + "description": "UUID of the table to read or write.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.TemporaryVolumeCredentials", + "name": "TemporaryVolumeCredentials", + "description": "Temporary Volume Credentials refer to short-lived, downscoped credentials used to access cloud storage locations where volume data is stored in Databricks. These credentials are employed to provide secure and time-limited access to data in cloud environments such as AWS, Azure, and Google Cloud. Each cloud provider has its own type of credentials: AWS uses temporary session tokens via AWS Security Token Service (STS), Azure utilizes Shared Access Signatures (SAS) for its data storage services, and Google Cloud supports temporary credentials through OAuth 2.0.\n\nTemporary volume credentials ensure that data access is limited in scope and duration, reducing the risk of unauthorized access or misuse. To use the temporary volume credentials API, a metastore admin needs to enable the external_access_enabled flag (off by default) at the metastore level, and user needs to be granted the EXTERNAL USE SCHEMA permission at the schema level by catalog owner. Note that EXTERNAL USE SCHEMA is a schema level permission that can only be granted by catalog owner explicitly and is not included in schema ownership or ALL PRIVILEGES on the schema for security reasons.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "GenerateTemporaryVolumeCredentials", + "description": "Get a short-lived credential for directly accessing the volume data on cloud storage.\nThe metastore must have **external_access_enabled** flag set to true (default false).\nThe caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and this privilege can only be granted\nby catalog owners.", + "summary": "Generate a temporary volume credential.", + "path": "/api/2.0/unity-catalog/temporary-volume-credentials", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GenerateTemporaryVolumeCredentialRequest", + "is_object": true + }, + "response": { + "pascal_name": "GenerateTemporaryVolumeCredentialResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "operation", + "description": "The operation performed against the volume data, either READ_VOLUME or WRITE_VOLUME. If WRITE_VOLUME is specified,\nthe credentials returned will have write permissions, otherwise, it will be read only.", + "is_request_body_field": true, + "entity": { + "pascal_name": "VolumeOperation", + "enum": [ + { + "content": "READ_VOLUME" + }, + { + "content": "WRITE_VOLUME" + } + ] + } + }, + { + "name": "volume_id", + "description": "Id of the volume to read or write.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.TokenManagement", + "name": "TokenManagement", + "description": "Enables administrators to get all tokens and delete tokens for other users. Admins can\neither get every token, get a specific token by ID, or get all tokens for a particular user.", + "package": { + "name": "settings" + }, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "TokenInfoCommentToTokenIdMap" + }, + "request": { + "pascal_name": "ListTokenManagementRequest" + } + }, + "methods": [ + { + "name": "CreateOboToken", + "description": "Creates a token on behalf of a service principal.", + "summary": "Create on-behalf token.", + "path": "/api/2.0/token-management/on-behalf-of/tokens", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateOboTokenRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "application_id", + "description": "Application ID of the service principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "application_id", + "description": "Application ID of the service principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "CreateOboTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "application_id", + "description": "Application ID of the service principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "autoscope_enabled", + "description": "Whether to enable autoscoping for this token.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "comment", + "description": "Comment that describes the purpose of the token.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifetime_seconds", + "description": "The number of seconds before the token expires.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "scopes", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "application_id", + "description": "Application ID of the service principal.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a token, specified by its ID.", + "summary": "Delete a token.", + "path": "/api/2.0/token-management/tokens/{token_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteTokenManagementRequest", + "is_object": true, + "required_fields": [ + { + "name": "token_id", + "description": "The ID of the token to revoke.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "token_id", + "description": "The ID of the token to revoke.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "token_id", + "description": "The ID of the token to revoke.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "token_id", + "description": "The ID of the token to revoke.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets information about a token, specified by its ID.", + "summary": "Get token info.", + "path": "/api/2.0/token-management/tokens/{token_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetTokenManagementRequest", + "is_object": true, + "required_fields": [ + { + "name": "token_id", + "description": "The ID of the token to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "token_id", + "description": "The ID of the token to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "token_id", + "description": "The ID of the token to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "token_id", + "description": "The ID of the token to get.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get token permission levels.", + "path": "/api/2.0/permissions/authorization/tokens/permissionLevels", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetTokenPermissionLevelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetTokenPermissionLevelsResponse", + "is_object": true + } + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of all tokens. Tokens can inherit permissions from their root object.", + "summary": "Get token permissions.", + "path": "/api/2.0/permissions/authorization/tokens", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetTokenPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "TokenPermissions", + "is_object": true + } + }, + { + "name": "List", + "description": "Lists all tokens associated with the specified workspace or user.", + "summary": "List all tokens.", + "path": "/api/2.0/token-management/tokens", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListTokenManagementRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListTokensResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "created_by_id", + "description": "User ID of the user that created the token.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "created_by_username", + "description": "Username of the user that created the token.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set token permissions.", + "path": "/api/2.0/permissions/authorization/tokens", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TokenPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "TokenPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenAccessControlRequestList", + "array_value": { + "pascal_name": "TokenAccessControlRequest", + "is_object": true + } + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on all tokens. Tokens can inherit permissions from their root object.", + "summary": "Update token permissions.", + "path": "/api/2.0/permissions/authorization/tokens", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "TokenPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "TokenPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenAccessControlRequestList", + "array_value": { + "pascal_name": "TokenAccessControlRequest", + "is_object": true + } + } + } + ] + }, + { + "name": "UpdateTokenManagement", + "description": "Updates a token, specified by its ID.", + "summary": "Update an on-behalf token.", + "path": "/api/2.0/token-management/tokens/{token_id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateTokenManagementRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "token_id", + "description": "ID of the token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenInfo", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "token_id", + "description": "ID of the token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenInfo", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ] + }, + "response": { + "pascal_name": "TokenInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TokenInfo", + "is_object": true + } + }, + { + "name": "token_id", + "description": "ID of the token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_positional_arguments": [ + { + "name": "token_id", + "description": "ID of the token.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.Tokens", + "name": "Tokens", + "description": "The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.", + "package": { + "name": "settings" + }, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "PublicTokenInfoCommentToTokenIdMap" + }, + "is_legacy_empty_request": true, + "request": { + "pascal_name": "ListTokens" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates and returns a token for a user. If this call is made through token authentication, it creates\na token with the same client ID as the authenticated token. If the user's token quota is exceeded, this call\nreturns an error **QUOTA_EXCEEDED**.", + "summary": "Create a user token.", + "path": "/api/2.0/token/create", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateTokenRequest", + "is_object": true + }, + "response": { + "pascal_name": "CreateTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "autoscope_enabled", + "description": "Whether to enable autoscoping for this token. When true, the token will\nautomatically collect inferred API path scopes as it is used.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "comment", + "description": "Optional description to attach to the token.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "lifetime_seconds", + "description": "The lifetime of the token, in seconds.\n\nIf the lifetime is not specified, this token remains valid for 2 years.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "scopes", + "description": "Optional scopes of the token.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + { + "name": "Delete", + "description": "Revokes an access token.\n\nIf a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**.", + "summary": "Revoke token.", + "path": "/api/2.0/token/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RevokeTokenRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "token_id", + "description": "The ID of the token to be revoked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "token_id", + "description": "The ID of the token to be revoked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RevokeTokenResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "token_id", + "description": "The ID of the token to be revoked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "token_id", + "description": "The ID of the token to be revoked.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists all the valid tokens for a user-workspace pair.", + "summary": "List tokens.", + "path": "/api/2.0/token/list", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListTokens", + "is_object": true + }, + "response": { + "pascal_name": "ListPublicTokensResponse", + "is_object": true + }, + "pagination": {} + }, + { + "name": "Update", + "description": "Updates the comment or scopes of a token.\n\nIf a token with the specified ID is not valid, this call returns an error **NOT_FOUND**.", + "summary": "Update a user token.", + "path": "/api/2.0/token/{token_id}", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateTokenRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "token_id", + "description": "The SHA-256 hash of the token to be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublicTokenInfo", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "token_id", + "description": "The SHA-256 hash of the token to be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublicTokenInfo", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateTokenResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "token", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PublicTokenInfo", + "is_object": true + } + }, + { + "name": "token_id", + "description": "The SHA-256 hash of the token to be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "A list of field name under token, For example, {\"update_mask\": \"comment,scopes\"}\n\nThe field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_positional_arguments": [ + { + "name": "token_id", + "description": "The SHA-256 hash of the token to be updated.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "billing.UsageDashboards", + "name": "UsageDashboards", + "description": "These APIs manage usage dashboards for this account. Usage dashboards enable you to gain insights into your usage with pre-built dashboards: visualize breakdowns, analyze tag attributions, and identify cost drivers.", + "package": { + "name": "billing" + }, + "is_accounts": true, + "docs_group": "billing", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "methods": [ + { + "name": "Create", + "description": "Create a usage dashboard specified by workspaceId, accountId, and dashboard type.", + "summary": "Create new usage dashboard.", + "path": "/api/2.0/accounts/{account_id}/dashboard", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateBillingUsageDashboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "CreateBillingUsageDashboardResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_type", + "description": "Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.", + "is_request_body_field": true, + "entity": { + "pascal_name": "UsageDashboardType", + "enum": [ + { + "content": "USAGE_DASHBOARD_TYPE_GLOBAL" + }, + { + "content": "USAGE_DASHBOARD_TYPE_WORKSPACE" + } + ] + } + }, + { + "name": "major_version", + "description": "The major version of the usage dashboard template to use. Defaults to VERSION_1.", + "is_request_body_field": true, + "entity": { + "pascal_name": "UsageDashboardMajorVersion", + "enum": [ + { + "content": "USAGE_DASHBOARD_MAJOR_VERSION_1" + }, + { + "content": "USAGE_DASHBOARD_MAJOR_VERSION_2" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Get a usage dashboard specified by workspaceId, accountId, and dashboard type.", + "summary": "Get usage dashboard.", + "path": "/api/2.0/accounts/{account_id}/dashboard", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetBillingUsageDashboardRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetBillingUsageDashboardResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "dashboard_type", + "description": "Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.", + "is_query": true, + "entity": { + "pascal_name": "UsageDashboardType", + "enum": [ + { + "content": "USAGE_DASHBOARD_TYPE_GLOBAL" + }, + { + "content": "USAGE_DASHBOARD_TYPE_WORKSPACE" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "iam.UsersV2", + "name": "UsersV2", + "description": "User identities recognized by Databricks and represented by email addresses.\n\nDatabricks recommends using SCIM provisioning to sync users and groups automatically from\nyour identity provider to your Databricks workspace. SCIM streamlines onboarding a new\nemployee or team by using your identity provider to create users and groups in Databricks workspace\nand give them the proper level of access. When a user leaves your organization or no longer\nneeds access to Databricks workspace, admins can terminate the user in your identity provider and that\nuser’s account will also be removed from Databricks workspace. This ensures a consistent offboarding\nprocess and prevents unauthorized users from accessing sensitive data.", + "package": { + "name": "iam" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListUsersRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.", + "summary": "Create a new user.", + "path": "/api/2.0/preview/scim/v2/Users", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "CreateUserRequest", + "is_object": true + }, + "response": { + "pascal_name": "User", + "is_object": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "emails", + "description": "All the emails associated with the Databricks user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "description": "External ID is not currently supported. It is reserved for future use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks user ID.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Name", + "is_object": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "UserSchemaList", + "array_value": { + "pascal_name": "UserSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:User" + }, + { + "content": "urn:ietf:params:scim:schemas:extension:workspace:2.0:User" + } + ] + } + } + }, + { + "name": "userName", + "description": "Email address of the Databricks user.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user.", + "summary": "Delete a user.", + "path": "/api/2.0/preview/scim/v2/Users/{id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "DeleteUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets information for a specific user in Databricks workspace.", + "summary": "Get user details.", + "path": "/api/2.0/preview/scim/v2/Users/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "User", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "GetSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get password permission levels.", + "path": "/api/2.0/permissions/authorization/passwords/permissionLevels", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPasswordPermissionLevelsRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetPasswordPermissionLevelsResponse", + "is_object": true + } + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of all passwords. Passwords can inherit permissions from their root object.", + "summary": "Get password permissions.", + "path": "/api/2.0/permissions/authorization/passwords", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPasswordPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "PasswordPermissions", + "is_object": true + } + }, + { + "name": "List", + "description": "Gets details for all the users associated with a Databricks workspace.", + "summary": "List users.", + "path": "/api/2.0/preview/scim/v2/Users", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListUsersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListUsersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates a user resource by applying the supplied operations on specific user attributes.", + "summary": "Update user details.", + "path": "/api/2.0/preview/scim/v2/Users/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set password permissions.", + "path": "/api/2.0/permissions/authorization/passwords", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PasswordPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "PasswordPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "PasswordAccessControlRequestList", + "array_value": { + "pascal_name": "PasswordAccessControlRequest", + "is_object": true + } + } + } + ] + }, + { + "name": "Update", + "description": "Replaces a user's information with the data supplied in request.", + "summary": "Replace a user.", + "path": "/api/2.0/preview/scim/v2/Users/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "UpdateUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names. For example `John Smith`. This field cannot be updated through the Workspace SCIM APIs when [identity federation is enabled](https://docs.databricks.com/administration-guide/users-groups/best-practices.html#enable-identity-federation). Use Account SCIM APIs to update `displayName`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "emails", + "description": "All the emails associated with the Databricks user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "entitlements", + "description": "Entitlements assigned to the user. See [assigning entitlements](https://docs.databricks.com/administration-guide/users-groups/index.html#assigning-entitlements) for a full list of supported values.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "description": "External ID is not currently supported. It is reserved for future use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "groups", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Name", + "is_object": true + } + }, + { + "name": "roles", + "description": "Corresponds to AWS instance profile/arn role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "UserSchemaList", + "array_value": { + "pascal_name": "UserSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:schemas:core:2.0:User" + }, + { + "content": "urn:ietf:params:scim:schemas:extension:workspace:2.0:User" + } + ] + } + } + }, + { + "name": "userName", + "description": "Email address of the Databricks user.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on all passwords. Passwords can inherit permissions from their root object.", + "summary": "Update password permissions.", + "path": "/api/2.0/permissions/authorization/passwords", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PasswordPermissionsRequest", + "is_object": true + }, + "response": { + "pascal_name": "PasswordPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "PasswordAccessControlRequestList", + "array_value": { + "pascal_name": "PasswordAccessControlRequest", + "is_object": true + } + } + } + ] + } + ] + }, + { + "id": "iam.AccountUsersV2", + "name": "AccountUsersV2", + "description": "User identities recognized by Databricks and represented by email addresses.\n\nDatabricks recommends using SCIM provisioning to sync users and groups automatically from\nyour identity provider to your Databricks account. SCIM streamlines onboarding a new\nemployee or team by using your identity provider to create users and groups in Databricks account\nand give them the proper level of access. When a user leaves your organization or no longer\nneeds access to Databricks account, admins can terminate the user in your identity provider and that\nuser’s account will also be removed from Databricks account. This ensures a consistent offboarding\nprocess and prevents unauthorized users from accessing sensitive data.", + "package": { + "name": "iam" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListAccountUsersRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new user in the Databricks account. This new user will also be added to the Databricks account.", + "summary": "Create a new user.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateAccountUserRequest", + "is_object": true + }, + "response": { + "pascal_name": "AccountUser", + "is_object": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names. For example `John Smith`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "emails", + "description": "All the emails associated with the Databricks user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "description": "External ID is not currently supported. It is reserved for future use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks user ID.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Name", + "is_object": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "userName", + "description": "Email address of the Databricks user.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user.", + "summary": "Delete a user.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteAccountUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets information for a specific user in Databricks account.", + "summary": "Get user details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetAccountUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "AccountUser", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "GetSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID for a user in the Databricks account.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets details for all the users associated with a Databricks account.", + "summary": "List users.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListAccountUsersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListAccountUsersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "attributes", + "description": "Comma-separated list of attributes to return in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "excludedAttributes", + "description": "Comma-separated list of attributes to exclude in response.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortBy", + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "sortOrder", + "description": "The order to sort the results.", + "is_query": true, + "entity": { + "pascal_name": "ListSortOrder", + "enum": [ + { + "content": "ascending" + }, + { + "content": "descending" + } + ] + } + }, + { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": { + "offset": { + "name": "startIndex", + "description": "Specifies the index of the first result. First item is number 1.", + "is_query": true, + "entity": { + "is_int64": true + } + }, + "limit": { + "name": "count", + "description": "Desired number of results per page. Default is 10000.", + "is_query": true, + "entity": { + "is_int64": true + } + } + } + }, + { + "name": "Patch", + "description": "Partially updates a user resource by applying the supplied operations on specific user attributes.", + "summary": "Update user details.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "PatchAccountUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "Operations", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchList", + "array_value": { + "pascal_name": "Patch", + "is_object": true + } + } + }, + { + "name": "schemas", + "description": "The schema of the patch request. Must be [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"].", + "is_request_body_field": true, + "entity": { + "pascal_name": "PatchSchemaList", + "array_value": { + "pascal_name": "PatchSchema", + "enum": [ + { + "content": "urn:ietf:params:scim:api:messages:2.0:PatchOp" + } + ] + } + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Unique ID in the Databricks workspace.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Replaces a user's information with the data supplied in request.", + "summary": "Replace a user.", + "path": "/api/2.0/accounts/{account_id}/scim/v2/Users/{id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateAccountUserRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "active", + "description": "If this user is active", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "displayName", + "description": "String that represents a concatenation of given and family names. For example `John Smith`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "emails", + "description": "All the emails associated with the Databricks user.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "externalId", + "description": "External ID is not currently supported. It is reserved for future use.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Name", + "is_object": true + } + }, + { + "name": "roles", + "description": "Indicates if the group has the admin role.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ComplexValueList", + "array_value": { + "pascal_name": "ComplexValue", + "is_object": true + } + } + }, + { + "name": "userName", + "description": "Email address of the Databricks user.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Databricks user ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "vectorsearch.VectorSearchEndpoints", + "name": "VectorSearchEndpoints", + "description": "**Endpoint**: Represents the compute resources to host AI Search indexes.", + "package": { + "name": "vectorsearch" + }, + "docs_group": "vectorsearch", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListEndpointsRequest" + } + }, + "methods": [ + { + "name": "CreateEndpoint", + "description": "Create a new endpoint.", + "summary": "Create an endpoint.", + "path": "/api/2.0/vector-search/endpoints", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateEndpoint", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_type", + "description": "Type of endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointType", + "enum": [ + { + "content": "STANDARD" + }, + { + "content": "STORAGE_OPTIMIZED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_type", + "description": "Type of endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointType", + "enum": [ + { + "content": "STANDARD" + }, + { + "content": "STORAGE_OPTIMIZED" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "EndpointInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "budget_policy_id", + "description": "The budget policy id to be applied", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_type", + "description": "Type of endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointType", + "enum": [ + { + "content": "STANDARD" + }, + { + "content": "STORAGE_OPTIMIZED" + } + ] + } + }, + { + "name": "name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_qps", + "description": "Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "usage_policy_id", + "description": "The usage policy id to be applied once we've migrated to usage policies", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_type", + "description": "Type of endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointType", + "enum": [ + { + "content": "STANDARD" + }, + { + "content": "STORAGE_OPTIMIZED" + } + ] + } + } + ], + "wait": { + "success": [ + { + "content": "ONLINE" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "EndpointInfo" + } + }, + "status_path": [ + { + "pascal_name": "EndpointStatus" + }, + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "EndpointStatus" + }, + { + "pascal_name": "Message" + } + ], + "message_path_head": { + "pascal_name": "EndpointStatus" + } + } + }, + { + "name": "DeleteEndpoint", + "description": "Delete an AI Search endpoint.", + "summary": "Delete an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{endpoint_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteEndpointResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetEndpoint", + "description": "Get details for a single AI Search endpoint.", + "summary": "Get an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{endpoint_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EndpointInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get vector search endpoint permission levels.", + "path": "/api/2.0/permissions/vector-search-endpoints/{endpoint_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetVectorSearchEndpointPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetVectorSearchEndpointPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a vector search endpoint. Vector search endpoints can inherit permissions from their root object.", + "summary": "Get vector search endpoint permissions.", + "path": "/api/2.0/permissions/vector-search-endpoints/{endpoint_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetVectorSearchEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VectorSearchEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListEndpoints", + "description": "List all AI Search endpoints in the workspace.", + "summary": "List all endpoints.", + "path": "/api/2.0/vector-search/endpoints", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListEndpointsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListEndpointResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_token", + "description": "Token for pagination", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token for pagination", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "PatchEndpoint", + "description": "Update an endpoint", + "summary": "Update an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{endpoint_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EndpointInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "target_qps", + "description": "Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS\nwill be achieved.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "RetrieveUserVisibleMetrics", + "description": "Retrieve user-visible metrics for an endpoint", + "summary": "Retrieve user-visible metrics for an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{name}/metrics", + "can_use_json": true, + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "RetrieveUserVisibleMetricsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "AI Search endpoint name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "AI Search endpoint name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "RetrieveUserVisibleMetricsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "end_time", + "description": "End time for metrics query", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "granularity_in_seconds", + "description": "Granularity in seconds", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "metrics", + "description": "List of metrics to retrieve", + "is_request_body_field": true, + "entity": { + "pascal_name": "MetricList", + "array_value": { + "pascal_name": "Metric", + "is_object": true + } + } + }, + { + "name": "name", + "description": "AI Search endpoint name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Token for pagination", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "start_time", + "description": "Start time for metrics query", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "AI Search endpoint name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set vector search endpoint permissions.", + "path": "/api/2.0/permissions/vector-search-endpoints/{endpoint_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "VectorSearchEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VectorSearchEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorSearchEndpointAccessControlRequestList", + "array_value": { + "pascal_name": "VectorSearchEndpointAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateEndpointBudgetPolicy", + "description": "Update the budget policy of an endpoint", + "summary": "Update the budget policy of an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{endpoint_name}/budget-policy", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchEndpointBudgetPolicyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "budget_policy_id", + "description": "The budget policy id to be applied", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "budget_policy_id", + "description": "The budget policy id to be applied", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "PatchEndpointBudgetPolicyResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "budget_policy_id", + "description": "The budget policy id to be applied", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "budget_policy_id", + "description": "The budget policy id to be applied", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateEndpointCustomTags", + "description": "Update the custom tags of an endpoint.", + "summary": "Update the custom tags of an endpoint.", + "path": "/api/2.0/vector-search/endpoints/{endpoint_name}/tags", + "can_use_json": true, + "must_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateEndpointCustomTagsRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "The new custom tags for the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "custom_tags", + "description": "The new custom tags for the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + } + ] + }, + "response": { + "pascal_name": "UpdateEndpointCustomTagsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "custom_tags", + "description": "The new custom tags for the AI Search endpoint", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomTagList", + "array_value": { + "pascal_name": "CustomTag", + "is_object": true + } + } + }, + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the AI Search endpoint", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a vector search endpoint. Vector search endpoints can inherit permissions from their root object.", + "summary": "Update vector search endpoint permissions.", + "path": "/api/2.0/permissions/vector-search-endpoints/{endpoint_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "VectorSearchEndpointPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VectorSearchEndpointPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorSearchEndpointAccessControlRequestList", + "array_value": { + "pascal_name": "VectorSearchEndpointAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_id", + "description": "The vector search endpoint for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "vectorsearch.VectorSearchIndexes", + "name": "VectorSearchIndexes", + "description": "**Index**: An efficient representation of your embedding vectors that supports real-time and\nefficient approximate nearest neighbor (ANN) search queries.\n\nThere are 2 types of AI Search indexes:\n- **Delta Sync Index**: An index that automatically syncs with a source Delta Table, automatically\nand incrementally updating the index as the underlying data in the Delta Table changes.\n- **Direct Vector Access Index**: An index that supports direct read and write of vectors and metadata\nthrough our REST and SDK APIs. With this model, the user manages index updates.", + "package": { + "name": "vectorsearch" + }, + "docs_group": "vectorsearch", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListIndexesRequest" + } + }, + "methods": [ + { + "name": "CreateIndex", + "description": "Create a new index.", + "summary": "Create an index.", + "path": "/api/2.0/vector-search/indexes", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateVectorIndexRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "Name of the endpoint to be used for serving the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_key", + "description": "Primary key of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorIndexType", + "enum": [ + { + "content": "DELTA_SYNC" + }, + { + "content": "DIRECT_ACCESS" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "name", + "description": "Name of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "Name of the endpoint to be used for serving the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_key", + "description": "Primary key of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorIndexType", + "enum": [ + { + "content": "DELTA_SYNC" + }, + { + "content": "DIRECT_ACCESS" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "VectorIndex", + "is_object": true + }, + "all_fields": [ + { + "name": "delta_sync_index_spec", + "description": "Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DeltaSyncVectorIndexSpecRequest", + "is_object": true + } + }, + { + "name": "direct_access_index_spec", + "description": "Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DirectAccessVectorIndexSpec", + "is_object": true + } + }, + { + "name": "endpoint_name", + "description": "Name of the endpoint to be used for serving the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_subtype", + "description": "The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", + "is_request_body_field": true, + "entity": { + "pascal_name": "IndexSubtype", + "enum": [ + { + "content": "FULL_TEXT" + }, + { + "content": "HYBRID" + }, + { + "content": "VECTOR" + } + ] + } + }, + { + "name": "index_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorIndexType", + "enum": [ + { + "content": "DELTA_SYNC" + }, + { + "content": "DIRECT_ACCESS" + } + ] + } + }, + { + "name": "name", + "description": "Name of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_key", + "description": "Primary key of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "endpoint_name", + "description": "Name of the endpoint to be used for serving the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_key", + "description": "Primary key of the index", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_type", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VectorIndexType", + "enum": [ + { + "content": "DELTA_SYNC" + }, + { + "content": "DIRECT_ACCESS" + } + ] + } + } + ] + }, + { + "name": "DeleteDataVectorIndex", + "description": "Handles the deletion of data from a specified vector index.", + "summary": "Delete data from index.", + "path": "/api/2.0/vector-search/indexes/{index_name}/delete-data", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteDataVectorIndexRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_keys", + "description": "List of primary keys for the data to be deleted.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_keys", + "description": "List of primary keys for the data to be deleted.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "response": { + "pascal_name": "DeleteDataVectorIndexResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "primary_keys", + "description": "List of primary keys for the data to be deleted.", + "required": true, + "is_query": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteIndex", + "description": "Delete an index.", + "summary": "Delete an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteIndexRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteIndexResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetIndex", + "description": "Get an index.", + "summary": "Get an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetIndexRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VectorIndex", + "is_object": true + }, + "all_fields": [ + { + "name": "ensure_reranker_compatible", + "description": "If true, the URL returned for the index is guaranteed to be compatible with the reranker.\nCurrently this means we return the CP URL regardless of how the index is being accessed.\nIf not set or set to false, the URL may still be compatible with the reranker depending on\nwhat URL we return.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the index", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListIndexes", + "description": "List all indexes in the given endpoint.", + "summary": "List indexes.", + "path": "/api/2.0/vector-search/indexes", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListIndexesRequest", + "is_object": true, + "required_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListVectorIndexesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Token for pagination", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token for pagination", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "QueryIndex", + "description": "Query the specified vector index.", + "summary": "Query an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}/query", + "can_use_json": true, + "must_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryVectorIndexRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "columns", + "description": "List of column names to include in the response.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "columns", + "description": "List of column names to include in the response.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + } + ] + }, + "response": { + "pascal_name": "QueryVectorIndexResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "columns", + "description": "List of column names to include in the response.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "columns_to_rerank", + "description": "Column names used to retrieve data to send to the reranker.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_string": true + } + } + }, + { + "name": "filters_json", + "description": "JSON string representing query filters.\n\nExample filters:\n\n- `{\"id \u003c\": 5}`: Filter for id less than 5.\n- `{\"id \u003e\": 5}`: Filter for id greater than 5.\n- `{\"id \u003c=\": 5}`: Filter for id less than equal to 5.\n- `{\"id \u003e=\": 5}`: Filter for id greater than equal to 5.\n- `{\"id\": 5}`: Filter for id equal to 5.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "num_results", + "description": "Number of results to return. Defaults to 10.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "query_text", + "description": "Query text. Required for Delta Sync Index using model endpoint.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_type", + "description": "The query type to use. Choices are `ANN` and `HYBRID` and `FULL_TEXT`. Defaults to `ANN`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "query_vector", + "description": "Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_float64": true + } + } + }, + { + "name": "reranker", + "description": "If set, the top 50 results are reranked with the Databricks Reranker model before returning the `num_results` results to the user.\nThe setting `columns_to_rerank` selects which columns are used for reranking. For each datapoint, the columns selected are concatenated before\nbeing sent to the reranking model. See https://docs.databricks.com/aws/en/vector-search/query-vector-search#rerank for more information.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RerankerConfig", + "is_object": true + } + }, + { + "name": "score_threshold", + "description": "Threshold for the approximate nearest neighbor search. Defaults to 0.0.", + "is_request_body_field": true, + "entity": { + "is_float64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "QueryNextPage", + "description": "Use `next_page_token` returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` request to fetch next page of results.", + "summary": "Query next page.", + "path": "/api/2.0/vector-search/indexes/{index_name}/query-next-page", + "can_use_json": true, + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "QueryVectorIndexNextPageRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "QueryVectorIndexResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "endpoint_name", + "description": "Name of the endpoint.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_token", + "description": "Page token returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` API.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index to query.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ScanIndex", + "description": "Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.", + "summary": "Scan an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}/scan", + "can_use_json": true, + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ScanVectorIndexRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to scan.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to scan.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ScanVectorIndexResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to scan.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "last_primary_key", + "description": "Primary key of the last entry returned in the previous scan.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "num_results", + "description": "Number of results to return. Defaults to 10.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index to scan.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SyncIndex", + "description": "Triggers a synchronization process for a specified vector index.", + "summary": "Synchronize an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}/sync", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SyncIndexRequest", + "is_object": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to synchronize. Must be a Delta Sync Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to synchronize. Must be a Delta Sync Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SyncIndexResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "index_name", + "description": "Name of the vector index to synchronize. Must be a Delta Sync Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index to synchronize. Must be a Delta Sync Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpsertDataVectorIndex", + "description": "Handles the upserting of data into a specified vector index.", + "summary": "Upsert data into an index.", + "path": "/api/2.0/vector-search/indexes/{index_name}/upsert-data", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpsertDataVectorIndexRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "inputs_json", + "description": "JSON string representing the data to be upserted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "inputs_json", + "description": "JSON string representing the data to be upserted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpsertDataVectorIndexResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "inputs_json", + "description": "JSON string representing the data to be upserted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "index_name", + "description": "Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "inputs_json", + "description": "JSON string representing the data to be upserted.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "catalog.Volumes", + "name": "Volumes", + "description": "Volumes are a Unity Catalog (UC) capability for accessing, storing, governing,\norganizing and processing files. Use cases include running machine learning\non unstructured data such as image, audio, video, or PDF files, organizing data sets\nduring the data exploration stages in data science, working with libraries\nthat require access to the local file system on cluster machines, storing library\nand config files of arbitrary formats such as .whl or .txt centrally\nand providing secure access across workspaces to it,\nor transforming and querying non-tabular data files in ETL.", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "VolumeInfoNameToVolumeIdMap" + }, + "request": { + "pascal_name": "ListVolumesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new volume.\n\nThe user could create either an external volume or a managed volume. An external volume\nwill be created in the specified external location, while a managed volume\nwill be located in the default location which is specified by the parent schema,\nor the parent catalog, or the Metastore.\n\nFor the volume creation to succeed, the user must satisfy following conditions:\n- The caller must be a metastore admin, or be the owner of the parent catalog and schema,\nor have the **USE_CATALOG** privilege on the parent catalog\nand the **USE_SCHEMA** privilege on the parent schema.\n- The caller must have **CREATE VOLUME** privilege on the parent schema.\n\nFor an external volume, following conditions also need to satisfy\n- The caller must have **CREATE EXTERNAL VOLUME** privilege on the external location.\n- There are no other tables, nor volumes existing in the specified storage location.\n- The specified storage location is not under the location of other tables, nor volumes,\nor catalogs or schemas.", + "summary": "Create a Volume.", + "path": "/api/2.1/unity-catalog/volumes", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateVolumeRequestContent", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the volume are", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the volume is", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the volume", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "volume_type", + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VolumeType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "MANAGED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the volume are", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the volume is", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the volume", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "volume_type", + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VolumeType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "MANAGED" + } + ] + } + } + ] + }, + "response": { + "pascal_name": "VolumeInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the volume are", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "comment", + "description": "The comment attached to the volume", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the volume", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the volume is", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_location", + "description": "The storage location on the cloud", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "volume_type", + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VolumeType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "MANAGED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "The name of the catalog where the schema and the volume are", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The name of the schema where the volume is", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The name of the volume", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "volume_type", + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "VolumeType", + "enum": [ + { + "content": "EXTERNAL" + }, + { + "content": "MANAGED" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a volume from the specified parent catalog and schema.\n\nThe caller must be a metastore admin or an owner of the volume.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Delete a Volume.", + "path": "/api/2.1/unity-catalog/volumes/{name}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteVolumeRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Gets an array of volumes for the current metastore\nunder the parent catalog and schema.\n\nThe returned volumes are filtered based on the privileges of the calling user.\nFor example, the metastore admin is able to list all the volumes.\nA regular user needs to be the owner or have the **READ VOLUME** privilege\non the volume to receive the volumes in the response.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nThere is no guarantee of a specific ordering of the elements in the array.\n\nPAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "List Volumes.", + "path": "/api/2.1/unity-catalog/volumes", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListVolumesRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "The identifier of the catalog", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The identifier of the schema", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "The identifier of the catalog", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The identifier of the schema", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListVolumesResponseContent", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "The identifier of the catalog", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "include_browse", + "description": "Whether to include volumes in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "max_results", + "description": "Maximum number of volumes to return (page length).\n\nIf not set, the page length is set to a server configured value (10000, as of 1/29/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/29/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 1/29/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n\nNote: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page\nmay be smaller than this value, including 0, even if there are more pages.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The identifier of the schema", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "The identifier of the catalog", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "The identifier of the schema", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "Read", + "description": "Gets a volume from the metastore for a specific catalog and schema.\n\nThe caller must be a metastore admin or an owner of (or have the **READ VOLUME**\nprivilege on) the volume.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.", + "summary": "Get a Volume.", + "path": "/api/2.1/unity-catalog/volumes/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ReadVolumeRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VolumeInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "include_browse", + "description": "Whether to include volumes in the response for which the principal can only access selective metadata for", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Update", + "description": "Updates the specified volume under the specified parent catalog and schema.\n\nThe caller must be a metastore admin or an owner of the volume.\nFor the latter case, the caller must also be the owner or have the **USE_CATALOG**\nprivilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.\n\nCurrently only the name, the owner or the comment of the volume could be updated.", + "summary": "Update a Volume.", + "path": "/api/2.1/unity-catalog/volumes/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateVolumeRequestContent", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VolumeInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "comment", + "description": "The comment attached to the volume", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "new_name", + "description": "New name for the volume.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The identifier of the user who owns the volume", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The three-level (fully qualified) name of the volume", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "provisioning.VpcEndpoints", + "name": "VpcEndpoints", + "description": "These APIs manage VPC endpoint configurations for this account.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a VPC endpoint configuration, which represents a\n[VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html)\nobject in AWS used to communicate privately with Databricks over\n[AWS PrivateLink](https://aws.amazon.com/privatelink).\n\nAfter you create the VPC endpoint configuration, the Databricks\n[endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html)\nautomatically accepts the VPC endpoint.\n\nBefore configuring PrivateLink, read the\n[Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).", + "summary": "Create a VPC endpoint configuration.", + "path": "/api/2.0/accounts/{account_id}/vpc-endpoints", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateVpcEndpointRequest", + "is_object": true + }, + "response": { + "pascal_name": "VpcEndpoint", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_vpc_endpoint_id", + "description": "The ID of the VPC endpoint object in AWS.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gcp_vpc_endpoint_info", + "description": "The cloud info of this vpc endpoint.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpVpcEndpointInfo", + "is_object": true + } + }, + { + "name": "region", + "description": "The region in which this VPC endpoint object exists.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "vpc_endpoint_name", + "description": "The human-readable name of the storage configuration.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that is associated with any workspace.", + "summary": "Delete a VPC endpoint configuration.", + "path": "/api/2.0/accounts/{account_id}/vpc-endpoints/{vpc_endpoint_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteVpcEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "vpc_endpoint_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "vpc_endpoint_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VpcEndpoint", + "is_object": true + }, + "all_fields": [ + { + "name": "vpc_endpoint_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "vpc_endpoint_id", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets a VPC endpoint configuration, which represents\na [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html)\nobject in AWS used to communicate privately with Databricks over\n[AWS PrivateLink](https://aws.amazon.com/privatelink).", + "summary": "Get a VPC endpoint configuration.", + "path": "/api/2.0/accounts/{account_id}/vpc-endpoints/{vpc_endpoint_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetVpcEndpointRequest", + "is_object": true, + "required_fields": [ + { + "name": "vpc_endpoint_id", + "description": "Databricks VPC endpoint ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "vpc_endpoint_id", + "description": "Databricks VPC endpoint ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "VpcEndpoint", + "is_object": true + }, + "all_fields": [ + { + "name": "vpc_endpoint_id", + "description": "Databricks VPC endpoint ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "vpc_endpoint_id", + "description": "Databricks VPC endpoint ID.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks VPC endpoint configurations for an account.", + "summary": "List VPC endpoint configurations.", + "path": "/api/2.0/accounts/{account_id}/vpc-endpoints", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListVpcEndpointsRequest", + "is_object": true + }, + "response": { + "pascal_name": "VpcEndpointList", + "array_value": { + "pascal_name": "VpcEndpoint", + "is_object": true + } + } + } + ] + }, + { + "id": "sql.Warehouses", + "name": "Warehouses", + "description": "A SQL warehouse is a compute resource that lets you run SQL commands on data objects within Databricks SQL. Compute resources are infrastructure resources that provide processing capabilities in the cloud.", + "package": { + "name": "sql" + }, + "docs_group": "sql", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "EndpointInfoNameToIdMap" + }, + "request": { + "pascal_name": "ListWarehousesRequest" + } + }, + "methods": [ + { + "name": "Create", + "description": "Creates a new SQL warehouse.", + "summary": "Create a warehouse.", + "path": "/api/2.0/sql/warehouses", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateWarehouseRequest", + "is_object": true + }, + "response": { + "pascal_name": "CreateWarehouseResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "auto_stop_mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "channel", + "description": "Channel Details", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Channel", + "is_object": true + } + }, + { + "name": "cluster_size", + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator_name", + "description": "warehouse creator name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_photon", + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_serverless_compute", + "description": "Configures whether the warehouse should use serverless compute", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "instance_profile_arn", + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_num_clusters", + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "min_num_clusters", + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spot_instance_policy", + "description": "Configurations whether the endpoint should use spot instances.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SpotInstancePolicy", + "enum": [ + { + "content": "COST_OPTIMIZED" + }, + { + "content": "POLICY_UNSPECIFIED" + }, + { + "content": "RELIABILITY_OPTIMIZED" + } + ] + } + }, + { + "name": "tags", + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointTags", + "is_object": true + } + }, + { + "name": "warehouse_type", + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CreateWarehouseRequestWarehouseType", + "enum": [ + { + "content": "CLASSIC" + }, + { + "content": "PRO" + }, + { + "content": "TYPE_UNSPECIFIED" + } + ] + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "GetWarehouseResponse" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Health" + }, + { + "pascal_name": "Summary" + } + ], + "message_path_head": { + "pascal_name": "Health" + } + } + }, + { + "name": "CreateDefaultWarehouseOverride", + "description": "Creates a new default warehouse override for a user.\nUsers can create their own override. Admins can create overrides for any user.", + "summary": "Create default warehouse override.", + "path": "/api/warehouses/v1/default-warehouse-overrides", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateDefaultWarehouseOverrideRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true + } + }, + { + "name": "default_warehouse_override_id", + "description": "Required. The ID to use for the override, which will become the final component\nof the override's resource name.\nCan be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "default_warehouse_override_id", + "description": "Required. The ID to use for the override, which will become the final component\nof the override's resource name.\nCan be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + } + }, + { + "name": "default_warehouse_override_id", + "description": "Required. The ID to use for the override, which will become the final component\nof the override's resource name.\nCan be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_warehouse_override_id", + "description": "The ID component of the resource name (user ID).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + }, + { + "name": "warehouse_id", + "description": "The specific warehouse ID when type is CUSTOM.\nNot set for LAST_SELECTED type.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "default_warehouse_override_id", + "description": "Required. The ID to use for the override, which will become the final component\nof the override's resource name.\nCan be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + }, + { + "name": "Delete", + "description": "Deletes a SQL warehouse.", + "summary": "Delete a warehouse.", + "path": "/api/2.0/sql/warehouses/{id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteWarehouseRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteWarehouseResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteDefaultWarehouseOverride", + "description": "Deletes the default warehouse override for a user.\nUsers can delete their own override. Admins can delete overrides for any user.\nAfter deletion, the workspace default warehouse will be used.", + "summary": "Delete default warehouse override.", + "path": "/api/warehouses/v1/{name=default-warehouse-overrides/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteDefaultWarehouseOverrideRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to delete.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to delete.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to delete.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to delete.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Edit", + "description": "Updates the configuration for a SQL warehouse.", + "summary": "Update a warehouse.", + "path": "/api/2.0/sql/warehouses/{id}/edit", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "EditWarehouseRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Required. Id of the warehouse to configure.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Required. Id of the warehouse to configure.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "EditWarehouseResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "auto_stop_mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "channel", + "description": "Channel Details", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Channel", + "is_object": true + } + }, + { + "name": "cluster_size", + "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "creator_name", + "description": "warehouse creator name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "enable_photon", + "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enable_serverless_compute", + "description": "Configures whether the warehouse should use serverless compute", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "id", + "description": "Required. Id of the warehouse to configure.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_profile_arn", + "description": "Deprecated. Instance profile used to pass IAM role to the cluster", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "max_num_clusters", + "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "min_num_clusters", + "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", + "is_request_body_field": true, + "entity": { + "is_int": true + } + }, + { + "name": "name", + "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spot_instance_policy", + "description": "Configurations whether the endpoint should use spot instances.", + "is_request_body_field": true, + "entity": { + "pascal_name": "SpotInstancePolicy", + "enum": [ + { + "content": "COST_OPTIMIZED" + }, + { + "content": "POLICY_UNSPECIFIED" + }, + { + "content": "RELIABILITY_OPTIMIZED" + } + ] + } + }, + { + "name": "tags", + "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "EndpointTags", + "is_object": true + } + }, + { + "name": "warehouse_type", + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EditWarehouseRequestWarehouseType", + "enum": [ + { + "content": "CLASSIC" + }, + { + "content": "PRO" + }, + { + "content": "TYPE_UNSPECIFIED" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Required. Id of the warehouse to configure.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "GetWarehouseResponse" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Health" + }, + { + "pascal_name": "Summary" + } + ], + "message_path_head": { + "pascal_name": "Health" + } + } + }, + { + "name": "Get", + "description": "Gets the information for a single SQL warehouse.", + "summary": "Get warehouse info.", + "path": "/api/2.0/sql/warehouses/{id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWarehouseRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetWarehouseResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetDefaultWarehouseOverride", + "description": "Returns the default warehouse override for a user.\nUsers can fetch their own override. Admins can fetch overrides for any user.\nIf no override exists, the UI will fallback to the workspace default warehouse.", + "summary": "Get default warehouse override.", + "path": "/api/warehouses/v1/{name=default-warehouse-overrides/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetDefaultWarehouseOverrideRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to retrieve.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to retrieve.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to retrieve.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The resource name of the default warehouse override to retrieve.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get SQL warehouse permission levels.", + "path": "/api/2.0/permissions/warehouses/{warehouse_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWarehousePermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetWarehousePermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root object.", + "summary": "Get SQL warehouse permissions.", + "path": "/api/2.0/permissions/warehouses/{warehouse_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWarehousePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WarehousePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetWorkspaceWarehouseConfig", + "description": "Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.", + "summary": "Get the workspace configuration.", + "path": "/api/2.0/sql/config/warehouses", + "is_legacy_empty_request": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceWarehouseConfigRequest", + "is_object": true + }, + "response": { + "pascal_name": "GetWorkspaceWarehouseConfigResponse", + "is_object": true + } + }, + { + "name": "List", + "description": "Lists all SQL warehouses that a user has access to.", + "summary": "List warehouses.", + "path": "/api/2.0/sql/warehouses", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWarehousesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListWarehousesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The max number of warehouses to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListWarehouses` call.\nProvide this to retrieve the subsequent page; otherwise the first\nwill be retrieved.\n\nWhen paginating, all other parameters provided to `ListWarehouses` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "run_as_user_id", + "description": "Deprecated: this field is ignored by the server.\nService Principal which will be used to fetch the list of endpoints.\nIf not specified, SQL Gateway will use the user from the session header.", + "is_query": true, + "entity": { + "is_int": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListWarehouses` call.\nProvide this to retrieve the subsequent page; otherwise the first\nwill be retrieved.\n\nWhen paginating, all other parameters provided to `ListWarehouses` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListDefaultWarehouseOverrides", + "description": "Lists all default warehouse overrides in the workspace.\nOnly workspace administrators can list all overrides.", + "summary": "List default warehouse overrides.", + "path": "/api/warehouses/v1/default-warehouse-overrides", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListDefaultWarehouseOverridesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListDefaultWarehouseOverridesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of overrides to return. The service may return fewer than\nthis value.\nIf unspecified, at most 100 overrides will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListDefaultWarehouseOverrides` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListDefaultWarehouseOverrides`\nmust match the call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListDefaultWarehouseOverrides` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListDefaultWarehouseOverrides`\nmust match the call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.", + "summary": "Set SQL warehouse permissions.", + "path": "/api/2.0/permissions/warehouses/{warehouse_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WarehousePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WarehousePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "WarehouseAccessControlRequestList", + "array_value": { + "pascal_name": "WarehouseAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetWorkspaceWarehouseConfig", + "description": "Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.", + "summary": "Set the workspace configuration.", + "path": "/api/2.0/sql/config/warehouses", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "SetWorkspaceWarehouseConfigRequest", + "is_object": true + }, + "response": { + "pascal_name": "SetWorkspaceWarehouseConfigResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "channel", + "description": "Optional: Channel selection details", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Channel", + "is_object": true + } + }, + { + "name": "config_param", + "description": "Deprecated: Use sql_configuration_parameters", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RepeatedEndpointConfPairs", + "is_object": true + } + }, + { + "name": "data_access_config", + "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "is_request_body_field": true, + "entity": { + "pascal_name": "EndpointConfPairList", + "array_value": { + "pascal_name": "EndpointConfPair", + "is_object": true + } + } + }, + { + "name": "enable_serverless_compute", + "description": "Deprecated: only setting this to true is allowed.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "enabled_warehouse_types", + "description": "List of Warehouse Types allowed in this workspace (limits allowed value of\nthe type field in CreateWarehouse and EditWarehouse). Note: Some types\ncannot be disabled, they don't need to be specified\nin SetWorkspaceWarehouseConfig.\nNote: Disabling a type may cause existing warehouses to be converted to\nanother type. Used by frontend to save specific type availability in the\nwarehouse create and edit form UI.", + "is_request_body_field": true, + "entity": { + "pascal_name": "WarehouseTypePairList", + "array_value": { + "pascal_name": "WarehouseTypePair", + "is_object": true + } + } + }, + { + "name": "global_param", + "description": "Deprecated: Use sql_configuration_parameters", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RepeatedEndpointConfPairs", + "is_object": true + } + }, + { + "name": "google_service_account", + "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "instance_profile_arn", + "description": "AWS Only: The instance profile used to pass an IAM role to the SQL\nwarehouses. This configuration is also applied to the workspace's\nserverless compute for notebooks and jobs.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "security_policy", + "description": "Security policy for warehouses", + "is_request_body_field": true, + "entity": { + "pascal_name": "SetWorkspaceWarehouseConfigRequestSecurityPolicy", + "enum": [ + { + "content": "DATA_ACCESS_CONTROL" + }, + { + "content": "NONE" + }, + { + "content": "PASSTHROUGH" + } + ] + } + }, + { + "name": "sql_configuration_parameters", + "description": "SQL configuration parameters", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RepeatedEndpointConfPairs", + "is_object": true + } + } + ] + }, + { + "name": "Start", + "description": "Starts a SQL warehouse.", + "summary": "Start a warehouse.", + "path": "/api/2.0/sql/warehouses/{id}/start", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StartRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StartWarehouseResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "GetWarehouseResponse" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Health" + }, + { + "pascal_name": "Summary" + } + ], + "message_path_head": { + "pascal_name": "Health" + } + } + }, + { + "name": "Stop", + "description": "Stops a SQL warehouse.", + "summary": "Stop a warehouse.", + "path": "/api/2.0/sql/warehouses/{id}/stop", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "StopRequest", + "is_object": true, + "required_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "StopWarehouseResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "id", + "description": "Required. Id of the SQL warehouse.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "STOPPED" + } + ], + "timeout": 20, + "complex_message_path": true, + "poll": { + "response": { + "pascal_name": "GetWarehouseResponse" + } + }, + "status_path": [ + { + "pascal_name": "State" + } + ], + "message_path": [ + { + "pascal_name": "Health" + }, + { + "pascal_name": "Summary" + } + ], + "message_path_head": { + "pascal_name": "Health" + } + } + }, + { + "name": "UpdateDefaultWarehouseOverride", + "description": "Updates an existing default warehouse override for a user.\nUsers can update their own override. Admins can update overrides for any user.", + "summary": "Update default warehouse override.", + "path": "/api/warehouses/v1/{name=default-warehouse-overrides/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateDefaultWarehouseOverrideRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to update.\nThe name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Required. Field mask specifying which fields to update.\nOnly the fields specified in the mask will be updated.\nUse \"*\" to update all fields.\nWhen allow_missing is true, this field is ignored and all fields are applied.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. Field mask specifying which fields to update.\nOnly the fields specified in the mask will be updated.\nUse \"*\" to update all fields.\nWhen allow_missing is true, this field is ignored and all fields are applied.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to update.\nThe name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to update.\nThe name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "allow_missing", + "description": "If set to true, and the override is not found, a new override will be created.\nIn this situation, `update_mask` is ignored and all fields are applied.\nDefaults to false.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "default_warehouse_override", + "description": "Required. The default warehouse override to update.\nThe name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverride", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + } + }, + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. Field mask specifying which fields to update.\nOnly the fields specified in the mask will be updated.\nUse \"*\" to update all fields.\nWhen allow_missing is true, this field is ignored and all fields are applied.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "default_warehouse_override_id", + "description": "The ID component of the resource name (user ID).", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + }, + { + "name": "warehouse_id", + "description": "The specific warehouse ID when type is CUSTOM.\nNot set for LAST_SELECTED type.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. Field mask specifying which fields to update.\nOnly the fields specified in the mask will be updated.\nUse \"*\" to update all fields.\nWhen allow_missing is true, this field is ignored and all fields are applied.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "type", + "description": "The type of override behavior.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DefaultWarehouseOverrideType", + "enum": [ + { + "content": "CUSTOM" + }, + { + "content": "LAST_SELECTED" + } + ] + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object.", + "summary": "Update SQL warehouse permissions.", + "path": "/api/2.0/permissions/warehouses/{warehouse_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WarehousePermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WarehousePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "WarehouseAccessControlRequestList", + "array_value": { + "pascal_name": "WarehouseAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "warehouse_id", + "description": "The SQL warehouse for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "workspace.Workspace", + "name": "Workspace", + "description": "The Workspace API allows you to list, import, export, and delete workspace objects such as\nnotebooks, files, folders, and dashboards. Additionally, it provides endpoints to manage\npermissions for any workspace object.\n\nA notebook is a web-based interface to a document that contains runnable code,\nvisualizations, and explanatory text.", + "package": { + "name": "workspace" + }, + "docs_group": "workspace", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "named_id_map": { + "pascal_name": "ObjectInfoPathToObjectIdMap" + }, + "request": { + "pascal_name": "ListWorkspaceRequest" + } + }, + "methods": [ + { + "name": "Delete", + "description": "Deletes an object or a directory (and optionally recursively deletes all objects in the directory).\n* If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.\n* If `path` is a non-empty directory and `recursive` is set to `false`, this call returns an error `DIRECTORY_NOT_EMPTY`.\n\nObject deletion cannot be undone and deleting a directory recursively is not atomic.", + "summary": "Delete a workspace object.", + "path": "/api/2.0/workspace/delete", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Delete", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "recursive", + "description": "The flag that specifies whether to delete the object recursively. It is `false` by default.\nPlease note this deleting directory is not atomic. If it fails in the middle, some of objects\nunder this directory may be deleted and cannot be undone.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Export", + "description": "Exports an object or the contents of an entire directory.\n\nIf `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.\n\nIf the exported data would exceed size limit, this call returns `MAX_NOTEBOOK_SIZE_EXCEEDED`.\nCurrently, this API does not support exporting a library.", + "summary": "Export a workspace object.", + "path": "/api/2.0/workspace/export", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ExportRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ExportResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "format", + "description": "This specifies the format of the exported file. By default, this is `SOURCE`.\n\nThe value is case sensitive.\n\n- `SOURCE`: The notebook is exported as source code. Directory exports will not include non-notebook entries.\n- `HTML`: The notebook is exported as an HTML file.\n- `JUPYTER`: The notebook is exported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is exported in Databricks archive format. Directory exports will not include non-notebook entries.\n- `R_MARKDOWN`: The notebook is exported to R Markdown format.\n- `AUTO`: The object or directory is exported depending on the objects type. Directory exports will include notebooks and workspace files.", + "is_query": true, + "entity": { + "pascal_name": "ExportFormat", + "enum": [ + { + "content": "AUTO" + }, + { + "content": "DBC" + }, + { + "content": "HTML" + }, + { + "content": "JUPYTER" + }, + { + "content": "RAW" + }, + { + "content": "R_MARKDOWN" + }, + { + "content": "SOURCE" + } + ] + } + }, + { + "name": "path", + "description": "The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissionLevels", + "description": "Gets the permission levels that a user can have on an object.", + "summary": "Get workspace object permission levels.", + "path": "/api/2.0/permissions/{workspace_object_type}/{workspace_object_id}/permissionLevels", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceObjectPermissionLevelsRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetWorkspaceObjectPermissionLevelsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetPermissions", + "description": "Gets the permissions of a workspace object. Workspace objects can inherit permissions from their parent objects or root object.", + "summary": "Get workspace object permissions.", + "path": "/api/2.0/permissions/{workspace_object_type}/{workspace_object_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceObjectPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetStatus", + "description": "Gets the status of an object or a directory.\nIf `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.", + "summary": "Get status.", + "path": "/api/2.0/workspace/get-status", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStatusRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ObjectInfo", + "is_object": true + }, + "all_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "Import", + "description": "Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.\nIf `path` already exists and `overwrite` is set to `false`, this call returns an error `RESOURCE_ALREADY_EXISTS`.\nTo import a directory, you can use either the `DBC` format or the `SOURCE` format with the `language` field unset.\nTo import a single file as `SOURCE`, you must set the `language` field.\nZip files within directories are not supported.", + "summary": "Import a workspace object.", + "path": "/api/2.0/workspace/import", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Import", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ImportResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "content", + "description": "The base64-encoded content. This has a limit of 10 MB.\n\nIf the limit (10MB) is exceeded, exception with error code **MAX_NOTEBOOK_SIZE_EXCEEDED** is thrown.\nThis parameter might be absent, and instead a posted file is used.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "format", + "description": "This specifies the format of the file to be imported.\n\nThe value is case sensitive.\n\n- `AUTO`: The item is imported depending on an analysis of the item's extension and\nthe header content provided in the request. If the item is imported as a notebook,\nthen the item's extension is automatically removed.\n- `SOURCE`: The notebook or directory is imported as source code.\n- `HTML`: The notebook is imported as an HTML file.\n- `JUPYTER`: The notebook is imported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is imported in Databricks archive format. Required for directories.\n- `R_MARKDOWN`: The notebook is imported from R Markdown format.", + "is_request_body_field": true, + "entity": { + "pascal_name": "ImportFormat", + "enum": [ + { + "content": "AUTO" + }, + { + "content": "DBC" + }, + { + "content": "HTML" + }, + { + "content": "JUPYTER" + }, + { + "content": "RAW" + }, + { + "content": "R_MARKDOWN" + }, + { + "content": "SOURCE" + } + ] + } + }, + { + "name": "language", + "description": "The language of the object. This value is set only if the object type is `NOTEBOOK`.", + "is_request_body_field": true, + "entity": { + "pascal_name": "Language", + "enum": [ + { + "content": "PYTHON" + }, + { + "content": "R" + }, + { + "content": "SCALA" + }, + { + "content": "SQL" + } + ] + } + }, + { + "name": "overwrite", + "description": "The flag that specifies whether to overwrite existing object. It is `false` by default.\nFor `DBC` format, `overwrite` is not supported since it may contain a directory.", + "is_request_body_field": true, + "entity": { + "is_bool": true + } + }, + { + "name": "path", + "description": "The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the object or directory. Importing a directory is only supported for the `DBC` and `SOURCE` formats.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "List", + "description": "Lists the contents of a directory, or the object if it is not a directory.\nIf the input path does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.", + "summary": "List contents.", + "path": "/api/2.0/workspace/list", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWorkspaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "notebooks_modified_after", + "description": "UTC timestamp in milliseconds", + "is_query": true, + "entity": { + "is_int64": true + } + }, + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the notebook or directory.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": {} + }, + { + "name": "Mkdirs", + "description": "Creates the specified directory (and necessary parent directories if they do not exist).\nIf there is an object (not a directory) at any prefix of the input path, this call returns\nan error `RESOURCE_ALREADY_EXISTS`.\n\nNote that if this operation fails it may have succeeded in creating some of the necessary parent directories.", + "summary": "Create a directory.", + "path": "/api/2.0/workspace/mkdirs", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "Mkdirs", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "path", + "description": "The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "path", + "description": "The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "MkdirsResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "path", + "description": "The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "path", + "description": "The absolute path of the directory. If the parent directories do not exist, it will also create them.\nIf the directory already exists, this command will do nothing and succeed.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetPermissions", + "description": "Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object.", + "summary": "Set workspace object permissions.", + "path": "/api/2.0/permissions/{workspace_object_type}/{workspace_object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WorkspaceObjectPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceObjectAccessControlRequestList", + "array_value": { + "pascal_name": "WorkspaceObjectAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdatePermissions", + "description": "Updates the permissions on a workspace object. Workspace objects can inherit permissions from their parent objects or root object.", + "summary": "Update workspace object permissions.", + "path": "/api/2.0/permissions/{workspace_object_type}/{workspace_object_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WorkspaceObjectPermissionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceObjectPermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "access_control_list", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceObjectAccessControlRequestList", + "array_value": { + "pascal_name": "WorkspaceObjectAccessControlRequest", + "is_object": true + } + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_object_type", + "description": "The workspace object type for which to get or manage permissions. Could be one of the following: alerts, alertsv2, dashboards, dbsql-dashboards, directories, experiments, files, genie, notebooks, queries", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_object_id", + "description": "The workspace object for which to get or manage permissions.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iam.WorkspaceAssignment", + "name": "WorkspaceAssignment", + "description": "The Workspace Permission Assignment API allows you to manage workspace permissions for principals in your account.", + "package": { + "name": "iam" + }, + "is_accounts": true, + "docs_group": "iam", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "list": { + "request": { + "pascal_name": "ListWorkspaceAssignmentRequest" + } + }, + "methods": [ + { + "name": "Delete", + "description": "Deletes the workspace permissions assignment in a given account and workspace for the specified principal.", + "summary": "Delete permissions assignment.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteWorkspaceAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "DeleteWorkspacePermissionAssignmentResponse", + "is_object": true, + "is_empty_response": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Get an array of workspace permissions for the specified account and workspace.", + "summary": "List workspace permissions.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/permissions", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspacePermissions", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "List", + "description": "Get the permission assignments for the specified Databricks account and Databricks workspace.", + "summary": "Get permission assignments.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWorkspaceAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "PermissionAssignments", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID for the account.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "pagination": {} + }, + { + "name": "Update", + "description": "Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal.", + "summary": "Create or update permissions assignment.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceAssignments", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "PermissionAssignment", + "is_object": true + }, + "all_fields": [ + { + "name": "permissions", + "description": "Array of permissions assignments to update on the workspace.\nValid values are \"USER\" and \"ADMIN\" (case-sensitive).\nIf both \"USER\" and \"ADMIN\" are provided, \"ADMIN\" takes precedence.\nOther values will be ignored.\nNote that excluding this field, or providing unsupported values, will have the same effect as providing an empty list, which will result in the deletion of all permissions for the principal.", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspacePermissionList", + "array_value": { + "pascal_name": "WorkspacePermission", + "enum": [ + { + "content": "ADMIN" + }, + { + "content": "UNKNOWN" + }, + { + "content": "USER" + } + ] + } + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_id", + "description": "The ID of the user, service principal, or group.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "catalog.WorkspaceBindings", + "name": "WorkspaceBindings", + "description": "A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable can\nbe accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a configured\nlist of workspaces. This API allows you to configure (bind) securables to workspaces.\n\nNOTE:\nThe __isolation_mode__ is configured for the securable itself (using its Update method) and\nthe workspace bindings are only consulted when the securable's __isolation_mode__ is set to __ISOLATED__.\n\nA securable's workspace bindings can be configured by a metastore admin or the owner of the securable.\n\nThe original path (/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}) is deprecated.\nPlease use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name})\nwhich introduces the ability to bind a securable in READ_ONLY mode (catalogs only).\n\nSecurable types that support binding:\n- catalog\n- storage_credential\n- credential\n- external_location", + "package": { + "name": "catalog" + }, + "docs_group": "catalog", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Get", + "description": "Gets workspace bindings of the catalog.\nThe caller must be a metastore admin or an owner of the catalog.", + "summary": "Get catalog workspace bindings.", + "path": "/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceBindingRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetCatalogWorkspaceBindingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetBindings", + "description": "Gets workspace bindings of the securable.\nThe caller must be a metastore admin or an owner of the securable.\n\nNOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.\n\nPAGINATION BEHAVIOR: When using pagination (max_results \u003e= 0), a page may contain zero results while still providing a next_page_token.\nClients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.", + "summary": "Get securable workspace bindings.", + "path": "/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetBindingsRequest", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "GetWorkspaceBindingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "max_results", + "description": "Maximum number of workspace bindings to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the workspace bindings are returned (not recommended).", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque pagination token to go to next page based on previous query.", + "is_query": true, + "entity": { + "is_string": true + } + } + }, + "max_results": { + "name": "max_results", + "description": "Maximum number of workspace bindings to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the workspace bindings are returned (not recommended).", + "is_query": true, + "entity": { + "is_int": true + } + } + } + }, + { + "name": "Update", + "description": "Updates workspace bindings of the catalog.\nThe caller must be a metastore admin or an owner of the catalog.", + "summary": "Update catalog workspace bindings.", + "path": "/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceBindings", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateCatalogWorkspaceBindingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "assign_workspaces", + "description": "A list of workspace IDs.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_int64": true + } + } + }, + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "unassign_workspaces", + "description": "A list of workspace IDs.", + "is_request_body_field": true, + "entity": { + "pascal_name": "List", + "array_value": { + "is_int64": true + } + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The name of the catalog.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateBindings", + "description": "Updates workspace bindings of the securable.\nThe caller must be a metastore admin or an owner of the securable.", + "summary": "Update securable workspace bindings.", + "path": "/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceBindingsParameters", + "is_object": true, + "required_fields": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "UpdateWorkspaceBindingsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "add", + "description": "List of workspace bindings to add. If a binding for the workspace already exists with a\ndifferent binding_type, adding it again with a new binding_type will update the existing\nbinding (e.g., from READ_WRITE to READ_ONLY).", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBindingList", + "array_value": { + "pascal_name": "WorkspaceBinding", + "is_object": true + } + } + }, + { + "name": "remove", + "description": "List of workspace bindings to remove.", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceBindingList", + "array_value": { + "pascal_name": "WorkspaceBinding", + "is_object": true + } + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "securable_type", + "description": "The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location).", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "securable_name", + "description": "The name of the securable.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "settings.WorkspaceConf", + "name": "WorkspaceConf", + "description": "This API allows updating known workspace settings for advanced users.", + "package": { + "name": "settings" + }, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GetStatus", + "description": "Gets the configuration status for a workspace.", + "summary": "Check configuration status.", + "path": "/api/2.0/workspace-conf", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetStatusRequest", + "is_object": true, + "required_fields": [ + { + "name": "keys", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "keys", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceConf", + "map_value": { + "is_string": true + } + }, + "all_fields": [ + { + "name": "keys", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "keys", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "SetStatus", + "description": "Sets the configuration status for a workspace, including enabling or disabling it.", + "summary": "Enable/disable features.", + "path": "/api/2.0/workspace-conf", + "can_use_json": true, + "must_use_json": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "WorkspaceConf", + "map_value": { + "is_string": true + } + }, + "response": { + "is_empty_response": true + } + } + ] + }, + { + "id": "tags.WorkspaceEntityTagAssignments", + "name": "WorkspaceEntityTagAssignments", + "description": "Manage tag assignments on workspace-scoped objects.", + "package": { + "name": "tags" + }, + "docs_group": "tags", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListTagAssignmentsRequest" + } + }, + "methods": [ + { + "name": "CreateTagAssignment", + "description": "Create a tag assignment", + "summary": "Create a tag assignment for an entity.", + "path": "/api/2.0/entity-tag-assignments", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateTagAssignmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_value", + "description": "The value of the tag", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteTagAssignment", + "description": "Delete a tag assignment", + "summary": "Delete a tag assignment for an entity.", + "path": "/api/2.0/entity-tag-assignments/{entity_type}/{entity_id}/tags/{tag_key}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteTagAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetTagAssignment", + "description": "Get a tag assignment", + "summary": "Get a tag assignment for an entity.", + "path": "/api/2.0/entity-tag-assignments/{entity_type}/{entity_id}/tags/{tag_key}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetTagAssignmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListTagAssignments", + "description": "List the tag assignments for an entity", + "summary": "List tag assignments for an entity.", + "path": "/api/2.0/entity-tag-assignments/{entity_type}/{entity_id}/tags", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListTagAssignmentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListTagAssignmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Optional. Maximum number of tag assignments to return in a single page", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Pagination token to go to the next page of tag assignments. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Pagination token to go to the next page of tag assignments. Requests first page if absent.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "UpdateTagAssignment", + "description": "Update a tag assignment", + "summary": "Update a tag assignment for an entity.", + "path": "/api/2.0/entity-tag-assignments/{entity_type}/{entity_id}/tags/{tag_key}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateTagAssignmentRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_assignment", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "TagAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_value", + "description": "The value of the tag", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "entity_type", + "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "entity_id", + "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "tag_key", + "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "iamv2.WorkspaceIamV2", + "name": "WorkspaceIamV2", + "description": "These APIs are used to manage identities and the workspace access of these identities in \u003cDatabricks\u003e.", + "package": { + "name": "iamv2" + }, + "docs_group": "iam", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "methods": [ + { + "name": "CreateWorkspaceAssignmentDetailProxy", + "description": "Creates a workspace assignment detail for a principal (workspace-level proxy). Entitlement\ngrants are applied individually and non-atomically — if a failure occurs partway through, the\nprincipal will be assigned to the workspace but with only a subset of the requested\nentitlements. Use GetWorkspaceAssignmentDetail to confirm which entitlements were successfully\ngranted.", + "summary": "Create a workspace assignment detail for a workspace.", + "path": "/api/2.0/identity/workspaceAssignmentDetails", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateWorkspaceAssignmentDetailProxyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + { + "name": "account_id", + "description": "The account ID parent of the workspace where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_type", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrincipalType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "DeleteWorkspaceAssignmentDetailProxy", + "description": "Deletes a workspace assignment detail for a principal (workspace-level proxy), revoking all\nassociated entitlements. Entitlement revocations are applied individually and non-atomically\n— if a failure occurs partway through, the principal remains assigned with a subset of its\noriginal entitlements, and the operation is safe to retry.", + "summary": "Delete a workspace assignment detail for a workspace.", + "path": "/api/2.0/identity/workspaceAssignmentDetails/{principal_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteWorkspaceAssignmentDetailProxyRequest", + "is_object": true, + "required_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks to delete workspace assignment for.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetWorkspaceAccessDetailLocal", + "description": "Returns the access details for a principal in the current workspace. Allows for checking access details for any\nprovisioned principal (user, service principal, or group) in the current workspace.\n* Provisioned principal here refers to one that has been synced into Databricks from the customer's IdP or\nadded explicitly to Databricks via SCIM/UI.\nAllows for passing in a \"view\" parameter to control what fields are returned (BASIC by default or FULL).", + "summary": "Get workspace access details for a principal.", + "path": "/api/2.0/identity/workspaceAccessDetails/{principal_id}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetWorkspaceAccessDetailLocalRequest", + "is_object": true, + "required_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceAccessDetail", + "is_object": true + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "view", + "description": "Controls what fields are returned.", + "is_query": true, + "entity": { + "pascal_name": "WorkspaceAccessDetailView", + "enum": [ + { + "content": "BASIC" + }, + { + "content": "FULL" + } + ] + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the access details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "GetWorkspaceAssignmentDetailProxy", + "description": "Returns the assignment details for a principal in a workspace (workspace-level proxy).", + "summary": "Get workspace assignment details for a principal.", + "path": "/api/2.0/identity/workspaceAssignmentDetails/{principal_id}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetWorkspaceAssignmentDetailProxyRequest", + "is_object": true, + "required_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "Required. The internal ID of the principal (user/sp/group) for which the assignment details are being requested.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "ListWorkspaceAssignmentDetailsProxy", + "description": "Lists workspace assignment details for a workspace (workspace-level proxy).", + "summary": "List workspace assignment details for a workspace.", + "path": "/api/2.0/identity/workspaceAssignmentDetails", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListWorkspaceAssignmentDetailsProxyRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListWorkspaceAssignmentDetailsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of workspace assignment details to return. The service may return fewer than this value.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous ListWorkspaceAssignmentDetailsProxy call. Provide this to retrieve the subsequent page.", + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ResolveGroupProxy", + "description": "Resolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external group in the Databricks account.", + "path": "/api/2.0/identity/groups/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveGroupProxyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveGroupResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the group in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ResolveServicePrincipalProxy", + "description": "Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external service principal in the Databricks account.", + "path": "/api/2.0/identity/servicePrincipals/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveServicePrincipalProxyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveServicePrincipalResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the service principal in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ResolveUserProxy", + "description": "Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "summary": "Resolve an external user in the Databricks account.", + "path": "/api/2.0/identity/users/resolveByExternalId", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveUserProxyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveUserResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "external_id", + "description": "Required. The external ID of the user in the customer's IdP.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateWorkspaceAssignmentDetailProxy", + "description": "Updates the entitlements of a directly assigned principal in a workspace (workspace-level\nproxy). Entitlement changes are applied individually and non-atomically — if a failure occurs\npartway through, only a subset of the requested changes may have been applied. Use\nGetWorkspaceAssignmentDetail to confirm the final state.", + "summary": "Update a workspace assignment detail for a workspace.", + "path": "/api/2.0/identity/workspaceAssignmentDetails/{principal_id}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateWorkspaceAssignmentDetailProxyRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + "response": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "workspace_assignment_detail", + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignmentDetail", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + { + "name": "account_id", + "description": "The account ID parent of the workspace where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "entitlements", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_type", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrincipalType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal is assigned", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "Required. ID of the principal in Databricks.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "update_mask", + "description": "Required. The list of fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "settings.WorkspaceNetworkConfiguration", + "name": "WorkspaceNetworkConfiguration", + "description": "These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace. Each workspace is always associated with exactly one network policy that controls which network destinations can be accessed from the Databricks environment. By default, workspaces are associated with the 'default-policy' network policy. You cannot create or delete a workspace's network option, only update it to associate the workspace with a different policy", + "package": { + "name": "settings" + }, + "is_accounts": true, + "docs_group": "settings", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "GetWorkspaceNetworkOptionRpc", + "description": "Gets the network option for a workspace. Every workspace has exactly one network policy binding,\nwith 'default-policy' used if no explicit assignment exists.", + "summary": "Get workspace network option.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/network", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceNetworkOptionRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "UpdateWorkspaceNetworkOptionRpc", + "description": "Updates the network option for a workspace. This operation associates the workspace with the specified network policy.\nTo revert to the default policy, specify 'default-policy' as the network_policy_id.", + "summary": "Update workspace network option.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}/network", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceNetworkOptionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_network_option", + "description": "The network option details for the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_network_option", + "description": "The network option details for the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_network_option", + "description": "The network option details for the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + } + }, + "response": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_network_option", + "description": "The network option details for the workspace.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceNetworkOption", + "is_object": true + } + }, + { + "name": "network_policy_id", + "description": "The network policy ID to apply to the workspace. This controls the network access rules\nfor all serverless compute resources in the workspace. Each workspace can only be\nlinked to one policy at a time. If no policy is explicitly assigned,\nthe workspace will use 'default-policy'.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "The workspace ID.", + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "The workspace ID.", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + } + ] + }, + { + "id": "settingsv2.WorkspaceSettingsV2", + "name": "WorkspaceSettingsV2", + "description": "APIs to manage workspace level settings", + "package": { + "name": "settingsv2" + }, + "docs_group": "settings", + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "list": { + "request": { + "pascal_name": "ListWorkspaceSettingsMetadataRequest" + } + }, + "methods": [ + { + "name": "GetPublicWorkspaceSetting", + "description": "Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs.", + "summary": "Get a workspace setting.", + "path": "/api/2.1/settings/{name}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "GetPublicWorkspaceSettingRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Setting", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListWorkspaceSettingsMetadata", + "description": "List valid setting keys and metadata. These settings are available to be referenced via\nGET :method:settingsv2/getpublicworkspacesetting and\nPATCH :method:settingsv2/patchpublicworkspacesetting APIs", + "summary": "List valid setting keys and their metadata.", + "path": "/api/2.1/settings-metadata", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "ListWorkspaceSettingsMetadataRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListWorkspaceSettingsMetadataResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token, received from a previous `ListWorkspaceSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListWorkspaceSettingsMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token, received from a previous `ListWorkspaceSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListWorkspaceSettingsMetadataRequest` must match\nthe call that provided the page token.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "PatchPublicWorkspaceSetting", + "description": "Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs at workspace level.\nTo determine the correct field to include in a patch request, refer to the type field of the setting returned in the :method:settingsv2/listworkspacesettingsmetadata response.\n\nNote: Page refresh is required for changes to take effect in UI.", + "summary": "Update a workspace setting.", + "path": "/api/2.1/settings/{name}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_PREVIEW", + "cli_launch_stage_label": "*Public Preview*", + "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", + "cli_launch_stage_display": "Public Preview", + "request": { + "pascal_name": "PatchPublicWorkspaceSettingRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + }, + "response": { + "pascal_name": "Setting", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "setting", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Setting", + "is_object": true + } + }, + { + "name": "aibi_dashboard_embedding_access_policy", + "description": "Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + }, + { + "name": "aibi_dashboard_embedding_approved_domains", + "description": "Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + }, + { + "name": "allowed_apps_user_api_scopes", + "description": "Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AllowedAppsUserApiScopesMessage", + "is_object": true + } + }, + { + "name": "automatic_cluster_update_workspace", + "description": "Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + }, + { + "name": "boolean_val", + "description": "Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "collaboration_platform_connectivity", + "description": "Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CollaborationPlatformConnectivityMessage", + "is_object": true + } + }, + { + "name": "effective_aibi_dashboard_embedding_access_policy", + "description": "Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingAccessPolicy", + "is_object": true + } + }, + { + "name": "effective_aibi_dashboard_embedding_approved_domains", + "description": "Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AibiDashboardEmbeddingApprovedDomains", + "is_object": true + } + }, + { + "name": "effective_allowed_apps_user_api_scopes", + "description": "Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AllowedAppsUserApiScopesMessage", + "is_object": true + } + }, + { + "name": "effective_automatic_cluster_update_workspace", + "description": "Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ClusterAutoRestartMessage", + "is_object": true + } + }, + { + "name": "effective_boolean_val", + "description": "Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "BooleanMessage", + "is_object": true + } + }, + { + "name": "effective_collaboration_platform_connectivity", + "description": "Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CollaborationPlatformConnectivityMessage", + "is_object": true + } + }, + { + "name": "effective_integer_val", + "description": "Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IntegerMessage", + "is_object": true + } + }, + { + "name": "effective_operational_email_custom_recipient", + "description": "Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OperationalEmailCustomRecipientMessage", + "is_object": true + } + }, + { + "name": "effective_personal_compute", + "description": "Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + }, + { + "name": "effective_restrict_workspace_admins", + "description": "Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + }, + { + "name": "effective_string_val", + "description": "Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + }, + { + "name": "integer_val", + "description": "Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "IntegerMessage", + "is_object": true + } + }, + { + "name": "name", + "description": "Name of the setting.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "operational_email_custom_recipient", + "description": "Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "OperationalEmailCustomRecipientMessage", + "is_object": true + } + }, + { + "name": "personal_compute", + "description": "Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "PersonalComputeMessage", + "is_object": true + } + }, + { + "name": "restrict_workspace_admins", + "description": "Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "RestrictWorkspaceAdminsMessage", + "is_object": true + } + }, + { + "name": "string_val", + "description": "Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "StringMessage", + "is_object": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Name of the setting", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + } + ] + }, + { + "id": "provisioning.Workspaces", + "name": "Workspaces", + "description": "These APIs manage workspaces for this account. A Databricks workspace is an environment for\naccessing all of your Databricks assets. The workspace organizes objects (notebooks,\nlibraries, and experiments) into folders, and provides access to data and computational\nresources such as clusters and jobs.\n\nThese endpoints are available if your account is on the E2 version of the platform or on\na select custom plan that allows multiple workspaces per account.", + "package": { + "name": "provisioning" + }, + "is_accounts": true, + "docs_group": "provisioning", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "methods": [ + { + "name": "Create", + "description": "Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.\n\nImportant: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace status is typically PROVISIONING. Use the workspace ID (workspace_id) field in the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING.\n\nYou can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to share one VPC with multiple workspaces, make sure you size your VPC and subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces.\n\nFor information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).\n\nImportant: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your Databricks representative.\n\nThis operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.", + "summary": "Create a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateWorkspaceRequest", + "is_object": true + }, + "response": { + "pascal_name": "Workspace", + "is_object": true + }, + "all_fields": [ + { + "name": "aws_region", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cloud", + "description": "DEPRECATED: This field is being ignored by the server and will be removed in the future.\nThe cloud name. This field always has the value `gcp`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cloud_resource_container", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloudResourceContainer", + "is_object": true + } + }, + { + "name": "compute_mode", + "description": "If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don't need to provide any resources managed by you, such as credentials, storage, or network.\nIf the compute mode is `HYBRID` (which is the default option), a classic workspace is created that uses customer-managed resources.", + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomerFacingComputeMode", + "enum": [ + { + "content": "HYBRID" + }, + { + "content": "SERVERLESS" + } + ] + } + }, + { + "name": "credentials_id", + "description": "ID of the workspace's credential configuration object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The\nvalue can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "deployment_name", + "description": "The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is \u003cworkspace-deployment-name\u003e.cloud.databricks.com. For example, if the deployment name is abcsales, your workspace URL will be https://abcsales.cloud.databricks.com. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain.\nTo set this value, you must have a deployment name prefix. Contact your Databricks account team to add an account deployment name prefix to your account.\nWorkspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is acme and the workspace deployment name is workspace-1, the JSON response for the deployment_name field becomes acme-workspace-1. The workspace URL would be acme-workspace-1.cloud.databricks.com.\nYou can also set the deployment_name to the reserved keyword EMPTY if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is acme and the workspace deployment name is EMPTY, the deployment_name becomes acme only and the workspace URL is acme.cloud.databricks.com.\nThis value must be unique across all non-deleted deployments across all AWS regions.\nIf a new workspace omits this property, the server generates a unique deployment name for you with the pattern dbc-xxxxxxxx-xxxx.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "gcp_managed_network_config", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpManagedNetworkConfig", + "is_object": true + } + }, + { + "name": "gke_config", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GkeConfig", + "is_object": true + } + }, + { + "name": "location", + "description": "The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "managed_services_customer_managed_key_id", + "description": "The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property use_cases must contain MANAGED_SERVICES.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "network_connectivity_config_id", + "description": "The object ID of network connectivity config. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks and optional private link to access your resources.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "network_id", + "description": "The ID of the workspace's network configuration object. To use AWS PrivateLink, this field is required.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pricing_tier", + "is_request_body_field": true, + "entity": { + "pascal_name": "PricingTier", + "enum": [ + { + "content": "COMMUNITY_EDITION" + }, + { + "content": "DEDICATED" + }, + { + "content": "ENTERPRISE" + }, + { + "content": "PREMIUM" + }, + { + "content": "STANDARD" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "private_access_settings_id", + "description": "ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.\nBefore configuring PrivateLink, read the [Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\",", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_configuration_id", + "description": "ID of the workspace's storage configuration object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_customer_managed_key_id", + "description": "The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property use_cases must contain STORAGE.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_name", + "description": "The human-readable name of the workspace.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "Workspace" + } + }, + "status_path": [ + { + "pascal_name": "WorkspaceStatus" + } + ], + "message_path": [ + { + "pascal_name": "WorkspaceStatusMessage" + } + ], + "message_path_head": { + "pascal_name": "WorkspaceStatusMessage" + } + } + }, + { + "name": "Delete", + "description": "Deletes a Databricks workspace, both specified by ID.", + "summary": "Delete a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}", + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "DeleteWorkspaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "Workspace", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "Get", + "description": "Gets information including status for a Databricks workspace, specified by ID. In the response, the `workspace_status` field indicates the current status. After initial workspace creation (which is asynchronous), make repeated `GET` requests with the workspace ID and check its status. The workspace becomes available when the status changes to `RUNNING`.\nFor information about how to create a new workspace with this API **including error handling**, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).", + "summary": "Get a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "GetWorkspaceRequest", + "is_object": true, + "required_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + "response": { + "pascal_name": "Workspace", + "is_object": true + }, + "all_fields": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "required": true, + "is_path": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "List", + "description": "Lists Databricks workspaces for an account.", + "summary": "List workspaces.", + "path": "/api/2.0/accounts/{account_id}/workspaces", + "is_legacy_empty_request": true, + "is_crud_read": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "ListWorkspacesRequest", + "is_object": true + }, + "response": { + "pascal_name": "WorkspaceList", + "array_value": { + "pascal_name": "Workspace", + "is_object": true + } + } + }, + { + "name": "Update", + "description": "Updates a workspace.", + "summary": "Update a workspace.", + "path": "/api/2.0/accounts/{account_id}/workspaces/{workspace_id}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "UpdateWorkspaceRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_id", + "description": "A unique integer ID for the workspace", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_int64": true + } + }, + { + "name": "customer_facing_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Workspace", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "workspace_id", + "description": "A unique integer ID for the workspace", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "customer_facing_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Workspace", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "customer_facing_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Workspace", + "is_object": true + } + }, + "response": { + "pascal_name": "Workspace", + "is_object": true + }, + "all_fields": [ + { + "name": "customer_facing_workspace", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Workspace", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_id", + "description": "A unique integer ID for the workspace", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_int64": true + } + }, + { + "name": "account_id", + "description": "Databricks account ID.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "aws_region", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "azure_workspace_info", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "AzureWorkspaceInfo", + "is_object": true + } + }, + { + "name": "cloud", + "description": "The cloud name. This field can have values like `azure`, `gcp`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "cloud_resource_container", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "CloudResourceContainer", + "is_object": true + } + }, + { + "name": "compute_mode", + "description": "The compute mode of the workspace.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomerFacingComputeMode", + "enum": [ + { + "content": "HYBRID" + }, + { + "content": "SERVERLESS" + } + ] + } + }, + { + "name": "creation_time", + "description": "Time in epoch milliseconds when the workspace was created.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "credentials_id", + "description": "ID of the workspace's credential configuration object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "custom_tags", + "description": "The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string,\nwith maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.", + "is_request_body_field": true, + "entity": { + "map_value": { + "is_string": true + } + } + }, + { + "name": "deployment_name", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "expected_workspace_status", + "description": "A client owned field used to indicate the workspace status that the client expects to be in.\nFor now this is only used to unblock Temporal workflow for GCP least privileged workspace.", + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceStatus", + "enum": [ + { + "content": "BANNED" + }, + { + "content": "CANCELLING" + }, + { + "content": "FAILED" + }, + { + "content": "NOT_PROVISIONED" + }, + { + "content": "PROVISIONING" + }, + { + "content": "RUNNING" + } + ] + } + }, + { + "name": "gcp_managed_network_config", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GcpManagedNetworkConfig", + "is_object": true + } + }, + { + "name": "gke_config", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "GkeConfig", + "is_object": true + } + }, + { + "name": "location", + "description": "The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`).", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "managed_services_customer_managed_key_id", + "description": "ID of the key configuration for encrypting managed services.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "network", + "description": "The network configuration for the workspace.\n\nDEPRECATED. Use `network_id` instead.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "WorkspaceNetwork", + "is_object": true + } + }, + { + "name": "network_connectivity_config_id", + "description": "The object ID of network connectivity config.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "network_id", + "description": "If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not\nBYO VPC, then the network_id will be empty.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "pricing_tier", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PricingTier", + "enum": [ + { + "content": "COMMUNITY_EDITION" + }, + { + "content": "DEDICATED" + }, + { + "content": "ENTERPRISE" + }, + { + "content": "PREMIUM" + }, + { + "content": "STANDARD" + }, + { + "content": "UNKNOWN" + } + ] + } + }, + { + "name": "private_access_settings_id", + "description": "ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.\n\nBefore configuring PrivateLink, read the [Databricks article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\",", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_configuration_id", + "description": "ID of the workspace's storage configuration object.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_customer_managed_key_id", + "description": "ID of the key configuration for encrypting workspace storage.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "storage_mode", + "description": "The storage mode of the workspace.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "CustomerFacingStorageMode", + "enum": [ + { + "content": "CUSTOMER_HOSTED" + }, + { + "content": "DEFAULT_STORAGE" + } + ] + } + }, + { + "name": "workspace_id", + "description": "A unique integer ID for the workspace", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "workspace_name", + "description": "The human-readable name of the workspace.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_status", + "description": "The status of a workspace", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceStatus", + "enum": [ + { + "content": "BANNED" + }, + { + "content": "CANCELLING" + }, + { + "content": "FAILED" + }, + { + "content": "NOT_PROVISIONED" + }, + { + "content": "PROVISIONING" + }, + { + "content": "RUNNING" + } + ] + } + }, + { + "name": "workspace_status_message", + "description": "Message describing the current workspace status.", + "is_computed": true, + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "workspace_id", + "description": "A unique integer ID for the workspace", + "required": true, + "is_path": true, + "is_output_only": true, + "entity": { + "is_int64": true + } + } + ], + "wait": { + "success": [ + { + "content": "RUNNING" + } + ], + "timeout": 20, + "poll": { + "response": { + "pascal_name": "Workspace" + } + }, + "status_path": [ + { + "pascal_name": "WorkspaceStatus" + } + ], + "message_path": [ + { + "pascal_name": "WorkspaceStatusMessage" + } + ], + "message_path_head": { + "pascal_name": "WorkspaceStatusMessage" + } + } + } + ] + } + ], + "workspace_docs_groups": [ + { + "key": "workspace", + "display_name": "Databricks Workspace" + }, + { + "key": "compute", + "display_name": "Compute" + }, + { + "key": "lakeflow", + "display_name": "Lakeflow" + }, + { + "key": "files", + "display_name": "File Management" + }, + { + "key": "ml", + "display_name": "Machine Learning" + }, + { + "key": "serving", + "display_name": "Real-time Serving" + }, + { + "key": "apps", + "display_name": "Apps" + }, + { + "key": "vectorsearch", + "display_name": "Vector Search" + }, + { + "key": "iam", + "display_name": "Identity and Access Management" + }, + { + "key": "sql", + "display_name": "Databricks SQL" + }, + { + "key": "dashboards", + "display_name": "AI/BI" + }, + { + "key": "catalog", + "display_name": "Unity Catalog" + }, + { + "key": "sharing", + "display_name": "Delta Sharing" + }, + { + "key": "settings", + "display_name": "Settings" + }, + { + "key": "oauth2", + "display_name": "OAuth" + }, + { + "key": "marketplace", + "display_name": "Marketplace" + }, + { + "key": "cleanrooms", + "display_name": "Clean Rooms" + }, + { + "key": "qualitymonitor", + "display_name": "Quality Monitor" + }, + { + "key": "dataclassification", + "display_name": "Data Classification" + }, + { + "key": "dataquality", + "display_name": "Data Quality Monitoring" + }, + { + "key": "database", + "display_name": "Database Instances" + }, + { + "key": "agentbricks", + "display_name": "Agent Bricks" + }, + { + "key": "tags", + "display_name": "Tags" + }, + { + "key": "postgres", + "display_name": "Postgres" + }, + { + "key": "environments", + "display_name": "Environments" + }, + { + "key": "bundle", + "display_name": "Bundle" + } + ], + "account_docs_groups": [ + { + "key": "iam", + "display_name": "Identity and Access Management" + }, + { + "key": "catalog", + "display_name": "Unity Catalog" + }, + { + "key": "settings", + "display_name": "Settings" + }, + { + "key": "provisioning", + "display_name": "Provisioning" + }, + { + "key": "billing", + "display_name": "Billing" + }, + { + "key": "oauth2", + "display_name": "OAuth" + }, + { + "key": "disasterrecovery", + "display_name": "Disaster Recovery" + } + ] + } +} diff --git a/.golangci.yaml b/.golangci.yaml index c922b21347a..5df32231eb0 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -66,6 +66,7 @@ linters: - "!**/bundle/internal/schema/**" - "!**/bundle/internal/tf/codegen/**" - "!**/bundle/internal/validation/**" + - "!**/internal/cligen/**" deny: - pkg: "log$" desc: "use libs/log instead of the standard library log package" diff --git a/Taskfile.yml b/Taskfile.yml index 36fe090242f..e2cf17df51d 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -400,6 +400,8 @@ tasks: # internal/build reads these at test time. - NOTICE - .codegen/_openapi_sha + # internal/cligen TestCliJSONIsInterpretable reads the committed cli.json. + - .codegen/cli.json # bundle/internal/schema TestRequiredAnnotationsForNewFields reads these. - bundle/internal/schema/annotations*.yml generates: @@ -709,11 +711,10 @@ tasks: generate: desc: Run all generators (genkit, tf-schema, refschema, schema, docs, validation, direct, pydabs) cmds: - # Runs first: regenerates CLI command stubs from the OpenAPI spec at - # .codegen/_openapi_sha. SDK version bumps (go.mod/go.sum) are a manual - # step outside this task; TestConsistentDatabricksSdkVersion (run inside - # generate-genkit) asserts the two stay in sync. - - task: generate-genkit + # Runs first: regenerates CLI command stubs from the checked-in + # .codegen/cli.json (no universe checkout needed). Refreshing cli.json + # itself from the OpenAPI spec is the separate `generate-cli-json` task. + - task: generate-cligen # Requires Terraform provider access (set TF_CLI_CONFIG_FILE to a # filesystem mirror, or rely on the public registry). Only re-runs when # bundle/internal/tf/codegen/schema/version.go changes. @@ -728,23 +729,43 @@ tasks: - task: generate-direct - task: pydabs-codegen - # Drives genkit from a universe checkout. Genkit writes CLI command files into - # cmd/workspace and cmd/account, refreshes .gitattributes and - # .codegen/_openapi_sha, and emits .github/workflows/tagging.yml + - # tagging.py (+ lock) in the repo root plus a next-changelog workflow we - # don't keep. Genkit does NOT modify go.mod/go.sum — SDK bumps are a manual - # `go get` step before running this task. The cmds below then post-process - # genkit's output: assert the SDK version matches the OpenAPI SHA, drop the - # next-changelog workflow, relocate tagging.py under internal/genkit/ and - # rewrite the tagging.yml workflow to match, then yamlfmt + whitespace fix - # so the tree is clean. - generate-genkit: - desc: Run genkit to generate CLI commands and tagging workflow (requires universe repo) + # Regenerates the CLI command stubs (cmd/workspace/**, cmd/account/**) and + # .gitattributes from the checked-in .codegen/cli.json. No universe checkout, + # no spec download, no network: cli.json is the self-describing spec + # produced upstream by `generate-cli-json`. internal/cligen renders + # the same templates genkit's cli_v0 generator uses, then formats with + # goimports + gofmt. The final `ws` strips trailing whitespace (e.g. the + # comment-banner blank lines) so the result matches byte-for-byte, exactly as + # the old generate-genkit task did. + generate-cligen: + desc: Regenerate CLI command stubs from .codegen/cli.json sources: - - .codegen/_openapi_sha + - .codegen/cli.json - .gitattributes.manual + - internal/cligen/**/*.go + - internal/cligen/templates/*.tmpl + generates: + - cmd/workspace/**/*.go + - cmd/account/**/*.go + - .gitattributes + cmds: + - go run ./internal/cligen --input .codegen/cli.json --output . + - task: ws + + # Refreshes .codegen/cli.json from the OpenAPI spec at .codegen/_openapi_sha. + # This is the only step that needs a universe checkout: genkit's clijson + # producer maps the OpenAPI spec into the cli.json spec. Run it when the + # spec SHA is bumped; `task generate` then consumes the committed cli.json. + # SDK version bumps (go.mod/go.sum) are a manual `go get` step beforehand; + # TestConsistentDatabricksSdkVersion asserts the two stay in sync. + generate-cli-json: + desc: Produce .codegen/cli.json from the OpenAPI spec via genkit (requires universe repo) + sources: + - .codegen/_openapi_sha - go.mod - go.sum + generates: + - .codegen/cli.json vars: UNIVERSE_DIR: sh: echo "${UNIVERSE_DIR:-$HOME/universe}" @@ -764,23 +785,13 @@ tasks: else echo "UNIVERSE_SKIP_CHECKOUT set; using current {{.UNIVERSE_DIR}} HEAD" fi - - echo "Building genkit..." - - cd {{.UNIVERSE_DIR}} && ./tools/bazel build //openapi/genkit - - echo "Generating CLI code..." - - "{{.UNIVERSE_DIR}}/bazel-bin/openapi/genkit/genkit_/genkit update-sdk" - - "cat .gitattributes.manual .gitattributes > .gitattributes.tmp && mv .gitattributes.tmp .gitattributes" + - echo "Building genkit cliv1 producer..." + - cd {{.UNIVERSE_DIR}} && ./tools/bazel build //openapi/genkit/codegen/cliv1/cmd + - echo "Downloading OpenAPI spec..." + - 'wget -O /tmp/cli-openapi.json "https://openapi.dev.databricks.com/$(cat .codegen/_openapi_sha)/specs/all-internal.json"' + - echo "Producing cli.json..." + - '{{.UNIVERSE_DIR}}/bazel-bin/openapi/genkit/codegen/cliv1/cmd/cmd_/cmd --spec /tmp/cli-openapi.json --out .codegen/cli.json --sha "$(cat .codegen/_openapi_sha)"' - go test -timeout 240s -run TestConsistentDatabricksSdkVersion github.com/databricks/cli/internal/build - - rm .github/workflows/next-changelog.yml - - mv tagging.py internal/genkit/tagging.py - - mv tagging.py.lock internal/genkit/tagging.py.lock - - | - if [ "$(uname)" = "Darwin" ]; then - sed -i '' 's|tagging.py|internal/genkit/tagging.py|g' .github/workflows/tagging.yml - else - sed -i 's|tagging.py|internal/genkit/tagging.py|g' .github/workflows/tagging.yml - fi - - "{{.GO_TOOL}} yamlfmt .github/workflows/tagging.yml" - - task: ws # Refreshes out.fields.txt, which records the field paths / types emitted by # `bundle debug refschema` (see cmd/bundle/debug/refschema.go). It reflects @@ -801,8 +812,19 @@ tasks: cmds: - go test ./acceptance -run TestAccept/bundle/refschema -update + # Regenerates the OpenAPI annotation files (annotations_openapi*.yml) from the + # checked-in .codegen/cli.json. This is the step that propagates a cli.json + # change into the schema/docs artifacts: generate-schema, generate-schema-docs + # and generate-docs all depend on it, so editing cli.json and running + # `task generate` percolates into jsonschema.json, the docs and pydabs. + generate-annotations: + desc: Regenerate annotation files from .codegen/cli.json + cmds: + - "DATABRICKS_CLI_JSON=.codegen/cli.json go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json" + generate-schema: desc: Generate bundle JSON schema + deps: ['generate-annotations'] sources: &SCHEMA_SOURCES - "**/*.go" - bundle/internal/schema/annotations*.yml @@ -818,6 +840,7 @@ tasks: generate-schema-docs: desc: Generate bundle JSON schema for documentation + deps: ['generate-annotations'] sources: *SCHEMA_SOURCES generates: - bundle/schema/jsonschema_for_docs.json @@ -832,6 +855,7 @@ tasks: generate-docs: desc: Generate bundle documentation + deps: ['generate-annotations'] sources: - "**/*.go" - bundle/docsgen/templates/** @@ -896,38 +920,28 @@ tasks: generate-direct-apitypes: desc: Generate direct engine API types YAML - deps: ['generate-openapi-json'] sources: - bundle/direct/tools/generate_apitypes.py - - .codegen/openapi.json + - .codegen/cli.json - acceptance/bundle/refschema/out.fields.txt generates: - bundle/direct/dresources/apitypes.generated.yml cmds: - - "sh -c 'python3 bundle/direct/tools/generate_apitypes.py .codegen/openapi.json acceptance/bundle/refschema/out.fields.txt > bundle/direct/dresources/apitypes.generated.yml'" + - "sh -c 'python3 bundle/direct/tools/generate_apitypes.py .codegen/cli.json acceptance/bundle/refschema/out.fields.txt > bundle/direct/dresources/apitypes.generated.yml'" generate-direct-resources: desc: Generate direct engine resources YAML deps: ['generate-direct-apitypes'] sources: - bundle/direct/tools/generate_resources.py - - .codegen/openapi.json + - .codegen/cli.json - bundle/direct/dresources/apitypes.generated.yml - bundle/direct/dresources/apitypes.yml - acceptance/bundle/refschema/out.fields.txt generates: - bundle/direct/dresources/resources.generated.yml cmds: - - "sh -c 'uv run --script bundle/direct/tools/generate_resources.py .codegen/openapi.json bundle/direct/dresources/apitypes.generated.yml bundle/direct/dresources/apitypes.yml acceptance/bundle/refschema/out.fields.txt > bundle/direct/dresources/resources.generated.yml'" - - generate-openapi-json: - desc: Download OpenAPI spec (triggered by _openapi_sha change) - sources: - - .codegen/_openapi_sha - generates: - - .codegen/openapi.json - cmds: - - "wget -O .codegen/openapi.json.tmp \"https://openapi.dev.databricks.com/$(cat .codegen/_openapi_sha)/specs/all-internal.json\" && mv .codegen/openapi.json.tmp .codegen/openapi.json" + - "sh -c 'uv run --script bundle/direct/tools/generate_resources.py .codegen/cli.json bundle/direct/dresources/apitypes.generated.yml bundle/direct/dresources/apitypes.yml acceptance/bundle/refschema/out.fields.txt > bundle/direct/dresources/resources.generated.yml'" # pydabs-* tasks are defined in python/Taskfile.yml (included above). diff --git a/bundle/direct/dresources/resources.generated.yml b/bundle/direct/dresources/resources.generated.yml index b73eb8931b2..1749a217b33 100644 --- a/bundle/direct/dresources/resources.generated.yml +++ b/bundle/direct/dresources/resources.generated.yml @@ -27,11 +27,6 @@ resources: apps: ignore_remote_changes: - - field: git_source - reason: spec:input_only - - field: source_code_path - reason: spec:input_only - - field: active_deployment reason: spec:output_only - field: app_status diff --git a/bundle/direct/tools/generate_apitypes.py b/bundle/direct/tools/generate_apitypes.py index 78815eae0e2..a40fc8d69d6 100644 --- a/bundle/direct/tools/generate_apitypes.py +++ b/bundle/direct/tools/generate_apitypes.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 """ -Find candidate types from openapi.json that match resource shapes in out.fields.txt and save them (apitypes.generated.yml). +Find candidate types from cli.json that match resource shapes in out.fields.txt and save them (apitypes.generated.yml). The types are found based on top level field overlap between bundle schema and API type. @@ -40,20 +40,20 @@ def get_schema_fields(schemas): """Get top-level field names for each schema type.""" schema_fields = {} for name, schema in schemas.items(): - props = schema.get("properties", {}) + props = schema.get("fields", {}) if props: schema_fields[name] = set(props.keys()) return schema_fields def main(): - parser = argparse.ArgumentParser(description="Generate apitypes.yml from OpenAPI schema") - parser.add_argument("apischema", type=Path, help="Path to OpenAPI schema JSON file") + parser = argparse.ArgumentParser(description="Generate apitypes.yml from the cli.json schema block") + parser.add_argument("apischema", type=Path, help="Path to cli.json schema block") parser.add_argument("out_fields", type=Path, help="Path to out.fields.txt file") args = parser.parse_args() resource_fields = parse_out_fields(args.out_fields) - schemas = json.loads(args.apischema.read_text()).get("components", {}).get("schemas", {}) + schemas = json.loads(args.apischema.read_text())["schemas"] schema_fields = get_schema_fields(schemas) field_counts = Counter() diff --git a/bundle/direct/tools/generate_resources.py b/bundle/direct/tools/generate_resources.py index ff748d192e5..081de8b3273 100644 --- a/bundle/direct/tools/generate_resources.py +++ b/bundle/direct/tools/generate_resources.py @@ -5,7 +5,7 @@ # ] # /// """ -Generate resources.generated.yml from OpenAPI schema field behaviors. +Generate resources.generated.yml from cli.json field behaviors. """ import argparse @@ -62,18 +62,16 @@ def extract(schema, prefix, visited, depth, inherited): if depth > 4: return {} results = {} - for name, prop in schema.get("properties", {}).items(): + for name, prop in schema.get("fields", {}).items(): path = f"{prefix}.{name}" if prefix else name - behaviors = list(prop.get("x-databricks-field-behaviors", [])) - if prop.get("x-databricks-immutable") and "IMMUTABLE" not in behaviors: - behaviors.append("IMMUTABLE") + behaviors = list(prop.get("behaviors", [])) for b in inherited: if b not in behaviors: behaviors.append(b) if behaviors: results[path] = behaviors - if "$ref" in prop: - ref = prop["$ref"].split("/")[-1] + if "ref" in prop: + ref = prop["ref"] if ref in schemas and ref not in visited: visited.add(ref) propagate = [b for b in behaviors if b in ("INPUT_ONLY", "OUTPUT_ONLY")] @@ -89,10 +87,10 @@ def find_inherited_behaviors(schemas, type_name): """Find INPUT_ONLY/OUTPUT_ONLY behaviors from containers that reference type_name.""" inherited = [] for container_schema in schemas.values(): - for field_prop in container_schema.get("properties", {}).values(): - if field_prop.get("$ref", "").split("/")[-1] != type_name: + for field_prop in container_schema.get("fields", {}).values(): + if field_prop.get("ref", "") != type_name: continue - behaviors = field_prop.get("x-databricks-field-behaviors", []) + behaviors = field_prop.get("behaviors", []) if "INPUT_ONLY" in behaviors and "INPUT_ONLY" not in inherited: inherited.append("INPUT_ONLY") if "OUTPUT_ONLY" in behaviors and "OUTPUT_ONLY" not in inherited: @@ -171,8 +169,8 @@ def generate(resource_behaviors): def main(): - parser = argparse.ArgumentParser(description="Generate resources YAML from OpenAPI schema") - parser.add_argument("apischema", type=Path, help="Path to OpenAPI schema JSON file") + parser = argparse.ArgumentParser(description="Generate resources YAML from the cli.json schema block") + parser.add_argument("apischema", type=Path, help="Path to cli.json schema block") parser.add_argument("apitypes", type=Path, help="Path to apitypes.generated.yml file") parser.add_argument("apitypes_override", type=Path, help="Path to apitypes.yml override file") parser.add_argument("out_fields", type=Path, help="Path to out.fields.txt file") @@ -180,7 +178,7 @@ def main(): resource_types = parse_apitypes(args.apitypes, args.apitypes_override) state_fields = parse_out_fields(args.out_fields) - schemas = json.loads(args.apischema.read_text()).get("components", {}).get("schemas", {}) + schemas = json.loads(args.apischema.read_text())["schemas"] resource_behaviors = {} for resource, type_name in sorted(resource_types.items()): diff --git a/bundle/docsgen/output/resources.md b/bundle/docsgen/output/resources.md index 3e6e171811c..14e0a57f583 100644 --- a/bundle/docsgen/output/resources.md +++ b/bundle/docsgen/output/resources.md @@ -548,6 +548,10 @@ apps: - Map - Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit). See [\_](#appsnamegit_repository). +- - `git_source` + - Map + - Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. The source_code_path within git_source specifies the relative path to the app code within the repository. See [\_](#appsnamegit_source). + - - `lifecycle` - Map - 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. See [\_](#appsnamelifecycle). @@ -564,6 +568,10 @@ apps: - Sequence - Resources for the app. See [\_](#appsnameresources). +- - `source_code_path` + - String + - + - - `telemetry_export_destinations` - Sequence - See [\_](#appsnametelemetry_export_destinations). @@ -659,6 +667,41 @@ reference code from this repository by providing only the git reference (branch, ::: +### apps._name_.git_source + +**`Type: Map`** + +Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) +to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. +The source_code_path within git_source specifies the relative path to the app code within the repository. + + + +:::list-table + +- - Key + - Type + - Description + +- - `branch` + - String + - Git branch to checkout. + +- - `commit` + - String + - Git commit SHA to checkout. + +- - `source_code_path` + - String + - Relative path to the app source code within the Git repository. If not specified, the root of the repository is used. + +- - `tag` + - String + - Git tag to checkout. + +::: + + ### apps._name_.lifecycle **`Type: Map`** diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 26b9dcfc0de..2889fffe81c 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -89,7 +89,7 @@ func (d *annotationHandler) syncWithMissingAnnotations(outputPath string) error for k := range d.missingAnnotations { if !isCliPath(k) { delete(d.missingAnnotations, k) - fmt.Printf("Missing annotations for `%s` that are not in CLI package, try to fetch latest OpenAPI spec and regenerate annotations\n", k) + fmt.Printf("Missing annotations for `%s` that are not in CLI package, try to refresh .codegen/cli.json and regenerate annotations\n", k) } } diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index c1ca1b01cf9..8d6ac11a81b 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -125,11 +125,6 @@ github.com/databricks/cli/bundle/config/resources.App: "description": |- Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit). - "git_source": - "description": |- - Complete git source specification including repository location and reference. - "x-databricks-preview": |- - PRIVATE "id": "description": |- The unique identifier of the app. @@ -163,9 +158,6 @@ github.com/databricks/cli/bundle/config/resources.App: "service_principal_name": "x-databricks-field-behaviors_output_only": |- true - "source_code_path": - "x-databricks-preview": |- - PRIVATE "space": "description": |- Name of the space this app belongs to. @@ -1510,8 +1502,6 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeSize: MEDIUM - |- LARGE - - |- - LIQUID github.com/databricks/databricks-sdk-go/service/apps.ComputeState: "_": "enum": @@ -1925,44 +1915,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 - - |- - CREATE_FEATURE - - |- - READ_FEATURE - - |- - CREATE_STREAM - - |- - READ_STREAM - - |- - CREATE_MEMORY_STORE - - |- - READ_MEMORY_STORE - - |- - WRITE_MEMORY_STORE github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment: "principal": "description": |- @@ -2600,8 +2552,6 @@ github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType: GPU_1xA10 - |- GPU_8xH100 - - |- - GPU_1xH100 github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "_": "description": |- @@ -2858,8 +2808,6 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: UPDATING - |- FAILING_OVER - - |- - UPGRADING github.com/databricks/databricks-sdk-go/service/database.DeltaTableSyncInfo: "delta_commit_timestamp": "description": |- @@ -3207,8 +3155,6 @@ github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: CAN_MONITOR_ONLY - |- CAN_CREATE_APP - - |- - UNSPECIFIED github.com/databricks/databricks-sdk-go/service/jobs.AlertTask: "alert_id": "description": |- @@ -4719,8 +4665,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFi AVRO - |- ORC - - |- - FILE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode: "_": "description": |- @@ -4790,10 +4734,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoog FILE_METADATA - |- PERMISSION - - |- - FILE_PERMISSION - - |- - GROUP_MEMBERSHIP github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig: "report": "description": |- @@ -4959,10 +4899,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: MYSQL - |- POSTGRESQL - - |- - REDSHIFT - - |- - SQLDW - |- SQLSERVER - |- @@ -4995,166 +4931,8 @@ 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 github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions: @@ -5673,10 +5451,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsShare PERMISSION - |- LIST - - |- - FILE_PERMISSION - - |- - GROUP_MEMBERSHIP github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: "_": "description": |- @@ -5878,10 +5652,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: STRING - |- JSON - - |- - AVRO - - |- - PROTOBUF github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "_": "description": |- @@ -6777,8 +6547,6 @@ github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWareho CLASSIC - |- PRO - - |- - REYDEN github.com/databricks/databricks-sdk-go/service/sql.CronSchedule: "pause_status": "description": |- @@ -6914,8 +6682,6 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType: STORAGE_OPTIMIZED - |- STANDARD - - |- - STANDARD_ON_ORION github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype: "_": "description": |- diff --git a/bundle/internal/schema/cli_json.go b/bundle/internal/schema/cli_json.go new file mode 100644 index 00000000000..c63a875f363 --- /dev/null +++ b/bundle/internal/schema/cli_json.go @@ -0,0 +1,54 @@ +package main + +import ( + "encoding/json" + "fmt" + "os" +) + +// cliJSONField is the shape of a single field in .codegen/cli.json. +type cliJSONField struct { + Description string `json:"description,omitempty"` + Enum []any `json:"enum,omitempty"` + Deprecated bool `json:"deprecated,omitempty"` + Preview string `json:"preview,omitempty"` + Ref string `json:"ref,omitempty"` + Behaviors []string `json:"behaviors,omitempty"` +} + +// cliJSONSchema is the shape of a single schema in .codegen/cli.json. +type cliJSONSchema struct { + Description string `json:"description,omitempty"` + Enum []any `json:"enum,omitempty"` + Deprecated bool `json:"deprecated,omitempty"` + Preview string `json:"preview,omitempty"` + Fields map[string]cliJSONField `json:"fields,omitempty"` +} + +// cliJSONSpec is the top-level shape of .codegen/cli.json that we care about. +type cliJSONSpec struct { + Schemas map[string]cliJSONSchema `json:"schemas"` +} + +// parseCliJSON reads the .codegen/cli.json spec and returns its schema graph +// keyed by SDK type name (e.g. "jobs.JobSettings"). The annotation parser +// matches Go SDK types against these keys directly; refs between schemas are +// stored as bare type names, so no $ref reconstruction is needed. +func parseCliJSON(path string) (map[string]cliJSONSchema, error) { + b, err := os.ReadFile(path) + if err != nil { + return nil, err + } + + var cli cliJSONSpec + err = json.Unmarshal(b, &cli) + if err != nil { + return nil, err + } + + if len(cli.Schemas) == 0 { + return nil, fmt.Errorf("no schemas found in %s", path) + } + + return cli.Schemas, nil +} diff --git a/bundle/internal/schema/main.go b/bundle/internal/schema/main.go index f8bc399134e..ee659c6d078 100644 --- a/bundle/internal/schema/main.go +++ b/bundle/internal/schema/main.go @@ -203,15 +203,24 @@ func generateSchema(workdir, outputFile string, docsMode bool) { annotationsOpenApiPath := filepath.Join(workdir, "annotations_openapi.yml") annotationsOpenApiOverridesPath := filepath.Join(workdir, "annotations_openapi_overrides.yml") - // Input file, the databricks openapi spec. - inputFile := os.Getenv("DATABRICKS_OPENAPI_SPEC") //nolint:forbidigo // main() entry point, no ctx - if inputFile != "" { - p, err := newParser(inputFile) + // The .codegen/cli.json spec is the source for the generated annotation + // files. Its schema graph carries the descriptions, enums and field + // behaviors the CLI reflects onto its config types. When unset, the + // committed annotation files are used as-is. + cliJSONFile := os.Getenv("DATABRICKS_CLI_JSON") //nolint:forbidigo // main() entry point, no ctx + + var p *annotationParser + if cliJSONFile != "" { + schemas, err := parseCliJSON(cliJSONFile) if err != nil { log.Fatal(err) } - fmt.Printf("Writing OpenAPI annotations to %s\n", annotationsOpenApiPath) - err = p.extractAnnotations(reflect.TypeFor[config.Root](), annotationsOpenApiPath, annotationsOpenApiOverridesPath) + p = newParser(schemas) + } + + if p != nil { + fmt.Printf("Writing annotations to %s\n", annotationsOpenApiPath) + err := p.extractAnnotations(reflect.TypeFor[config.Root](), annotationsOpenApiPath, annotationsOpenApiOverridesPath) if err != nil { log.Fatal(err) } diff --git a/bundle/internal/schema/main_test.go b/bundle/internal/schema/main_test.go index 0d0e6868ba8..2ecd24d464d 100644 --- a/bundle/internal/schema/main_test.go +++ b/bundle/internal/schema/main_test.go @@ -42,7 +42,7 @@ func copyFile(src, dst string) error { // Checks whether descriptions are added for new config fields in the annotations.yml file // If this test fails either manually add descriptions to the `annotations.yml` or do the following: -// 1. for fields described outside of CLI package fetch latest schema from the OpenAPI spec and add path to file to DATABRICKS_OPENAPI_SPEC env variable +// 1. for fields described outside of CLI package, refresh .codegen/cli.json (`./task generate-cli-json`) and the annotation files (`./task generate-annotations`) // 2. run `./task generate-schema` from the repository root to add placeholder descriptions // 2. replace all "PLACEHOLDER" values with the actual descriptions if possible // 3. run `./task generate-schema` again to regenerate the schema with acutal descriptions diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 60bf5393b33..3e0cbadd683 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -2,7 +2,6 @@ package main import ( "bytes" - "encoding/json" "fmt" "os" "path" @@ -16,44 +15,37 @@ import ( "github.com/databricks/cli/libs/jsonschema" ) -type Components struct { - Schemas map[string]jsonschema.Schema `json:"schemas,omitempty"` -} - -type Specification struct { - Components Components `json:"components"` -} - -type openapiParser struct { - ref map[string]jsonschema.Schema +type annotationParser struct { + ref map[string]cliJSONSchema } const RootTypeKey = "_" -func newParser(path string) (*openapiParser, error) { - b, err := os.ReadFile(path) - if err != nil { - return nil, err - } +// deprecationMessage is the message emitted for any field or type that the spec +// marks as deprecated. The spec (.codegen/cli.json) carries only a deprecated +// flag, not a message, so we synthesize a fixed one here. +const deprecationMessage = "This field is deprecated" - spec := Specification{} - err = json.Unmarshal(b, &spec) - if err != nil { - return nil, err +// deprecationMessageFor returns the deprecation message for a deprecated field +// or type, or an empty string when it is not deprecated. +func deprecationMessageFor(deprecated bool) string { + if deprecated { + return deprecationMessage } + return "" +} - p := &openapiParser{} - p.ref = spec.Components.Schemas - return p, nil +func newParser(schemas map[string]cliJSONSchema) *annotationParser { + return &annotationParser{ref: schemas} } // This function checks if the input type: // 1. Is a Databricks Go SDK type. // 2. Has a Databricks Go SDK type embedded in it. // -// If the above conditions are met, the function returns the JSON schema -// corresponding to the Databricks Go SDK type from the OpenAPI spec. -func (p *openapiParser) findRef(typ reflect.Type) (jsonschema.Schema, bool) { +// If the above conditions are met, the function returns the schema +// corresponding to the Databricks Go SDK type from the spec. +func (p *annotationParser) findRef(typ reflect.Type) (cliJSONSchema, bool) { typs := []reflect.Type{typ} // Check for embedded Databricks Go SDK types. @@ -82,7 +74,7 @@ func (p *openapiParser) findRef(typ reflect.Type) (jsonschema.Schema, bool) { pkgName := path.Base(ctyp.PkgPath()) k := fmt.Sprintf("%s.%s", pkgName, ctyp.Name()) - // Skip if the type is not in the openapi spec. + // Skip if the type is not in the spec. _, ok := p.ref[k] if !ok { k = mapIncorrectTypNames(k) @@ -92,15 +84,15 @@ func (p *openapiParser) findRef(typ reflect.Type) (jsonschema.Schema, bool) { } } - // Return the first Go SDK type found in the openapi spec. + // Return the first Go SDK type found in the spec. return p.ref[k], true } - return jsonschema.Schema{}, false + return cliJSONSchema{}, false } -// Fix inconsistent type names between the Go SDK and the OpenAPI spec. -// E.g. "serving.PaLmConfig" in the Go SDK is "serving.PaLMConfig" in the OpenAPI spec. +// Fix inconsistent type names between the Go SDK and the spec. +// E.g. "serving.PaLmConfig" in the Go SDK is "serving.PaLMConfig" in the spec. func mapIncorrectTypNames(ref string) string { switch ref { case "serving.PaLmConfig": @@ -116,16 +108,16 @@ func mapIncorrectTypNames(ref string) string { } } -func isOutputOnly(s jsonschema.Schema) *bool { - if s.FieldBehaviors == nil || !slices.Contains(s.FieldBehaviors, "OUTPUT_ONLY") { +func isOutputOnly(behaviors []string) *bool { + if !slices.Contains(behaviors, "OUTPUT_ONLY") { return nil } res := true return &res } -// Use the OpenAPI spec to load descriptions for the given type. -func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overridesPath string) error { +// Use the spec to load descriptions for the given type. +func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, overridesPath string) error { annotations := annotation.File{} overrides := annotation.File{} @@ -159,41 +151,29 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid if preview == "PUBLIC" { preview = "" } - outputOnly := isOutputOnly(ref) - if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || outputOnly != nil { - if ref.Deprecated && ref.DeprecationMessage == "" { - ref.DeprecationMessage = "This field is deprecated" - } - + if ref.Description != "" || ref.Enum != nil || ref.Deprecated || preview != "" { pkg[RootTypeKey] = annotation.Descriptor{ Description: ref.Description, Enum: ref.Enum, - DeprecationMessage: ref.DeprecationMessage, + DeprecationMessage: deprecationMessageFor(ref.Deprecated), Preview: preview, - OutputOnly: outputOnly, } } for k := range s.Properties { - if refProp, ok := ref.Properties[k]; ok { + if refProp, ok := ref.Fields[k]; ok { preview = refProp.Preview if preview == "PUBLIC" { preview = "" } - if refProp.Deprecated && refProp.DeprecationMessage == "" { - refProp.DeprecationMessage = "This field is deprecated" - } - description := refProp.Description // If the field doesn't have a description, try to find the referenced type // and use its description. This handles cases where the field references // a type that has a description but the field itself doesn't. - if description == "" && refProp.Reference != nil { - refPath := *refProp.Reference - refTypeName := strings.TrimPrefix(refPath, "#/components/schemas/") - if refType, ok := p.ref[refTypeName]; ok { + if description == "" && refProp.Ref != "" { + if refType, ok := p.ref[refProp.Ref]; ok { description = refType.Description } } @@ -202,8 +182,8 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid Description: description, Enum: refProp.Enum, Preview: preview, - DeprecationMessage: refProp.DeprecationMessage, - OutputOnly: isOutputOnly(*refProp), + DeprecationMessage: deprecationMessageFor(refProp.Deprecated), + OutputOnly: isOutputOnly(refProp.Behaviors), } if description == "" { addEmptyOverride(k, basePath, overrides) diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 050ad30b247..f6e3c0bc044 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -170,9 +170,7 @@ }, "git_source": { "description": "Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit)\nto use when deploying the app. Used in conjunction with git_repository to deploy code directly from git.\nThe source_code_path within git_source specifies the relative path to the app code within the repository.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource" }, "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.", @@ -190,9 +188,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource" }, "source_code_path": { - "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true + "$ref": "#/$defs/string" }, "space": { "description": "Name of the space this app belongs to.", @@ -3612,8 +3608,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, { @@ -4274,26 +4269,7 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE" + "EXTERNAL_USE_SCHEMA" ] }, { @@ -5038,8 +5014,7 @@ "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" ] }, { @@ -5494,8 +5469,7 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER", - "UPGRADING" + "FAILING_OVER" ] }, { @@ -5795,8 +5769,7 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP", - "UNSPECIFIED" + "CAN_CREATE_APP" ] }, { @@ -8513,8 +8486,7 @@ "EXCEL", "PARQUET", "AVRO", - "ORC", - "FILE" + "ORC" ] }, { @@ -8661,9 +8633,7 @@ "enum": [ "FILE", "FILE_METADATA", - "PERMISSION", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "PERMISSION" ] }, { @@ -8886,8 +8856,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -8904,86 +8872,7 @@ "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" ] }, @@ -9824,9 +9713,7 @@ "FILE", "FILE_METADATA", "PERMISSION", - "LIST", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "LIST" ] }, { @@ -10134,9 +10021,7 @@ "type": "string", "enum": [ "STRING", - "JSON", - "AVRO", - "PROTOBUF" + "JSON" ] }, { @@ -11749,8 +11634,7 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO", - "REYDEN" + "PRO" ] }, { @@ -11986,8 +11870,7 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD", - "STANDARD_ON_ORION" + "STANDARD" ] }, { diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index b73dffba58a..2e8db1c3836 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -125,8 +125,6 @@ "git_source": { "description": "Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit)\nto use when deploying the app. Used in conjunction with git_repository to deploy code directly from git.\nThe source_code_path within git_source specifies the relative path to the app code within the repository.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.290.0" }, "lifecycle": { @@ -150,8 +148,6 @@ }, "source_code_path": { "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.239.0" }, "space": { @@ -3391,8 +3387,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, "apps.ComputeState": { @@ -3897,26 +3892,7 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE" + "EXTERNAL_USE_SCHEMA" ] }, "catalog.PrivilegeAssignment": { @@ -4538,8 +4514,7 @@ "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" ] }, "compute.InitScriptInfo": { @@ -4890,8 +4865,7 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER", - "UPGRADING" + "FAILING_OVER" ] }, "database.DeltaTableSyncInfo": { @@ -5085,8 +5059,7 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP", - "UNSPECIFIED" + "CAN_CREATE_APP" ] }, "jobs.AlertTask": { @@ -7315,8 +7288,7 @@ "EXCEL", "PARQUET", "AVRO", - "ORC", - "FILE" + "ORC" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7417,9 +7389,7 @@ "enum": [ "FILE", "FILE_METADATA", - "PERMISSION", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "PERMISSION" ] }, "pipelines.IngestionConfig": { @@ -7613,8 +7583,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -7631,86 +7599,7 @@ "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" ] }, @@ -8423,9 +8312,7 @@ "FILE", "FILE_METADATA", "PERMISSION", - "LIST", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "LIST" ] }, "pipelines.SmartsheetOptions": { @@ -8677,9 +8564,7 @@ "type": "string", "enum": [ "STRING", - "JSON", - "AVRO", - "PROTOBUF" + "JSON" ] }, "pipelines.ZendeskSupportOptions": { @@ -9966,8 +9851,7 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO", - "REYDEN" + "PRO" ] }, "sql.CronSchedule": { @@ -10136,8 +10020,7 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD", - "STANDARD_ON_ORION" + "STANDARD" ] }, "vectorsearch.IndexSubtype": { diff --git a/internal/cligen/cli_json_test.go b/internal/cligen/cli_json_test.go new file mode 100644 index 00000000000..c252be12b1e --- /dev/null +++ b/internal/cligen/cli_json_test.go @@ -0,0 +1,142 @@ +package main + +import ( + "encoding/json" + "errors" + goformat "go/format" + "os" + "regexp" + "strings" + "testing" +) + +// cliJSONPath is the checked-in contract instance, relative to this package. +const cliJSONPath = "../../.codegen/cli.json" + +// fullDoc decodes every block of cli.json that the CLI cares about. The schemas +// block is consumed by the Python direct-engine generators; here we only need +// enough of it to assert structural invariants (keys + field refs). +type fullDoc struct { + Metadata struct { + OpenAPISha string `json:"openapi_sha"` + GeneratorVersion string `json:"generator_version"` + } `json:"metadata"` + Schemas map[string]schemaDoc `json:"schemas"` + Commands *CommandsBlock `json:"commands"` +} + +type schemaDoc struct { + Fields map[string]struct { + Ref string `json:"ref"` + } `json:"fields"` +} + +var shaRE = regexp.MustCompile(`^[0-9a-f]{40}$`) + +// TestCliJSONIsInterpretable loads the committed cli.json and asserts the CLI +// can interpret it: it decodes into the CLI's model, its cross-references +// resolve, its contents satisfy the invariants the renderer relies on, and +// every service + batch file renders to syntactically valid Go. This is the +// CLI-repo-side confirmation that the cli.json spec is consumable. +func TestCliJSONIsInterpretable(t *testing.T) { + raw, err := os.ReadFile(cliJSONPath) + if err != nil { + t.Fatalf("read %s: %v", cliJSONPath, err) + } + + var doc fullDoc + if err := json.Unmarshal(raw, &doc); err != nil { + t.Fatalf("decode cli.json: %v", err) + } + + // --- metadata --- + if doc.Metadata.GeneratorVersion != "cliv1" { + t.Errorf("metadata.generator_version = %q, want %q", doc.Metadata.GeneratorVersion, "cliv1") + } + if !shaRE.MatchString(doc.Metadata.OpenAPISha) { + t.Errorf("metadata.openapi_sha = %q, want a 40-char sha", doc.Metadata.OpenAPISha) + } + + // --- schemas block: non-empty, and every field ref points at a known schema --- + if len(doc.Schemas) == 0 { + t.Fatal("schemas block is empty") + } + for name, s := range doc.Schemas { + for fname, f := range s.Fields { + if f.Ref != "" { + if _, ok := doc.Schemas[f.Ref]; !ok { + t.Errorf("schema %s.%s: ref %q points at a missing schema", name, fname, f.Ref) + } + } + } + } + + // --- commands block: present, resolvable, internally consistent --- + if doc.Commands == nil { + t.Fatal("commands block is nil") + } + cmds := doc.Commands + cmds.Resolve() + if len(cmds.Services) == 0 { + t.Fatal("commands has no services") + } + + for _, s := range cmds.Services { + if s.Name == "" { + t.Errorf("service %q has empty name", s.ID) + } + if s.Package == nil || s.Package.Name == "" { + t.Errorf("service %s has no package name", s.Name) + } + if s.ParentServiceID != "" && s.ParentService == nil { + t.Errorf("service %s: parent_service_id %q did not resolve", s.Name, s.ParentServiceID) + } + if len(s.Subservices) != len(s.SubserviceIDs) { + t.Errorf("service %s: %d subservice ids but %d resolved", s.Name, len(s.SubserviceIDs), len(s.Subservices)) + } + for _, m := range s.Methods { + if m.Name == "" { + t.Errorf("service %s has a method with empty name", s.Name) + } + } + } + + // --- interpretation proof: every file renders to valid Go --- + serviceTmpl := parseTemplate("service", "templates/service.go.tmpl") + rendered := 0 + for _, svc := range cmds.Services { + var sb strings.Builder + err := serviceTmpl.ExecuteTemplate(&sb, "service.go.tmpl", svc) + if errors.Is(err, ErrSkipThisFile) { + continue + } + if err != nil { + t.Errorf("render service %s: %v", svc.Name, err) + continue + } + if _, err := goformat.Source([]byte(sb.String())); err != nil { + t.Errorf("service %s rendered invalid Go: %v", svc.Name, err) + } + rendered++ + } + if rendered == 0 { + t.Fatal("no services rendered") + } + + for _, bf := range []struct{ name, path string }{ + {"cmds-workspace.go.tmpl", "templates/cmds-workspace.go.tmpl"}, + {"groups-workspace.go.tmpl", "templates/groups-workspace.go.tmpl"}, + {"cmds-account.go.tmpl", "templates/cmds-account.go.tmpl"}, + {"groups-account.go.tmpl", "templates/groups-account.go.tmpl"}, + } { + var sb strings.Builder + tmpl := parseTemplate(bf.name, bf.path) + if err := tmpl.ExecuteTemplate(&sb, bf.name, cmds); err != nil { + t.Errorf("render %s: %v", bf.name, err) + continue + } + if _, err := goformat.Source([]byte(sb.String())); err != nil { + t.Errorf("%s rendered invalid Go: %v", bf.name, err) + } + } +} diff --git a/internal/cligen/cligen.go b/internal/cligen/cligen.go new file mode 100644 index 00000000000..37167a74b1a --- /dev/null +++ b/internal/cligen/cligen.go @@ -0,0 +1,151 @@ +// Package cligen regenerates the CLI command stubs (cmd/workspace/** and +// cmd/account/**) from the cli.json spec produced by genkit. +// +// It is the CLI-owned replacement for running genkit's cli_v0 generator against +// a universe checkout: it renders the same templates (templates/*.tmpl, copied +// verbatim) against a model decoded from cli.json's "commands" block. It has no +// dependency on genkit or any upstream spec at run time. +package main + +import ( + "encoding/json" + "errors" + "flag" + "fmt" + "log" + "os" + "os/exec" + "path/filepath" + "slices" + "strings" +) + +func main() { + input := flag.String("input", ".codegen/cli.json", "path to the cli.json spec") + output := flag.String("output", ".", "target directory (CLI repo root)") + flag.Parse() + + files, err := Generate(*input, *output) + if err != nil { + log.Fatalf("cligen: %v", err) + } + if err := format(*output, files); err != nil { + log.Fatalf("cligen: format: %v", err) + } + if err := writeGitAttributes(*output, files); err != nil { + log.Fatalf("cligen: .gitattributes: %v", err) + } + for _, f := range files { + fmt.Println(f) + } +} + +// writeGitAttributes writes .gitattributes marking the generated command files +// as linguist-generated, mirroring genkit: the header comment comes from the +// hand-maintained .gitattributes.manual, followed by the sorted file list. +func writeGitAttributes(dir string, files []string) error { + header, err := os.ReadFile(filepath.Join(dir, ".gitattributes.manual")) + if err != nil { + return err + } + sorted := append([]string(nil), files...) + slices.Sort(sorted) + var sb strings.Builder + sb.Write(header) + for _, f := range sorted { + sb.WriteString(f) + sb.WriteString(" linguist-generated=true\n") + } + return os.WriteFile(filepath.Join(dir, ".gitattributes"), []byte(sb.String()), 0o644) +} + +// format applies the same formatter genkit's cli_v0 generator used to produce +// the committed command files: goimports (prunes the conditionally-unused +// imports the template always emits, e.g. "time") followed by gofmt. +func format(dir string, files []string) error { + abs := make([]string, len(files)) + for i, f := range files { + abs[i] = filepath.Join(dir, f) + } + // Run goimports from the pinned tools module (tools/go.mod) instead of + // @latest, so generation is deterministic and works offline. + modfile := filepath.Join(dir, "tools", "go.mod") + goimports := append([]string{"tool", "-modfile=" + modfile, "goimports", "-w"}, abs...) + if out, err := exec.Command("go", goimports...).CombinedOutput(); err != nil { + return fmt.Errorf("goimports: %v\n%s", err, out) + } + if out, err := exec.Command("gofmt", append([]string{"-w"}, abs...)...).CombinedOutput(); err != nil { + return fmt.Errorf("gofmt: %v\n%s", err, out) + } + return nil +} + +// cliJSON is the subset of the cli.json contract that command generation needs. +type cliJSON struct { + Commands *CommandsBlock `json:"commands"` +} + +// Generate reads the cli.json spec at jsonPath and writes the command stubs +// under targetDir. It returns the list of files written (relative to targetDir). +func Generate(jsonPath, targetDir string) ([]string, error) { + raw, err := os.ReadFile(jsonPath) + if err != nil { + return nil, err + } + var doc cliJSON + if err := json.Unmarshal(raw, &doc); err != nil { + return nil, fmt.Errorf("parse %s: %w", jsonPath, err) + } + if doc.Commands == nil { + return nil, fmt.Errorf("%s: missing \"commands\" block", jsonPath) + } + batch := doc.Commands + batch.Resolve() + + var filenames []string + + // Batch-level files (mirrors cliv0.Apply order). + batchFiles := []struct { + tmplName string + tmplFile string + out string + }{ + {"cmds-workspace.go.tmpl", "templates/cmds-workspace.go.tmpl", "cmd/workspace/cmd.go"}, + {"groups-workspace.go.tmpl", "templates/groups-workspace.go.tmpl", "cmd/workspace/groups.go"}, + {"cmds-account.go.tmpl", "templates/cmds-account.go.tmpl", "cmd/account/cmd.go"}, + {"groups-account.go.tmpl", "templates/groups-account.go.tmpl", "cmd/account/groups.go"}, + } + for _, bf := range batchFiles { + t := parseTemplate(bf.tmplName, bf.tmplFile) + if err := renderToFile(batch, t, bf.tmplName, filepath.Join(targetDir, bf.out)); err != nil { + return nil, fmt.Errorf("render %s: %w", bf.out, err) + } + filenames = append(filenames, bf.out) + } + + // Per-service files. + serviceTmpl := parseTemplate("service", "templates/service.go.tmpl") + for _, svc := range batch.Services { + out := serviceFilename(svc) + err := renderToFile(svc, serviceTmpl, "service.go.tmpl", filepath.Join(targetDir, out)) + if errors.Is(err, ErrSkipThisFile) { + continue + } + if err != nil { + return nil, fmt.Errorf("render %s: %w", out, err) + } + filenames = append(filenames, out) + } + + return filenames, nil +} + +// serviceFilename mirrors cliv0/service.go: account services go under +// cmd/account//.go, everything else under cmd/workspace/. +func serviceFilename(s *ServiceJSON) string { + name := s.TrimPrefix("account").KebabName + if s.IsAccounts { + return fmt.Sprintf("cmd/account/%s/%s.go", name, name) + } + return fmt.Sprintf("cmd/workspace/%s/%s.go", name, name) +} diff --git a/internal/cligen/comment.go b/internal/cligen/comment.go new file mode 100644 index 00000000000..016cabbe8c2 --- /dev/null +++ b/internal/cligen/comment.go @@ -0,0 +1,96 @@ +package main + +import ( + "fmt" + "regexp" + "slices" + "strings" +) + +// This file is a faithful copy of the comment/summary helpers from genkit's +// codegen/code/named.go. The CLI owns this rendering logic so that command +// stubs can be regenerated from cli.json without depending on genkit. The +// cli.json spec carries raw Name/Description/Summary; the wrapping below must +// match genkit byte-for-byte. + +var whitespace = regexp.MustCompile(`\s+`) + +// markdownLink matches markdown links, ignoring new lines. +var markdownLink = regexp.MustCompile(`\[([^\]]+)\]\(([^\)]+)\)`) + +// sentences splits a description into sentences on ". ", normalizing whitespace. +func sentences(description string) []string { + if description == "" { + return []string{} + } + norm := whitespace.ReplaceAllString(description, " ") + trimmed := strings.TrimSpace(norm) + return strings.Split(trimmed, ". ") +} + +// summarize returns the first sentence from the description, always ending in a +// dot. Mirrors Named.Summary in genkit. +func summarize(description string) string { + s := sentences(description) + if len(s) > 0 { + return strings.TrimSuffix(s[0], ".") + "." + } + return "" +} + +// commentWrap formats a description into a language-specific multi-line comment. +// Mirrors Named.Comment(prefix, maxLen) in genkit. +func commentWrap(description, prefix string, maxLen int) string { + if description == "" { + return "" + } + trimmed := strings.TrimSpace(description) + // Collect links, which are later sorted and appended at the bottom. + links := map[string]string{} + for _, m := range markdownLink.FindAllStringSubmatch(trimmed, -1) { + label := strings.TrimSpace(m[1]) + link := strings.TrimSpace(m[2]) + if !strings.HasPrefix(link, "http") { + // This condition is here until the spec normalizes all links. + continue + } + // Overriding links handles duplicates and yields alphabetical ordering below. + links[label] = link + // Replace [text](url) with [text]. + trimmed = strings.ReplaceAll(trimmed, m[0], fmt.Sprintf("[%s]", label)) + } + var linksInBottom []string + for k, v := range links { + linksInBottom = append(linksInBottom, fmt.Sprintf("[%s]: %s", k, v)) + } + slices.Sort(linksInBottom) + // Fix new-line characters. + trimmed = strings.ReplaceAll(trimmed, "\\n", "\n") + description = strings.ReplaceAll(trimmed, "\n\n", " __BLANK__ ") + var lines []string + currentLine := strings.Builder{} + for _, v := range whitespace.Split(description, -1) { + if v == "__BLANK__" { + lines = append(lines, currentLine.String()) + lines = append(lines, "") + currentLine.Reset() + continue + } + if len(prefix)+currentLine.Len()+len(v)+1 > maxLen { + lines = append(lines, currentLine.String()) + currentLine.Reset() + } + if currentLine.Len() > 0 { + currentLine.WriteRune(' ') + } + currentLine.WriteString(v) + } + if currentLine.Len() > 0 { + lines = append(lines, currentLine.String()) + currentLine.Reset() + } + if len(linksInBottom) > 0 { + lines = append(append(lines, ""), linksInBottom...) + } + return strings.TrimLeft(prefix, "\t ") + strings.Join(lines, "\n"+prefix) +} diff --git a/internal/cligen/model.go b/internal/cligen/model.go new file mode 100644 index 00000000000..fcc8229ac95 --- /dev/null +++ b/internal/cligen/model.go @@ -0,0 +1,330 @@ +package main + +import "fmt" + +// This file defines the CLI-side view of the "commands" block of the cli.json +// spec. The structs mirror, field-for-field, the dot-paths that +// the cliv0 templates (templates/*.tmpl, copied verbatim from genkit) access. +// +// Design rules that keep output byte-for-byte identical to genkit: +// - Casings (Kebab/Pascal/Snake/Camel/Constant/Title) are PRE-RESOLVED by the +// producer using genkit's own name functions and stored as plain strings. +// - Comment-derived text (Summary, Comment, CliComment, HasComment) is NOT +// stored. It is derived here from the raw Description with the same pure +// helpers genkit uses (see comment.go), so it cannot drift. +// - Cross-references that form cycles in genkit's graph (ParentService, +// Subservices, RequestBodyField identity) are carried by name/reference and +// re-linked in Resolve() after decoding. + +// CommandsBlock is the batch-level root of the commands section. +type CommandsBlock struct { + Services []*ServiceJSON `json:"services,omitempty"` + WorkspaceDocsGroups []*DocsGroupJSON `json:"workspace_docs_groups,omitempty"` + AccountDocsGroups []*DocsGroupJSON `json:"account_docs_groups,omitempty"` + + byID map[string]*ServiceJSON +} + +// DocsGroupJSON is the docs-group shape read by groups-*.go.tmpl. +type DocsGroupJSON struct { + Key string `json:"key,omitempty"` + DisplayName string `json:"display_name,omitempty"` +} + +// NameVariants is the value returned by (Service|Method).TrimPrefix; templates +// access its SnakeName/KebabName/PascalName fields. +type NameVariants struct { + SnakeName string `json:"snake_name,omitempty"` + KebabName string `json:"kebab_name,omitempty"` + PascalName string `json:"pascal_name,omitempty"` +} + +// PackageRef backs .Package.Name. +type PackageRef struct { + Name string `json:"name,omitempty"` +} + +// PascalRef is a thin reference carrying only PascalName (e.g. request types). +type PascalRef struct { + PascalName string `json:"pascal_name,omitempty"` +} + +// NamedIdMapJSON backs $.List.NamedIdMap.PascalName. +type NamedIdMapJSON struct { + PascalName string `json:"pascal_name,omitempty"` +} + +// EnumEntryJSON backs printArray / supportedValues / wait success states. +type EnumEntryJSON struct { + Content string `json:"content,omitempty"` +} + +// ServiceListRefJSON is the slimmed view of a service's List method that the +// template reads via $.List (NamedIdMap, IsLegacyEmptyRequest, Request). +type ServiceListRefJSON struct { + NamedIdMap *NamedIdMapJSON `json:"named_id_map,omitempty"` + IsLegacyEmptyRequest bool `json:"is_legacy_empty_request,omitempty"` + Request *PascalRef `json:"request,omitempty"` +} + +// ServiceJSON is the render context for service.go.tmpl. +type ServiceJSON struct { + ID string `json:"id,omitempty"` + + Name string `json:"name,omitempty"` + + Description string `json:"description,omitempty"` + Package *PackageRef `json:"package,omitempty"` + + IsAccounts bool `json:"is_accounts,omitempty"` + HasParent bool `json:"has_parent,omitempty"` + IsDataPlane bool `json:"is_data_plane,omitempty"` + HasSubservices bool `json:"has_subservices,omitempty"` + IsHiddenCLI bool `json:"is_hidden_cli,omitempty"` + + DocsGroup string `json:"docs_group,omitempty"` + + LaunchStage string `json:"launch_stage,omitempty"` + CLILaunchStageLabel string `json:"cli_launch_stage_label,omitempty"` + CLILaunchStageBanner string `json:"cli_launch_stage_banner,omitempty"` + CLILaunchStageDisplay string `json:"cli_launch_stage_display,omitempty"` + + ParentServiceID string `json:"parent_service_id,omitempty"` + SubserviceIDs []string `json:"subservice_ids,omitempty"` + List *ServiceListRefJSON `json:"list,omitempty"` + Methods []*MethodJSON `json:"methods,omitempty"` + + // Re-linked in Resolve(). + ParentService *ServiceJSON `json:"-"` + Subservices []*ServiceJSON `json:"-"` +} + +// Casing methods derive from Name via the ported genkit name functions +// (names.go), so the producer doesn't denormalize every variant into cli.json. +func (s *ServiceJSON) KebabName() string { return kebabName(s.Name) } +func (s *ServiceJSON) SnakeName() string { return snakeName(s.Name) } +func (s *ServiceJSON) PascalName() string { return pascalName(s.Name) } +func (s *ServiceJSON) TitleName() string { return titleName(s.Name) } + +// TrimPrefix mirrors genkit Named.TrimPrefix: trim the prefix from the +// camel-cased name, then expose the casings of the result. +func (s *ServiceJSON) TrimPrefix(prefix string) NameVariants { + tn := trimPrefixName(s.Name, prefix) + return NameVariants{SnakeName: snakeName(tn), KebabName: kebabName(tn), PascalName: pascalName(tn)} +} + +// Summary is the first sentence of the description; matches genkit Named.Summary. +func (s *ServiceJSON) Summary() string { return summarize(s.Description) } + +// Comment wraps the description into a multi-line comment; matches Named.Comment. +func (s *ServiceJSON) Comment(prefix string, maxLen int) string { + return commentWrap(s.Description, prefix, maxLen) +} + +// MethodJSON is the render context for one command (a method of a service). +type MethodJSON struct { + Name string `json:"name,omitempty"` + + Description string `json:"description,omitempty"` + // Summary is the method's own summary, pre-resolved by the producer (unlike + // Service/Field, Method.Summary() reads a separate field, not the first + // sentence of the description). + Summary string `json:"summary,omitempty"` + Path string `json:"path,omitempty"` + + IsLegacyEmptyRequest bool `json:"is_legacy_empty_request,omitempty"` + CanUseJson bool `json:"can_use_json,omitempty"` + MustUseJson bool `json:"must_use_json,omitempty"` + IsJsonOnly bool `json:"is_json_only,omitempty"` + IsCrudCreate bool `json:"is_crud_create,omitempty"` + IsCrudRead bool `json:"is_crud_read,omitempty"` + IsHiddenCLI bool `json:"is_hidden_cli,omitempty"` + IsResponseByteStream bool `json:"is_response_byte_stream,omitempty"` + HasRequiredPositionalArguments bool `json:"has_required_positional_arguments,omitempty"` + + LaunchStage string `json:"launch_stage,omitempty"` + CLILaunchStageLabel string `json:"cli_launch_stage_label,omitempty"` + CLILaunchStageBanner string `json:"cli_launch_stage_banner,omitempty"` + CLILaunchStageDisplay string `json:"cli_launch_stage_display,omitempty"` + + Request *EntityJSON `json:"request,omitempty"` + RequestBodyField *FieldJSON `json:"request_body_field,omitempty"` + Response *EntityJSON `json:"response,omitempty"` + ResponseBodyField *PascalRef `json:"response_body_field,omitempty"` + + AllFields []*FieldJSON `json:"all_fields,omitempty"` + RequiredPositionalArguments []*FieldJSON `json:"required_positional_arguments,omitempty"` + + Pagination *PaginationJSON `json:"pagination,omitempty"` + Wait *WaitJSON `json:"wait,omitempty"` + LongRunningOperation *LROJSON `json:"long_running_operation,omitempty"` +} + +func (m *MethodJSON) KebabName() string { return kebabName(m.Name) } +func (m *MethodJSON) SnakeName() string { return snakeName(m.Name) } +func (m *MethodJSON) PascalName() string { return pascalName(m.Name) } +func (m *MethodJSON) CamelName() string { return camelName(m.Name) } + +// CliComment mirrors genkit Method.CliComment (method.go:139): prepend the +// summary as its own paragraph when it differs from the description. Summary is +// a pre-resolved field (see the struct), not derived from the description. +func (m *MethodJSON) CliComment(prefix string, maxLen int) string { + description := m.Description + if m.Summary != "" && m.Summary != m.Description { + description = fmt.Sprintf("%s\n\n%s", m.Summary, description) + } + return commentWrap(description, prefix, maxLen) +} + +// FieldJSON is one request field (flag or positional argument). +type FieldJSON struct { + Name string `json:"name,omitempty"` + + Description string `json:"description,omitempty"` + + Required bool `json:"required,omitempty"` + IsPath bool `json:"is_path,omitempty"` + IsQuery bool `json:"is_query,omitempty"` + IsComputed bool `json:"is_computed,omitempty"` + IsOutputOnly bool `json:"is_output_only,omitempty"` + IsRequestBodyField bool `json:"is_request_body_field,omitempty"` + IsOptionalObject bool `json:"is_optional_object,omitempty"` + + Entity *EntityJSON `json:"entity,omitempty"` +} + +func (f *FieldJSON) KebabName() string { return kebabName(f.Name) } +func (f *FieldJSON) PascalName() string { return pascalName(f.Name) } +func (f *FieldJSON) CamelName() string { return camelName(f.Name) } +func (f *FieldJSON) ConstantName() string { return constantName(f.Name) } + +// Summary matches genkit Named.Summary. +func (f *FieldJSON) Summary() string { return summarize(f.Description) } + +// HasComment matches genkit Named.HasComment. +func (f *FieldJSON) HasComment() bool { return f.Description != "" } + +// Comment wraps the description; matches Named.Comment. +func (f *FieldJSON) Comment(prefix string, maxLen int) string { + return commentWrap(f.Description, prefix, maxLen) +} + +// EntityJSON is a value type (message, primitive, enum, array, map). The same +// struct backs both request entities (which expose required-field collections) +// and leaf field types (which expose only type predicates). +type EntityJSON struct { + PascalName string `json:"pascal_name,omitempty"` + + IsObject bool `json:"is_object,omitempty"` + IsAny bool `json:"is_any,omitempty"` + IsString bool `json:"is_string,omitempty"` + IsBool bool `json:"is_bool,omitempty"` + IsInt bool `json:"is_int,omitempty"` + IsInt64 bool `json:"is_int64,omitempty"` + IsFloat64 bool `json:"is_float64,omitempty"` + IsDuration bool `json:"is_duration,omitempty"` + IsTimestamp bool `json:"is_timestamp,omitempty"` + IsFieldMask bool `json:"is_field_mask,omitempty"` + + // IsEmptyResponse marks a response that carries nothing renderable + // (google.protobuf.Empty or a legacy named-but-fieldless response). + IsEmptyResponse bool `json:"is_empty_response,omitempty"` + + ArrayValue *EntityJSON `json:"array_value,omitempty"` + MapValue *EntityJSON `json:"map_value,omitempty"` + Enum []*EnumEntryJSON `json:"enum,omitempty"` + + HasFieldMask bool `json:"has_field_mask,omitempty"` + HasRequiredRequestBodyFields bool `json:"has_required_request_body_fields,omitempty"` + + RequiredFields []*FieldJSON `json:"required_fields,omitempty"` + RequiredInUrlFields []*FieldJSON `json:"required_in_url_fields,omitempty"` + RequiredRequestBodyFields []*FieldJSON `json:"required_request_body_fields,omitempty"` +} + +// PaginationJSON backs .Pagination. Pagination fields are matched against +// AllFields by Name in the template, so no pointer identity is required. +type PaginationJSON struct { + Token *TokenJSON `json:"token,omitempty"` + Offset *FieldJSON `json:"offset,omitempty"` + Limit *FieldJSON `json:"limit,omitempty"` + MaxResults *FieldJSON `json:"max_results,omitempty"` +} + +// TokenJSON backs .Pagination.Token; only PollField is read. +type TokenJSON struct { + PollField *FieldJSON `json:"poll_field,omitempty"` +} + +// FieldRef is a thin reference for wait status/message path elements. +type FieldRef struct { + PascalName string `json:"pascal_name,omitempty"` +} + +// WaitJSON backs .Wait. Cross-references to the poll method are flattened to +// the only datum templates read (its response type's PascalName). +type WaitJSON struct { + Success []*EnumEntryJSON `json:"success,omitempty"` + Timeout int `json:"timeout,omitempty"` + ComplexMessagePath bool `json:"complex_message_path,omitempty"` + Poll *PollJSON `json:"poll,omitempty"` + StatusPath []*FieldRef `json:"status_path,omitempty"` + MessagePath []*FieldRef `json:"message_path,omitempty"` + MessagePathHead *FieldRef `json:"message_path_head,omitempty"` +} + +// PollJSON backs .Wait.Poll.Response.PascalName. +type PollJSON struct { + Response *PascalRef `json:"response,omitempty"` +} + +// LROJSON backs .LongRunningOperation. +type LROJSON struct { + GetOperation *LROMethodRef `json:"get_operation,omitempty"` + ResponseType *EntityRef `json:"response_type,omitempty"` +} + +// LROMethodRef backs .LongRunningOperation.GetOperation.{KebabName,PascalName,Request.PascalName}. +type LROMethodRef struct { + KebabName string `json:"kebab_name,omitempty"` + PascalName string `json:"pascal_name,omitempty"` + Request *PascalRef `json:"request,omitempty"` +} + +// EntityRef backs .LongRunningOperation.ResponseType.IsEmptyResponse. +type EntityRef struct { + IsEmptyResponse bool `json:"is_empty_response,omitempty"` +} + +// Resolve re-links cross-references after JSON decoding: builds the service +// index, wires ParentService/Subservices pointers, and restores the pointer +// identity between each method's RequestBodyField and its AllFields entry (the +// service.go.tmpl `eq . $method.RequestBodyField` check relies on identity). +func (c *CommandsBlock) Resolve() { + c.byID = make(map[string]*ServiceJSON, len(c.Services)) + for _, s := range c.Services { + c.byID[s.ID] = s + } + for _, s := range c.Services { + if s.ParentServiceID != "" { + s.ParentService = c.byID[s.ParentServiceID] + } + s.Subservices = s.Subservices[:0] + for _, id := range s.SubserviceIDs { + if sub := c.byID[id]; sub != nil { + s.Subservices = append(s.Subservices, sub) + } + } + for _, m := range s.Methods { + if m.RequestBodyField == nil { + continue + } + for _, f := range m.AllFields { + if f.Name == m.RequestBodyField.Name { + m.RequestBodyField = f + break + } + } + } + } +} diff --git a/internal/cligen/names.go b/internal/cligen/names.go new file mode 100644 index 00000000000..2db0eb9cd41 --- /dev/null +++ b/internal/cligen/names.go @@ -0,0 +1,151 @@ +package main + +import ( + "strings" + "unicode" +) + +// This file ports genkit's pure name-casing functions (codegen/code/named.go) +// so the CLI can derive kebab/snake/pascal/camel/constant/title casings from a +// single stored `name`, instead of the producer denormalizing every variant +// into cli.json. The port must match genkit byte-for-byte; names_test.go +// asserts that against a cli.json that still carries the stored casings. + +// title mirrors strings.Title for the ASCII words splitASCII emits: it +// uppercases each letter that follows a non-letter (or the start). Implemented +// directly to avoid the deprecated strings.Title and stay lint-clean. +func title(s string) string { + out := []rune(s) + prevIsLetter := false + for i, r := range out { + if !prevIsLetter && unicode.IsLetter(r) { + out[i] = unicode.ToUpper(r) + } + prevIsLetter = unicode.IsLetter(r) + } + return string(out) +} + +func searchNearest(name string, cond func(rune) bool, forward bool, i int) bool { + incr := 1 + if !forward { + incr = -1 + } + for j := i; j >= 0 && j < len(name); j += incr { + if unicode.IsLetter(rune(name[j])) { + return cond(rune(name[j])) + } + } + return false +} + +func condAtNearestLetters(name string, cond func(rune) bool, i int) bool { + r := rune(name[i]) + if unicode.IsLetter(r) { + return cond(r) + } + return searchNearest(name, cond, true, i) && searchNearest(name, cond, false, i) +} + +// splitASCII is a faithful port of genkit Named.splitASCII: it splits a name +// into lowercased words at case boundaries and separators, emulating the JVM +// lookahead regex genkit documents. +func splitASCII(name string) (w []string) { + var current []rune + nameLen := len(name) + var isPrevUpper bool + for i := range nameLen { + r := rune(name[i]) + if r == '$' { + continue + } + isCurrentUpper := condAtNearestLetters(name, unicode.IsUpper, i) + r = unicode.ToLower(r) + isNextLower := false + isNextUpper := false + isNotLastChar := i+1 < nameLen + if isNotLastChar { + isNextLower = condAtNearestLetters(name, unicode.IsLower, i+1) + isNextUpper = condAtNearestLetters(name, unicode.IsUpper, i+1) + } + split, before, after := false, false, true + if isPrevUpper && isCurrentUpper && isNextLower && isNotLastChar { + split = true + before = false + after = true + } + if !isCurrentUpper && isNextUpper { + split = true + before = true + after = false + } + if !unicode.IsLetter(r) && !unicode.IsNumber(r) { + split = true + before = false + after = false + } + if before { + current = append(current, r) + } + if split && len(current) > 0 { + w = append(w, string(current)) + current = []rune{} + } + if after { + current = append(current, r) + } + isPrevUpper = isCurrentUpper + } + if len(current) > 0 { + w = append(w, string(current)) + } + return w +} + +func pascalName(name string) string { + var sb strings.Builder + for _, w := range splitASCII(name) { + sb.WriteString(title(w)) + } + return sb.String() +} + +func titleName(name string) string { + words := splitASCII(name) + for i, w := range words { + words[i] = title(w) + } + return strings.Join(words, " ") +} + +func camelName(name string) string { + if name == "" { + return "" + } + if name == "_" { + return "_" + } + cc := pascalName(name) + return strings.ToLower(cc[0:1]) + cc[1:] +} + +func snakeName(name string) string { + if name == "_" { + return "_" + } + return strings.Join(splitASCII(name), "_") +} + +func constantName(name string) string { + return strings.ToUpper(snakeName(name)) +} + +func kebabName(name string) string { + return strings.Join(splitASCII(name), "-") +} + +// trimPrefixName mirrors Named.TrimPrefix: trims the prefix from the camel-cased +// name and returns the resulting bare name (whose casings are derived as usual). +func trimPrefixName(name, prefix string) string { + return strings.TrimPrefix(camelName(name), prefix) +} diff --git a/internal/cligen/names_test.go b/internal/cligen/names_test.go new file mode 100644 index 00000000000..f33b552377f --- /dev/null +++ b/internal/cligen/names_test.go @@ -0,0 +1,55 @@ +package main + +import "testing" + +// TestNameCasings guards the ported genkit name functions (names.go). The +// producer no longer denormalizes casings into cliv1.json; cligen derives them +// from the stored name, so these must match genkit exactly. The values below +// were validated against genkit's output for all named objects in cliv1.json +// before the stored casings were dropped. +func TestNameCasings(t *testing.T) { + cases := []struct { + name, kebab, snake, pascal, camel, constant, title string + }{ + {"JobSettings", "job-settings", "job_settings", "JobSettings", "jobSettings", "JOB_SETTINGS", "Job Settings"}, + {"Workspace", "workspace", "workspace", "Workspace", "workspace", "WORKSPACE", "Workspace"}, + {"IpAccessLists", "ip-access-lists", "ip_access_lists", "IpAccessLists", "ipAccessLists", "IP_ACCESS_LISTS", "Ip Access Lists"}, + {"IamV2", "iam-v2", "iam_v2", "IamV2", "iamV2", "IAM_V2", "Iam V2"}, + {"create_run", "create-run", "create_run", "CreateRun", "createRun", "CREATE_RUN", "Create Run"}, + } + for _, c := range cases { + if got := kebabName(c.name); got != c.kebab { + t.Errorf("kebabName(%q) = %q, want %q", c.name, got, c.kebab) + } + if got := snakeName(c.name); got != c.snake { + t.Errorf("snakeName(%q) = %q, want %q", c.name, got, c.snake) + } + if got := pascalName(c.name); got != c.pascal { + t.Errorf("pascalName(%q) = %q, want %q", c.name, got, c.pascal) + } + if got := camelName(c.name); got != c.camel { + t.Errorf("camelName(%q) = %q, want %q", c.name, got, c.camel) + } + if got := constantName(c.name); got != c.constant { + t.Errorf("constantName(%q) = %q, want %q", c.name, got, c.constant) + } + if got := titleName(c.name); got != c.title { + t.Errorf("titleName(%q) = %q, want %q", c.name, got, c.title) + } + } +} + +// TestTrimPrefix guards Named.TrimPrefix("account") used for account services. +func TestTrimPrefix(t *testing.T) { + cases := []struct{ name, want string }{ + {"AccountMetastoreAssignments", "metastore-assignments"}, + {"AccountStorageCredentials", "storage-credentials"}, + {"Workspaces", "workspaces"}, // no "account" prefix: unchanged + } + for _, c := range cases { + tn := trimPrefixName(c.name, "account") + if got := kebabName(tn); got != c.want { + t.Errorf("kebabName(trimPrefix(%q,\"account\")) = %q, want %q", c.name, got, c.want) + } + } +} diff --git a/internal/cligen/render.go b/internal/cligen/render.go new file mode 100644 index 00000000000..ba21185068a --- /dev/null +++ b/internal/cligen/render.go @@ -0,0 +1,80 @@ +package main + +import ( + "embed" + "errors" + "fmt" + "os" + "path/filepath" + "strings" + "text/template" +) + +//go:embed templates/*.tmpl +var templates embed.FS + +// ErrSkipThisFile is panicked by the skipThisFile template helper and recovered +// by callers to suppress generation of a file. Mirrors genkit's render package. +var ErrSkipThisFile = errors.New("skip generating this file") + +// helperFuncs holds the template helpers actually referenced by the cliv0 +// templates (templates/*.tmpl). It derives from genkit's render.HelperFuncs but +// drops every helper no template uses, so the set must stay in sync with the +// templates: an unreferenced helper here is dead, and a referenced-but-missing +// one fails rendering loudly. +var helperFuncs = template.FuncMap{ + "lower": strings.ToLower, + "trimSuffix": func(right, left string) string { + return strings.TrimSuffix(left, right) + }, + "without": func(left, right string) string { + return strings.ReplaceAll(right, left, "") + }, + "skipThisFile": func() error { + // The error is rendered as a string in the resulting file, so we must + // panic and let callers handle it via errors.Is(err, ErrSkipThisFile). + panic(ErrSkipThisFile) + }, + "list": func(l ...any) []any { + return l + }, + "in": func(haystack []any, needle string) bool { + for _, v := range haystack { + if needle == fmt.Sprint(v) { + return true + } + } + return false + }, + "dict": func(args ...any) map[string]any { + if len(args)%2 != 0 { + panic("number of arguments to dict is not even") + } + result := map[string]any{} + for i := 0; i < len(args); i += 2 { + k := fmt.Sprint(args[i]) + v := args[i+1] + result[k] = v + } + return result + }, +} + +func parseTemplate(name, path string) *template.Template { + t := template.New(name).Funcs(helperFuncs) + return template.Must(t.ParseFS(templates, path)) +} + +// renderToFile renders the named template with data to fileName. It mirrors +// genkit's render.RenderToFile: a skipThisFile panic surfaces as an error that +// callers match with errors.Is(err, ErrSkipThisFile). +func renderToFile(data any, t *template.Template, templateName, fileName string) error { + sb := strings.Builder{} + if err := t.ExecuteTemplate(&sb, templateName, data); err != nil { + return err + } + if err := os.MkdirAll(filepath.Dir(fileName), 0o755); err != nil { + return err + } + return os.WriteFile(fileName, []byte(sb.String()), 0o644) +} diff --git a/internal/cligen/render_test.go b/internal/cligen/render_test.go new file mode 100644 index 00000000000..1525a28d439 --- /dev/null +++ b/internal/cligen/render_test.go @@ -0,0 +1,26 @@ +package main + +import "testing" + +// TestTemplatesParse ensures every copied template parses against helperFuncs. +// text/template requires every called function to be registered at parse time, +// so this fails fast if a template references a helper missing from helperFuncs. +func TestTemplatesParse(t *testing.T) { + cases := []struct{ name, path string }{ + {"service", "templates/service.go.tmpl"}, + {"cmds-workspace.go.tmpl", "templates/cmds-workspace.go.tmpl"}, + {"groups-workspace.go.tmpl", "templates/groups-workspace.go.tmpl"}, + {"cmds-account.go.tmpl", "templates/cmds-account.go.tmpl"}, + {"groups-account.go.tmpl", "templates/groups-account.go.tmpl"}, + } + for _, c := range cases { + t.Run(c.name, func(t *testing.T) { + defer func() { + if r := recover(); r != nil { + t.Fatalf("parsing %s panicked: %v", c.path, r) + } + }() + _ = parseTemplate(c.name, c.path) + }) + } +} diff --git a/internal/cligen/templates/cmds-account.go.tmpl b/internal/cligen/templates/cmds-account.go.tmpl new file mode 100644 index 00000000000..fe5ff582293 --- /dev/null +++ b/internal/cligen/templates/cmds-account.go.tmpl @@ -0,0 +1,32 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package account + +{{$excludes := list}} + +import ( + "github.com/databricks/cli/cmd/root" + "github.com/spf13/cobra" + {{range .Services}}{{if and .IsAccounts (not .HasParent) (not .IsDataPlane)}}{{if not (in $excludes .KebabName) }} + {{.SnakeName}} "github.com/databricks/cli/cmd/account/{{(.TrimPrefix "account").KebabName}}"{{end}}{{end}}{{end}} + + account_groups "github.com/databricks/cli/cmd/account/groups" + account_service_principals "github.com/databricks/cli/cmd/account/service-principals" + account_users "github.com/databricks/cli/cmd/account/users" +) + +func New() *cobra.Command { + cmd := &cobra.Command{ + Use: "account", + Short: `Databricks Account Commands`, + } + + {{range .Services}}{{if and .IsAccounts (not .HasParent) (not .IsDataPlane)}}{{if not (in $excludes .KebabName) -}} + cmd.AddCommand({{.SnakeName}}.New()) + {{end}}{{end}}{{end}} + cmd.AddCommand(account_groups.New()) + cmd.AddCommand(account_service_principals.New()) + cmd.AddCommand(account_users.New()) + + return cmd +} diff --git a/internal/cligen/templates/cmds-workspace.go.tmpl b/internal/cligen/templates/cmds-workspace.go.tmpl new file mode 100644 index 00000000000..9be2d927534 --- /dev/null +++ b/internal/cligen/templates/cmds-workspace.go.tmpl @@ -0,0 +1,36 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package workspace + +{{ $excludes := + list + "command-execution" + "statement-execution" + "dbfs" + "dbsql-permissions" + "account-access-control-proxy" + "files" +}} + +import ( + "github.com/databricks/cli/cmd/root" + {{range .Services}}{{if and (not .IsAccounts) (not .HasParent) (not .IsDataPlane)}}{{if not (in $excludes .KebabName) }} + {{.SnakeName}} "github.com/databricks/cli/cmd/workspace/{{.KebabName}}"{{end}}{{end}}{{end}} + + groups "github.com/databricks/cli/cmd/workspace/groups" + service_principals "github.com/databricks/cli/cmd/workspace/service-principals" + users "github.com/databricks/cli/cmd/workspace/users" +) + +func All() []*cobra.Command { + var out []*cobra.Command + + {{range .Services}}{{if and (not .IsAccounts) (not .HasParent) (not .IsDataPlane)}}{{if not (in $excludes .KebabName) -}} + out = append(out, {{.SnakeName}}.New()) + {{end}}{{end}}{{end}} + out = append(out, groups.New()) + out = append(out, service_principals.New()) + out = append(out, users.New()) + + return out +} diff --git a/internal/cligen/templates/groups-account.go.tmpl b/internal/cligen/templates/groups-account.go.tmpl new file mode 100644 index 00000000000..7aad9730fc4 --- /dev/null +++ b/internal/cligen/templates/groups-account.go.tmpl @@ -0,0 +1,18 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package account + +import ( + "github.com/spf13/cobra" +) + +func Groups() []cobra.Group { + return []cobra.Group{ +{{- range .AccountDocsGroups}} + { + ID: "{{.Key}}", + Title: "{{.DisplayName}}", + }, +{{- end}} + } +} diff --git a/internal/cligen/templates/groups-workspace.go.tmpl b/internal/cligen/templates/groups-workspace.go.tmpl new file mode 100644 index 00000000000..fde8e53a38e --- /dev/null +++ b/internal/cligen/templates/groups-workspace.go.tmpl @@ -0,0 +1,18 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package workspace + +import ( + "github.com/spf13/cobra" +) + +func Groups() []cobra.Group { + return []cobra.Group{ +{{- range .WorkspaceDocsGroups}} + { + ID: "{{.Key}}", + Title: "{{.DisplayName}}", + }, +{{- end}} + } +} diff --git a/internal/cligen/templates/service.go.tmpl b/internal/cligen/templates/service.go.tmpl new file mode 100644 index 00000000000..42a0e8b8ea9 --- /dev/null +++ b/internal/cligen/templates/service.go.tmpl @@ -0,0 +1,618 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package {{(.TrimPrefix "account").SnakeName}} + +import ( + "fmt" + "time" + + "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/cli/libs/cmdctx" + "github.com/databricks/cli/libs/flags" + "github.com/databricks/cli/libs/diag" + "github.com/databricks/cli/cmd/root" + "github.com/databricks/databricks-sdk-go/experimental/api" + "github.com/databricks/databricks-sdk-go/common/types/fieldmask" + sdktime "github.com/databricks/databricks-sdk-go/common/types/time" + "github.com/databricks/databricks-sdk-go/common/types/duration" + "github.com/databricks/databricks-sdk-go/service/{{.Package.Name}}" + "github.com/spf13/cobra" + + {{range .Subservices -}} + {{.SnakeName}} "github.com/databricks/cli/cmd/{{ if .ParentService.IsAccounts }}account{{ else }}workspace{{ end }}/{{.KebabName}}" + {{end}} +) + +{{ $excludes := + list + "command-execution" + "statement-execution" + "dbfs" + "dbsql-permissions" + "account-access-control-proxy" + "files" + "serving-endpoints-data-plane" +}} + +{{if not (in $excludes .KebabName) }} + {{template "service" .}} +{{else}} + {{skipThisFile}} +{{end}} + +{{define "printArray" -}} +{{if le (len .) 5 -}} + [{{range $index, $element := .}}{{if ne $index 0}}, {{end}}{{$element.Content}}{{end}}] +{{- else -}}[{{range $index, $element := .}} + {{$element.Content}},{{end}} +]{{end}}{{end}} + +{{define "supportedValuesForPositionalArg"}} + Supported values: {{if le (len .) 5 -}} + [{{range $index, $element := .}}{{if ne $index 0}}, {{end}}{{$element.Content}}{{end}}] +{{- else -}}[{{range $index, $element := .}} + {{$element.Content}},{{end}} + ]{{end}}{{end}} + +{{define "service"}} +{{- $excludeMethods := list "put-secret" -}} +{{- $hideService := .IsHiddenCLI }} + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var cmdOverrides []func(*cobra.Command) + +func New() *cobra.Command { + cmd := &cobra.Command{ + Use: "{{(.TrimPrefix "account").KebabName}}", + {{- if .Description }} + Short: `{{with .CLILaunchStageLabel}}{{.}} {{end}}{{.Summary | without "`"}}`, + Long: `{{with .CLILaunchStageBanner}}{{.}} + +{{end}}{{.Comment " " 80 | without "`"}}`, + {{- end }} + {{- if not .HasParent }} + {{- if .DocsGroup }} + GroupID: "{{ .DocsGroup }}", + {{- else }} + GroupID: "{{ .Package.Name }}", + {{- end }} + {{- end }} + {{- if $hideService }} + + // This service is being previewed; hide from help output. + Hidden: true, + {{- end }} + RunE: root.ReportUnknownSubcommand, + } + {{- if .LaunchStage }} + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "{{.LaunchStage}}" + cmd.Annotations["launch_stage_display"] = "{{.CLILaunchStageDisplay}}" + {{- end }} + + {{ if gt (len .Methods) 0 -}} + // Add methods + {{- range .Methods}} + {{- if in $excludeMethods .KebabName }} + {{- continue}} + {{- end}} + cmd.AddCommand(new{{.PascalName}}()) + {{- end}} + {{- end}} + + {{ if .HasSubservices }} + // Add subservices + {{- range .Subservices}} + cmd.AddCommand({{.SnakeName}}.New()) + {{- end}} + {{- end}} + + // Apply optional overrides to this command. + for _, fn := range cmdOverrides { + fn(cmd) + } + + return cmd +} + +{{- $serviceName := .KebabName -}} +{{range .Methods}} + +{{if in $excludeMethods .KebabName }} + {{continue}} +{{end}} +// start {{.KebabName}} command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var {{.CamelName}}Overrides []func( + *cobra.Command, + {{- if not .IsLegacyEmptyRequest }} + *{{$.Package.Name}}.{{.Request.PascalName}}, + {{- end }} +) + +{{- $excludeFromJson := list "http-request"}} + +func new{{.PascalName}}() *cobra.Command { + cmd := &cobra.Command{} + + {{- $canUseJson := and .CanUseJson (not (in $excludeFromJson .KebabName )) -}} + {{- if not .IsLegacyEmptyRequest}} + + var {{.CamelName}}Req {{$.Package.Name}}.{{.Request.PascalName}} + {{- if .RequestBodyField }} + {{.CamelName}}Req.{{.RequestBodyField.PascalName}} = {{ if .RequestBodyField.IsOptionalObject }}&{{end}}{{$.Package.Name}}.{{.RequestBodyField.Entity.PascalName}}{} + {{- end }} + {{- if $canUseJson}} + var {{.CamelName}}Json flags.JsonFlag + {{- end}} + {{- end}} + {{- if .Pagination }} + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var {{.CamelName}}Limit int + {{- end}} + {{- if or .Wait .LongRunningOperation }} + + var {{.CamelName}}SkipWait bool + var {{.CamelName}}Timeout time.Duration + {{- end}} + + {{- if .LongRunningOperation }} + + cmd.Flags().BoolVar(&{{.CamelName}}SkipWait, "no-wait", {{.CamelName}}SkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&{{.CamelName}}Timeout, "timeout", 0, `maximum amount of time to reach DONE state`) + {{- else if .Wait }} + + cmd.Flags().BoolVar(&{{.CamelName}}SkipWait, "no-wait", {{.CamelName}}SkipWait, `do not wait to reach {{range $i, $e := .Wait.Success}}{{if $i}} or {{end}}{{.Content}}{{end}} state`) + cmd.Flags().DurationVar(&{{.CamelName}}Timeout, "timeout", {{.Wait.Timeout}}*time.Minute, `maximum amount of time to reach {{range $i, $e := .Wait.Success}}{{if $i}} or {{end}}{{.Content}}{{end}} state`) + {{- end }} + {{- $request := .Request -}} + {{- if .RequestBodyField -}} + {{- $request = .RequestBodyField.Entity -}} + {{- end -}} + {{if $request }} + {{- if $canUseJson}} + + cmd.Flags().Var(&{{.CamelName}}Json, "json", `either inline JSON string or @path/to/file.json with request body`) + {{- end}} + {{$method := .}} + {{ if not .IsJsonOnly }} + {{- $hasFieldMask := $request.HasFieldMask -}} + {{range .AllFields -}} + {{- if not .Required -}} + {{- if and $method.Pagination (or + (and (and $method.Pagination.Token $method.Pagination.Token.PollField) (eq .Name $method.Pagination.Token.PollField.Name) (not (eq $method.Path "/api/2.1/clusters/events"))) + (and $method.Pagination.Offset (eq .Name $method.Pagination.Offset.Name)) + (and $method.Pagination.Limit (eq .Name $method.Pagination.Limit.Name)) + (and $method.Pagination.MaxResults (eq .Name $method.Pagination.MaxResults.Name)) + (and (eq $method.Path "/api/2.1/clusters/events") (or (eq .Name "offset") (eq .Name "limit"))) + ) -}} + {{- /* Skip pagination fields; they are generated separately below. */ -}} + {{else if and $method.Pagination (eq .KebabName "limit") -}} + {{- /* The API field is named "limit" but isn't a declared pagination field + (e.g. jobs.List.Limit). Rename to --page-size to avoid colliding with + the --limit result capping flag. */ -}} + cmd.Flags().{{template "arg-type" .Entity}}(&{{- template "request-body-obj" (dict "Method" $method "Field" .)}}, "page-size", {{- template "request-body-obj" (dict "Method" $method "Field" .)}}, `{{.Summary | without "`" | trimSuffix "."}}{{if .Summary}}.{{end}}`) + cmd.Flags().Lookup("page-size").Hidden = true + {{else if .Entity.IsObject}}{{if not (eq . $method.RequestBodyField) }}// TODO: complex arg: {{.Name}}{{end}} + {{else if .Entity.IsAny }}// TODO: any: {{.Name}} + {{else if .Entity.ArrayValue }}// TODO: array: {{.Name}} + {{else if .Entity.MapValue }}// TODO: map via StringToStringVar: {{.Name}} + {{else if .IsComputed -}} + {{else if .IsOutputOnly -}} + {{else if .Entity.Enum }}cmd.Flags().Var(&{{- template "request-body-obj" (dict "Method" $method "Field" .)}}, "{{.KebabName}}", `{{.Summary | without "`" | trimSuffix "."}}{{if .Summary}}. {{end}}Supported values: {{template "printArray" .Entity.Enum}}{{if $hasFieldMask}}. Wire name: '{{.Name}}'.{{end}}`) + {{else if or .Entity.IsDuration .Entity.IsTimestamp .Entity.IsFieldMask}} var {{.CamelName}}Param string + cmd.Flags().StringVar(&{{.CamelName}}Param, "{{.KebabName}}", {{.CamelName}}Param, `{{.Summary | without "`" | trimSuffix "."}}{{if .Summary}}.{{end}}{{if $hasFieldMask}} Wire name: '{{.Name}}'.{{end}}`) + {{else}}cmd.Flags().{{template "arg-type" .Entity}}(&{{- template "request-body-obj" (dict "Method" $method "Field" .)}}, "{{.KebabName}}", {{- template "request-body-obj" (dict "Method" $method "Field" .)}}, `{{.Summary | without "`" | trimSuffix "."}}{{if .Summary}}.{{end}}{{if $hasFieldMask}} Wire name: '{{.Name}}'.{{end}}`) + {{end}} + {{- end -}} + {{- end}} + {{- end}} + {{end}} + {{- if .Pagination }} + + // Limit flag for total result capping. + cmd.Flags().IntVar(&{{.CamelName}}Limit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + {{- if eq .Path "/api/2.1/clusters/events" }} + {{- $method := . }} + {{- range .AllFields }}{{ if eq .Name "offset" }} + cmd.Flags().{{template "arg-type" .Entity}}(&{{$method.CamelName}}Req.{{.PascalName}}, "{{.KebabName}}", {{$method.CamelName}}Req.{{.PascalName}}, `{{.Summary | without "`" | trimSuffix "."}}{{if .Summary}}.{{end}}`) + cmd.Flags().Lookup("{{.KebabName}}").Hidden = true + {{- end }}{{ end }} + {{- else if and .Pagination.Token .Pagination.Token.PollField }} + cmd.Flags().{{template "arg-type" .Pagination.Token.PollField.Entity}}(&{{.CamelName}}Req.{{.Pagination.Token.PollField.PascalName}}, "{{.Pagination.Token.PollField.KebabName}}", {{.CamelName}}Req.{{.Pagination.Token.PollField.PascalName}}, `Pagination token.`) + cmd.Flags().Lookup("{{.Pagination.Token.PollField.KebabName}}").Hidden = true + {{- end }} + {{- if .Pagination.Offset }} + cmd.Flags().{{template "arg-type" .Pagination.Offset.Entity}}(&{{.CamelName}}Req.{{.Pagination.Offset.PascalName}}, "{{.Pagination.Offset.KebabName}}", {{.CamelName}}Req.{{.Pagination.Offset.PascalName}}, `{{.Pagination.Offset.Summary | without "`" | trimSuffix "."}}{{if .Pagination.Offset.Summary}}.{{end}}`) + cmd.Flags().Lookup("{{.Pagination.Offset.KebabName}}").Hidden = true + {{- end }} + {{- if .Pagination.Limit }} + {{- if ne .Pagination.Limit.KebabName "limit" }} + cmd.Flags().{{template "arg-type" .Pagination.Limit.Entity}}(&{{.CamelName}}Req.{{.Pagination.Limit.PascalName}}, "{{.Pagination.Limit.KebabName}}", {{.CamelName}}Req.{{.Pagination.Limit.PascalName}}, `Number of results per API page.`) + cmd.Flags().Lookup("{{.Pagination.Limit.KebabName}}").Hidden = true + {{- end }} + {{- end }} + {{- if .Pagination.MaxResults }} + cmd.Flags().{{template "arg-type" .Pagination.MaxResults.Entity}}(&{{.CamelName}}Req.{{.Pagination.MaxResults.PascalName}}, "{{.Pagination.MaxResults.KebabName}}", {{.CamelName}}Req.{{.Pagination.MaxResults.PascalName}}, `{{.Pagination.MaxResults.Summary | without "`" | trimSuffix "."}}{{if .Pagination.MaxResults.Summary}}.{{end}}`) + cmd.Flags().Lookup("{{.Pagination.MaxResults.KebabName}}").Hidden = true + {{- end }} + {{- end }} + + {{- $excludeFromPrompts := list + "workspace get-status" + "provider-exchanges get" + "provider-exchanges delete" + "provider-exchanges delete-listing-from-exchange" + "provider-exchanges list-exchanges-for-listing" + "provider-exchanges list-listings-for-exchange" + "storage-credentials get" + -}} + {{- $fullCommandName := (print $serviceName " " .KebabName) -}} + {{- $noPrompt := or .IsCrudCreate (in $excludeFromPrompts $fullCommandName) }} + + {{- $hasPosArgs := .HasRequiredPositionalArguments -}} + {{- $hasSinglePosArg := and $hasPosArgs (and (eq 1 (len .RequiredPositionalArguments)) (eq 1 (len $request.RequiredFields))) -}} + {{- $serviceHasNamedIdMap := and (and $.List $.List.NamedIdMap) (not (eq .PascalName "List")) -}} + {{- $hasIdPrompt := and (not $noPrompt) (and $hasSinglePosArg $serviceHasNamedIdMap) -}} + {{- $wait := and .Wait (and (not .IsCrudRead) (not (eq .SnakeName "get_run"))) -}} + {{- $hasRequiredArgs := and (not $hasIdPrompt) $hasPosArgs -}} + {{- $hasSingleRequiredRequestBodyFieldWithPrompt := and (and $hasIdPrompt $request) (eq 1 (len $request.RequiredRequestBodyFields)) -}} + {{- $onlyInUrlArgsRequiredAsPositionalArguments := and (not .IsLegacyEmptyRequest) (eq (len .RequiredPositionalArguments) (len .Request.RequiredInUrlFields)) -}} + {{- $hasDifferentArgsWithJsonFlag := and (not $onlyInUrlArgsRequiredAsPositionalArguments) (and $canUseJson (or $request.HasRequiredRequestBodyFields )) -}} + {{- $hasCustomArgHandler := or $hasRequiredArgs $hasDifferentArgsWithJsonFlag -}} + + {{- $atleastOneArgumentWithDescription := false -}} + {{- if $hasPosArgs -}} + {{- range .RequiredPositionalArguments -}} + {{- if .HasComment -}} + {{- $atleastOneArgumentWithDescription = true -}} + {{- break -}} + {{- end -}} + {{- end -}} + {{- end }} + + cmd.Use = "{{.KebabName}}{{if $hasPosArgs}}{{range .RequiredPositionalArguments}} {{.ConstantName}}{{end}}{{end}}" + {{- if .CliComment " " 80 }} + cmd.Short = `{{with .CLILaunchStageLabel}}{{.}} {{end}}{{.Summary | without "`"}}` + cmd.Long = `{{with .CLILaunchStageBanner}}{{.}} + +{{end}}{{.CliComment " " 80 | without "`"}} + {{- if .LongRunningOperation }} + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the {{.LongRunningOperation.GetOperation.KebabName}} command. + {{- end }} + {{- if $atleastOneArgumentWithDescription }} + + Arguments: + {{- range .RequiredPositionalArguments }} + {{ .ConstantName }}: {{.Comment " " 80 | without "`"}}{{- if .Entity.Enum }} {{template "supportedValuesForPositionalArg" .Entity.Enum}} {{- end -}} + {{- end -}} + {{- end -}} + ` + {{- end }} + {{/* Don't hide commands if the service itself is already hidden. */}} + {{- if and (not $hideService) .IsHiddenCLI }} + + // This command is being previewed; hide from help output. + cmd.Hidden = true + {{- end }} + + cmd.Annotations = make(map[string]string) + {{- if .LaunchStage }} + cmd.Annotations["launch_stage"] = "{{.LaunchStage}}" + cmd.Annotations["launch_stage_display"] = "{{.CLILaunchStageDisplay}}" + {{- end }} + {{ if $hasCustomArgHandler }} + cmd.Args = func(cmd *cobra.Command, args []string) error { + {{- if $hasDifferentArgsWithJsonFlag }} + if cmd.Flags().Changed("json") { + err := root.ExactArgs({{len .Request.RequiredInUrlFields}})(cmd, args) + if err != nil { + {{- if eq 0 (len .Request.RequiredInUrlFields) }} + return fmt.Errorf("when --json flag is specified, no positional arguments are allowed. Provide{{- range $index, $field := $request.RequiredFields}}{{if $index}},{{end}} '{{$field.Name}}'{{end}} in your JSON input") + {{- else }} + return fmt.Errorf("when --json flag is specified, provide only{{- range $index, $field := .Request.RequiredInUrlFields}}{{if $index}},{{end}} {{$field.ConstantName}}{{end}} as positional arguments. Provide{{- range $index, $field := $request.RequiredRequestBodyFields}}{{if $index}},{{end}} '{{$field.Name}}'{{end}} in your JSON input") + {{- end }} + } + return nil + } + {{- end }} + {{- if $hasRequiredArgs }} + check := root.ExactArgs({{len .RequiredPositionalArguments}}) + return check(cmd, args) + {{- else}} + return nil + {{- end }} + } + {{ end }} + cmd.PreRunE = root.Must{{if $.IsAccounts}}Account{{else}}Workspace{{end}}Client + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + {{if $.IsAccounts}}a := cmdctx.AccountClient(ctx){{else}}w := cmdctx.WorkspaceClient(ctx){{end}} + {{- if not .IsLegacyEmptyRequest }} + {{ if $canUseJson }} + if cmd.Flags().Changed("json") { + diags := {{.CamelName}}Json.Unmarshal(&{{.CamelName}}Req{{ if .RequestBodyField }}.{{.RequestBodyField.PascalName}}{{ end }}) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + }{{end}}{{ if .MustUseJson }}else { + return fmt.Errorf("please provide command input in JSON format by specifying the --json flag") + }{{- end}} + {{- if $hasPosArgs }} + {{- if and $canUseJson $hasSingleRequiredRequestBodyFieldWithPrompt }} else { + {{- end}} + {{- if $hasIdPrompt}} + if len(args) == 0 { + sp := cmdio.NewSpinner(ctx) + sp.Update("No{{range $request.RequiredFields}} {{.ConstantName}}{{end}} argument specified. Loading names for {{$.TitleName}} drop-down.") + names, err := {{if $.IsAccounts}}a{{else}}w{{end}}.{{($.TrimPrefix "account").PascalName}}.{{$.List.NamedIdMap.PascalName}}(ctx{{if not $.List.IsLegacyEmptyRequest}}, {{$.Package.Name}}.{{$.List.Request.PascalName}}{}{{end}}) + sp.Close() + if err != nil { + return fmt.Errorf("failed to load names for {{$.TitleName}} drop-down. Please manually specify required arguments. Original error: %w", err) + } + id, err := cmdio.Select(ctx, names, "{{range $request.RequiredFields}}{{.Summary | trimSuffix "."}}{{end}}") + if err != nil { + return err + } + args = append(args, id) + } + if len(args) != 1 { + return fmt.Errorf("expected to have {{range $request.RequiredFields}}{{.Summary | trimSuffix "." | lower}}{{end}}") + } + {{- end -}} + + {{$method := .}} + {{- range $arg, $field := .RequiredPositionalArguments}} + {{- template "args-scan" (dict "Arg" $arg "Field" $field "Method" $method "HasIdPrompt" $hasIdPrompt "ExcludeFromJson" $excludeFromJson)}} + {{- end -}} + {{- range .AllFields -}} + {{- if and (not .Required) (not .IsComputed) (not .IsOutputOnly)}} + {{if or .Entity.IsDuration .Entity.IsTimestamp .Entity.IsFieldMask}} + if {{.CamelName}}Param != "" { + {{template "parse-well-known-type" (dict "Method" $method "Field" . "SourceValue" (printf "%sParam" .CamelName))}} + } + {{- end -}} + {{- end -}} + {{- end -}} + {{- if and $canUseJson $hasSingleRequiredRequestBodyFieldWithPrompt }} + } + {{- end}} + + {{- end}} + {{end}} + {{if .LongRunningOperation -}} + // Determine which mode to execute based on flags. + switch { + case {{.CamelName}}SkipWait: + wait, err := {{if $.IsAccounts}}a{{else}}w{{end}}.{{$.PascalName}}.{{.PascalName}}(ctx{{if not .IsLegacyEmptyRequest}}, {{.CamelName}}Req{{end}}) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := {{if $.IsAccounts}}a{{else}}w{{end}}.{{$.PascalName}}.{{.LongRunningOperation.GetOperation.PascalName}}(ctx, {{$.Package.Name}}.{{.LongRunningOperation.GetOperation.Request.PascalName}}{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := {{if $.IsAccounts}}a{{else}}w{{end}}.{{$.PascalName}}.{{.PascalName}}(ctx{{if not .IsLegacyEmptyRequest}}, {{.CamelName}}Req{{end}}) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for {{.KebabName}} to complete...") + + // Wait for completion. + opts := api.WithTimeout({{.CamelName}}Timeout) + {{ if not .LongRunningOperation.ResponseType.IsEmptyResponse -}} + response, err := wait.Wait(ctx, opts) + {{- else }} + err = wait.Wait(ctx, opts) + {{- end }} + if err != nil { + return err + } + sp.Close() + {{if not .LongRunningOperation.ResponseType.IsEmptyResponse -}} + return cmdio.Render(ctx, response) + {{- else -}} + return nil + {{- end }} + } + {{else if $wait -}} + wait, err := {{if $.IsAccounts}}a{{else}}w{{end}}.{{$.PascalName}}.{{.PascalName}}(ctx{{if not .IsLegacyEmptyRequest}}, {{.CamelName}}Req{{end}}) + if err != nil { + return err + } + if {{.CamelName}}SkipWait { + {{if not .Response.IsEmptyResponse -}} + return cmdio.Render(ctx, wait.Response) + {{- else -}} + return nil + {{- end}} + } + sp := cmdio.NewSpinner(ctx) + info, err := wait.OnProgress(func(i *{{$.Package.Name}}.{{.Wait.Poll.Response.PascalName}}) { + {{if .Wait.MessagePath -}} + {{if .Wait.ComplexMessagePath -}} + if i.{{.Wait.MessagePathHead.PascalName}} == nil { + return + } + status := i{{range .Wait.StatusPath}}.{{.PascalName}}{{end}} + statusMessage := fmt.Sprintf("current status: %s", status) + if i.{{.Wait.MessagePathHead.PascalName}} != nil { + statusMessage = i{{range .Wait.MessagePath}}.{{.PascalName}}{{end}} + } + {{- else -}} + statusMessage := i{{range .Wait.MessagePath}}.{{.PascalName}}{{end}} + {{- end}} + {{- else -}} + status := i{{range .Wait.StatusPath}}.{{.PascalName}}{{end}} + statusMessage := fmt.Sprintf("current status: %s", status) + {{- end}} + sp.Update(statusMessage) + }).GetWithTimeout({{.CamelName}}Timeout) + sp.Close() + if err != nil { + return err + } + return cmdio.Render(ctx, info) + {{- else -}} + {{template "method-call" (dict "Method" . "Service" $)}} + {{end -}} + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range {{.CamelName}}Overrides { + fn(cmd{{if not .IsLegacyEmptyRequest}}, &{{.CamelName}}Req{{end}}) + } + + return cmd +} + +{{end}} +// end service {{.Name}}{{end}} + +{{- define "method-call" -}} + {{- $method := .Method -}} + {{- $service := .Service -}} + + {{if not $method.Response.IsEmptyResponse -}} + response{{ if not $method.Pagination}}, err{{end}} := + {{- else -}} + err = + {{- end}} + {{- if $service.IsAccounts}}a{{else}}w{{end}}. + {{- if $service.HasParent }} + {{- ($service.ParentService.TrimPrefix "account").PascalName }}. + {{- ($service.TrimPrefix "account").PascalName}}(). + {{- else}} + {{- ($service.TrimPrefix "account").PascalName}}. + {{- end}} + {{- $method.PascalName}}(ctx{{if not $method.IsLegacyEmptyRequest}}, {{$method.CamelName}}Req{{end}}) + {{- if not (and $method.Response $method.Pagination) }} + if err != nil { + return err + } + {{- end}} + {{ if not $method.Response.IsEmptyResponse -}} + {{- if $method.Pagination -}} + if {{$method.CamelName}}Limit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", {{$method.CamelName}}Limit) + } + if {{$method.CamelName}}Limit > 0 { + ctx = cmdio.WithLimit(ctx, {{$method.CamelName}}Limit) + } + {{- end }} + {{ if $method.IsResponseByteStream -}} + defer response.{{$method.ResponseBodyField.PascalName}}.Close() + return cmdio.Render{{ if $method.Pagination}}Iterator{{end}}(ctx, response.{{$method.ResponseBodyField.PascalName}}) + {{- else }} + return cmdio.Render{{ if $method.Pagination}}Iterator{{end}}(ctx, response) + {{- end -}} + {{ else -}} + return nil + {{- end -}} +{{- end -}} + +{{- define "arg-type" -}} + {{- if .IsString}}StringVar + {{- /* The following Well Known Types are expressed as strings in JSON */}} + {{- else if .IsTimestamp}}StringVar + {{- else if .IsDuration}}StringVar + {{- else if .IsFieldMask}}StringVar + {{- else if .IsBool}}BoolVar + {{- else if .IsInt64}}Int64Var + {{- else if .IsFloat64}}Float64Var + {{- else if .IsInt}}IntVar + {{- else if .Enum }}StringVar + {{- else}}/* NOT PRIMITIVE */ + {{- end -}} +{{- end -}} + +{{- define "parse-well-known-type" -}} + {{- $field := .Field -}} + {{- $method := .Method -}} + {{- $sourceValue := .SourceValue -}} + {{- if $field.Entity.IsTimestamp -}} + {{$field.CamelName}}Bytes := []byte(fmt.Sprintf("\"%s\"", {{$sourceValue}})) + var {{$field.CamelName}}Field sdktime.Time + err = json.Unmarshal({{$field.CamelName}}Bytes, &{{$field.CamelName}}Field) + if err != nil { + return fmt.Errorf("invalid {{$field.ConstantName}}: %s", {{$sourceValue}}) + } + {{template "request-body-obj" (dict "Method" $method "Field" $field)}} = {{if not $field.Required}}&{{end}}{{$field.CamelName}}Field + {{- else if $field.Entity.IsDuration -}} + {{$field.CamelName}}Bytes := []byte(fmt.Sprintf("\"%s\"", {{$sourceValue}})) + var {{$field.CamelName}}Field duration.Duration + err = json.Unmarshal({{$field.CamelName}}Bytes, &{{$field.CamelName}}Field) + if err != nil { + return fmt.Errorf("invalid {{$field.ConstantName}}: %s", {{$sourceValue}}) + } + {{template "request-body-obj" (dict "Method" $method "Field" $field)}} = {{if not $field.Required}}&{{end}}{{$field.CamelName}}Field + {{- else if $field.Entity.IsFieldMask -}} + {{$field.CamelName}}Array := strings.Split({{$sourceValue}}, ",") + {{template "request-body-obj" (dict "Method" $method "Field" $field)}} = {{if $field.Required}}*{{end}}fieldmask.New({{$field.CamelName}}Array) + {{- end -}} +{{- end -}} + +{{- define "args-scan" -}} + {{- $field := .Field -}} + {{- $method := .Method -}} + {{- $arg := .Arg -}} + {{- $hasIdPrompt := .HasIdPrompt -}} + {{ $canUseJson := and $method.CanUseJson (not (in .ExcludeFromJson $method.KebabName)) }} + {{- $optionalIfJsonIsUsed := and (not $hasIdPrompt) (and $field.IsRequestBodyField $canUseJson) }} + {{- if $optionalIfJsonIsUsed }} + if !cmd.Flags().Changed("json") { + {{- end }} + {{if and (not $field.Entity.IsString) (not $field.Entity.IsFieldMask) (not $field.Entity.IsTimestamp) (not $field.Entity.IsDuration) -}} + _, err = fmt.Sscan(args[{{$arg}}], &{{- template "request-body-obj" (dict "Method" $method "Field" $field)}}) + if err != nil { + return fmt.Errorf("invalid {{$field.ConstantName}}: %s", args[{{$arg}}]) + } + {{else if or $field.Entity.IsTimestamp $field.Entity.IsDuration $field.Entity.IsFieldMask -}} + if args[{{$arg}}] != "" { + {{template "parse-well-known-type" (dict "Method" $method "Field" $field "SourceValue" (printf "args[%d]" $arg))}} + } + {{- else -}} + {{- template "request-body-obj" (dict "Method" $method "Field" $field)}} = args[{{$arg}}] + {{- end -}} + {{- if $optionalIfJsonIsUsed }} + } + {{- end }} +{{- end -}} + +{{- define "request-body-obj" -}} + {{- $method := .Method -}} + {{- $field := .Field -}} + {{$method.CamelName}}Req{{ if (and $method.RequestBodyField (and (not $field.IsPath) (not $field.IsQuery))) }}.{{$method.RequestBodyField.PascalName}}{{end}}.{{$field.PascalName}} +{{- end -}} diff --git a/python/databricks/bundles/catalogs/_models/privilege.py b/python/databricks/bundles/catalogs/_models/privilege.py index e6d02de7bf4..20f4e1f5573 100644 --- a/python/databricks/bundles/catalogs/_models/privilege.py +++ b/python/databricks/bundles/catalogs/_models/privilege.py @@ -53,25 +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" - CREATE_STREAM = "CREATE_STREAM" - READ_STREAM = "READ_STREAM" - CREATE_MEMORY_STORE = "CREATE_MEMORY_STORE" - READ_MEMORY_STORE = "READ_MEMORY_STORE" - WRITE_MEMORY_STORE = "WRITE_MEMORY_STORE" PrivilegeParam = ( @@ -126,25 +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", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE", ] | Privilege ) 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/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/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/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/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/schemas/_models/privilege.py b/python/databricks/bundles/schemas/_models/privilege.py index e6d02de7bf4..20f4e1f5573 100644 --- a/python/databricks/bundles/schemas/_models/privilege.py +++ b/python/databricks/bundles/schemas/_models/privilege.py @@ -53,25 +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" - CREATE_STREAM = "CREATE_STREAM" - READ_STREAM = "READ_STREAM" - CREATE_MEMORY_STORE = "CREATE_MEMORY_STORE" - READ_MEMORY_STORE = "READ_MEMORY_STORE" - WRITE_MEMORY_STORE = "WRITE_MEMORY_STORE" PrivilegeParam = ( @@ -126,25 +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", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE", ] | Privilege ) diff --git a/python/databricks/bundles/volumes/_models/privilege.py b/python/databricks/bundles/volumes/_models/privilege.py index e6d02de7bf4..20f4e1f5573 100644 --- a/python/databricks/bundles/volumes/_models/privilege.py +++ b/python/databricks/bundles/volumes/_models/privilege.py @@ -53,25 +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" - CREATE_STREAM = "CREATE_STREAM" - READ_STREAM = "READ_STREAM" - CREATE_MEMORY_STORE = "CREATE_MEMORY_STORE" - READ_MEMORY_STORE = "READ_MEMORY_STORE" - WRITE_MEMORY_STORE = "WRITE_MEMORY_STORE" PrivilegeParam = ( @@ -126,25 +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", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE", ] | Privilege ) diff --git a/tools/go.mod b/tools/go.mod index ced1d3e1c16..c04ad1789c5 100644 --- a/tools/go.mod +++ b/tools/go.mod @@ -237,6 +237,7 @@ tool ( github.com/golangci/golangci-lint/v2/cmd/golangci-lint github.com/google/yamlfmt/cmd/yamlfmt golang.org/x/tools/cmd/deadcode + golang.org/x/tools/cmd/goimports golang.org/x/vuln/cmd/govulncheck gotest.tools/gotestsum ) From d5673efbd236901aca4fbc5c2361ab424ed8be75 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 17:47:50 +0200 Subject: [PATCH 02/11] internal/cligen: test splitASCII name-splitting behavior splitASCII drives every casing function and is a faithful port of genkit's Named.splitASCII, whose nearest-letter scanning produces several non-obvious splits (acronym head/tail handling, digits never starting a word). Pin those as a curated table so the port can't drift. Co-authored-by: Isaac --- internal/cligen/split_test.go | 68 +++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 internal/cligen/split_test.go diff --git a/internal/cligen/split_test.go b/internal/cligen/split_test.go new file mode 100644 index 00000000000..e59bb2d7433 --- /dev/null +++ b/internal/cligen/split_test.go @@ -0,0 +1,68 @@ +package main + +import ( + "reflect" + "testing" +) + +// TestSplitASCII pins the exact behavior of splitASCII (names.go), the engine +// behind every casing function. splitASCII is a faithful port of genkit's +// Named.splitASCII, which emulates a JVM lookahead/lookbehind regex by scanning +// for the nearest letter in both directions. These cases document the +// non-obvious consequences of that emulation, which a simpler reimplementation +// (e.g. Go's lookaround-free regexp) would not reproduce. +func TestSplitASCII(t *testing.T) { + cases := []struct { + in string + want []string + }{ + // Empty and separator-only inputs yield no words. + {"", nil}, + {"_", nil}, + {"__", nil}, + + // Single words, any casing, lowercased output. + {"a", []string{"a"}}, + {"A", []string{"a"}}, + {"AB", []string{"ab"}}, + {"ABC", []string{"abc"}}, + {"Abc", []string{"abc"}}, + {"Workspace", []string{"workspace"}}, + + // Plain camel/Pascal and separator splits. + {"JobSettings", []string{"job", "settings"}}, + {"IpAccessLists", []string{"ip", "access", "lists"}}, + {"create_run", []string{"create", "run"}}, + {"snake_case_name", []string{"snake", "case", "name"}}, + + // Acronym tail: the last capital of a run starts the next word when it is + // followed by a lowercase letter. + {"HTTPSConnection", []string{"https", "connection"}}, + {"ServeMLModel", []string{"serve", "ml", "model"}}, + {"ABCDef", []string{"abc", "def"}}, + {"GetByID", []string{"get", "by", "id"}}, + {"DefABC", []string{"def", "abc"}}, + + // Acronym head quirk: a leading capital splits off alone when the run is + // exactly two capitals followed by lowercase (the lookahead can't see far + // enough to keep them together)... + {"ABc", []string{"a", "bc"}}, + {"AItool", []string{"a", "itool"}}, + {"MLflow", []string{"m", "lflow"}}, + // ...but three+ capitals before lowercase keep the run intact. + {"AIService", []string{"ai", "service"}}, + + // Digits attach to the preceding word; they never start a word. + {"IamV2", []string{"iam", "v2"}}, + {"AccountGroupsV2", []string{"account", "groups", "v2"}}, + {"HTTP2Server", []string{"http2", "server"}}, + {"OAuth2Config", []string{"o", "auth2", "config"}}, + {"UUID4", []string{"uuid4"}}, + {"a1b2", []string{"a1b2"}}, + } + for _, c := range cases { + if got := splitASCII(c.in); !reflect.DeepEqual(got, c.want) { + t.Errorf("splitASCII(%q) = %#v, want %#v", c.in, got, c.want) + } + } +} From e54bc98fde3f87220a777d405adff5d9b73f75de Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 19:04:42 +0200 Subject: [PATCH 03/11] internal/cligen: move splitASCII into split.go Pure move of the name-splitting engine (splitASCII and its condAtNearestLetters/searchNearest helpers) out of names.go so it sits next to split_test.go. The casing functions stay in names.go. Co-authored-by: Isaac --- internal/cligen/names.go | 76 ------------------------------------ internal/cligen/split.go | 83 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 76 deletions(-) create mode 100644 internal/cligen/split.go diff --git a/internal/cligen/names.go b/internal/cligen/names.go index 2db0eb9cd41..9422ab4f7a1 100644 --- a/internal/cligen/names.go +++ b/internal/cligen/names.go @@ -26,82 +26,6 @@ func title(s string) string { return string(out) } -func searchNearest(name string, cond func(rune) bool, forward bool, i int) bool { - incr := 1 - if !forward { - incr = -1 - } - for j := i; j >= 0 && j < len(name); j += incr { - if unicode.IsLetter(rune(name[j])) { - return cond(rune(name[j])) - } - } - return false -} - -func condAtNearestLetters(name string, cond func(rune) bool, i int) bool { - r := rune(name[i]) - if unicode.IsLetter(r) { - return cond(r) - } - return searchNearest(name, cond, true, i) && searchNearest(name, cond, false, i) -} - -// splitASCII is a faithful port of genkit Named.splitASCII: it splits a name -// into lowercased words at case boundaries and separators, emulating the JVM -// lookahead regex genkit documents. -func splitASCII(name string) (w []string) { - var current []rune - nameLen := len(name) - var isPrevUpper bool - for i := range nameLen { - r := rune(name[i]) - if r == '$' { - continue - } - isCurrentUpper := condAtNearestLetters(name, unicode.IsUpper, i) - r = unicode.ToLower(r) - isNextLower := false - isNextUpper := false - isNotLastChar := i+1 < nameLen - if isNotLastChar { - isNextLower = condAtNearestLetters(name, unicode.IsLower, i+1) - isNextUpper = condAtNearestLetters(name, unicode.IsUpper, i+1) - } - split, before, after := false, false, true - if isPrevUpper && isCurrentUpper && isNextLower && isNotLastChar { - split = true - before = false - after = true - } - if !isCurrentUpper && isNextUpper { - split = true - before = true - after = false - } - if !unicode.IsLetter(r) && !unicode.IsNumber(r) { - split = true - before = false - after = false - } - if before { - current = append(current, r) - } - if split && len(current) > 0 { - w = append(w, string(current)) - current = []rune{} - } - if after { - current = append(current, r) - } - isPrevUpper = isCurrentUpper - } - if len(current) > 0 { - w = append(w, string(current)) - } - return w -} - func pascalName(name string) string { var sb strings.Builder for _, w := range splitASCII(name) { diff --git a/internal/cligen/split.go b/internal/cligen/split.go new file mode 100644 index 00000000000..bda83289a52 --- /dev/null +++ b/internal/cligen/split.go @@ -0,0 +1,83 @@ +package main + +import "unicode" + +// This file holds the name-splitting engine ported from genkit's +// codegen/code/named.go. The casing helpers in names.go all build on splitASCII; +// it lives here to match split_test.go, which pins its non-obvious behavior. + +func searchNearest(name string, cond func(rune) bool, forward bool, i int) bool { + incr := 1 + if !forward { + incr = -1 + } + for j := i; j >= 0 && j < len(name); j += incr { + if unicode.IsLetter(rune(name[j])) { + return cond(rune(name[j])) + } + } + return false +} + +func condAtNearestLetters(name string, cond func(rune) bool, i int) bool { + r := rune(name[i]) + if unicode.IsLetter(r) { + return cond(r) + } + return searchNearest(name, cond, true, i) && searchNearest(name, cond, false, i) +} + +// splitASCII is a faithful port of genkit Named.splitASCII: it splits a name +// into lowercased words at case boundaries and separators, emulating the JVM +// lookahead regex genkit documents. +func splitASCII(name string) (w []string) { + var current []rune + nameLen := len(name) + var isPrevUpper bool + for i := range nameLen { + r := rune(name[i]) + if r == '$' { + continue + } + isCurrentUpper := condAtNearestLetters(name, unicode.IsUpper, i) + r = unicode.ToLower(r) + isNextLower := false + isNextUpper := false + isNotLastChar := i+1 < nameLen + if isNotLastChar { + isNextLower = condAtNearestLetters(name, unicode.IsLower, i+1) + isNextUpper = condAtNearestLetters(name, unicode.IsUpper, i+1) + } + split, before, after := false, false, true + if isPrevUpper && isCurrentUpper && isNextLower && isNotLastChar { + split = true + before = false + after = true + } + if !isCurrentUpper && isNextUpper { + split = true + before = true + after = false + } + if !unicode.IsLetter(r) && !unicode.IsNumber(r) { + split = true + before = false + after = false + } + if before { + current = append(current, r) + } + if split && len(current) > 0 { + w = append(w, string(current)) + current = []rune{} + } + if after { + current = append(current, r) + } + isPrevUpper = isCurrentUpper + } + if len(current) > 0 { + w = append(w, string(current)) + } + return w +} From b47043d3a7c3d0960e5c9bc5e3b7e6976b8c8168 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 19:05:20 +0200 Subject: [PATCH 04/11] internal/cligen: reword split.go header comment Co-authored-by: Isaac --- internal/cligen/split.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/internal/cligen/split.go b/internal/cligen/split.go index bda83289a52..950db714e5a 100644 --- a/internal/cligen/split.go +++ b/internal/cligen/split.go @@ -3,8 +3,7 @@ package main import "unicode" // This file holds the name-splitting engine ported from genkit's -// codegen/code/named.go. The casing helpers in names.go all build on splitASCII; -// it lives here to match split_test.go, which pins its non-obvious behavior. +// codegen/code/named.go. The casing helpers in names.go all build on splitASCII. func searchNearest(name string, cond func(rune) bool, forward bool, i int) bool { incr := 1 From 078472cd47c6a80be8ffb917b9be963c324cb24d Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 19:06:38 +0200 Subject: [PATCH 05/11] internal/cligen: cover the empty/underscore/$ guard branches Add table cases for the special-cased early returns in camelName/snakeName and the '$'-skip branch in splitASCII, bringing the pure name/casing logic to full statement coverage. Co-authored-by: Isaac --- internal/cligen/names_test.go | 4 ++++ internal/cligen/split_test.go | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/internal/cligen/names_test.go b/internal/cligen/names_test.go index f33b552377f..604a9ec95ff 100644 --- a/internal/cligen/names_test.go +++ b/internal/cligen/names_test.go @@ -16,6 +16,10 @@ func TestNameCasings(t *testing.T) { {"IpAccessLists", "ip-access-lists", "ip_access_lists", "IpAccessLists", "ipAccessLists", "IP_ACCESS_LISTS", "Ip Access Lists"}, {"IamV2", "iam-v2", "iam_v2", "IamV2", "iamV2", "IAM_V2", "Iam V2"}, {"create_run", "create-run", "create_run", "CreateRun", "createRun", "CREATE_RUN", "Create Run"}, + // Empty and "_" hit the special-cased early returns in camelName/snakeName; + // note kebab/title/pascal do not special-case them, so they differ. + {"", "", "", "", "", "", ""}, + {"_", "", "_", "", "_", "_", ""}, } for _, c := range cases { if got := kebabName(c.name); got != c.kebab { diff --git a/internal/cligen/split_test.go b/internal/cligen/split_test.go index e59bb2d7433..3b6218cb7c7 100644 --- a/internal/cligen/split_test.go +++ b/internal/cligen/split_test.go @@ -21,6 +21,10 @@ func TestSplitASCII(t *testing.T) { {"_", nil}, {"__", nil}, + // '$' is dropped entirely, joining its neighbors. + {"foo$bar", []string{"foobar"}}, + {"$foo", []string{"foo"}}, + // Single words, any casing, lowercased output. {"a", []string{"a"}}, {"A", []string{"a"}}, From 33fe412d9d4ff2f36ff37fcbf7b18bff6df678a5 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 21:26:10 +0200 Subject: [PATCH 06/11] codegen: consume the IR-derived cli.json from genkit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Switch the CLI to genkit's native cli_v1 producer (`genkit update-sdk`, mode cli_v1). The cli.json schema keys/refs now use the Go SDK's package.PascalName rendering and the file carries every message — including request/response wrappers, which are inert for the CLI since it reads only the schemas its commands reference. - derive DoNotSuggest from launch_stage == PRIVATE_PREVIEW instead of the dropped preview flag (cli_json.go, parser.go), sourcing the signal from the single launch-stage source of truth - Taskfile generate-cli-json: build genkit from universe HEAD and run update-sdk, since the cli_v1 producer is decoupled from the spec - regenerate annotations, jsonschema (+ for-docs), and docs; compute.Kind's description now resolves via the package.PascalName key - cli_json_test: assert the spec sha via the _openapi_sha file (genkit no longer writes it into cli.json metadata) Co-authored-by: Isaac --- .codegen.json | 2 +- .codegen/cli.json | 7964 +++++++++++++---- Taskfile.yml | 45 +- bundle/docsgen/output/resources.md | 6 +- .../internal/schema/annotations_openapi.yml | 229 +- bundle/internal/schema/cli_json.go | 4 +- bundle/internal/schema/parser.go | 22 +- bundle/schema/jsonschema.json | 374 +- bundle/schema/jsonschema_for_docs.json | 194 + internal/cligen/cli_json_test.go | 11 +- .../bundles/jobs/_models/compute_config.py | 12 + .../bundles/jobs/_models/dbt_platform_task.py | 8 + .../jobs/_models/gen_ai_compute_task.py | 34 + .../databricks/bundles/jobs/_models/kind.py | 12 + .../_models/model_trigger_configuration.py | 20 + .../jobs/_models/python_operator_task.py | 8 + .../_models/python_operator_task_parameter.py | 12 + .../databricks/bundles/pipelines/__init__.py | 8 - .../bundles/pipelines/_models/file_filter.py | 12 + .../_models/file_ingestion_options.py | 54 + .../pipelines/_models/google_ads_config.py | 4 + .../pipelines/_models/google_ads_options.py | 12 + .../pipelines/_models/google_drive_options.py | 16 + .../pipelines/_models/ingestion_config.py | 5 +- .../ingestion_gateway_pipeline_definition.py | 26 +- ...ne_definition_workday_report_parameters.py | 44 +- ...rkday_report_parameters_query_key_value.py | 70 - .../_models/json_transformer_options.py | 20 + .../pipelines/_models/kafka_options.py | 20 + .../pipelines/_models/outlook_options.py | 58 +- .../pipelines/_models/restart_window.py | 12 + .../pipelines/_models/sharepoint_options.py | 12 + .../pipelines/_models/smartsheet_options.py | 4 + .../pipelines/_models/tik_tok_ads_options.py | 28 + .../bundles/pipelines/_models/transformer.py | 10 + .../_models/zendesk_support_options.py | 4 + 36 files changed, 7435 insertions(+), 1941 deletions(-) delete mode 100644 python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py diff --git a/.codegen.json b/.codegen.json index e2a84cb8c14..34630d45af2 100644 --- a/.codegen.json +++ b/.codegen.json @@ -1,5 +1,5 @@ { - "mode": "cli_v0", + "mode": "cli_v1", "api_changelog": true, "formatter": "go run golang.org/x/tools/cmd/goimports@latest -w $FILENAMES && go fmt ./...", "version": { diff --git a/.codegen/cli.json b/.codegen/cli.json index 3d78487bcb3..2e98a5a8f42 100644 --- a/.codegen/cli.json +++ b/.codegen/cli.json @@ -1,6 +1,5 @@ { "metadata": { - "openapi_sha": "c68a27fa9c9d838e839c584be8018eb3b68377d5", "generator_version": "cliv1" }, "schemas": { @@ -92,6 +91,8 @@ } } }, + "agentbricks.DeleteCustomLlmRequest": {}, + "agentbricks.GetCustomLlmRequest": {}, "agentbricks.StartCustomLlmOptimizationRunRequest": {}, "agentbricks.State": { "description": "States of Custom LLM optimization lifecycle.", @@ -159,17 +160,14 @@ ] }, "budget_policy_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "compute_max_instances": { "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "compute_min_instances": { "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "compute_size": { @@ -209,14 +207,12 @@ "launch_stage": "GA" }, "effective_budget_policy_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" ] }, "effective_usage_policy_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -224,7 +220,6 @@ }, "effective_user_api_scopes": { "description": "The effective api scopes granted to the user access token.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -247,14 +242,12 @@ "launch_stage": "GA" }, "oauth2_app_client_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" ] }, "oauth2_app_integration_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -292,11 +285,9 @@ }, "space": { "description": "Name of the space this app belongs to.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "telemetry_export_destinations": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "thumbnail_url": { @@ -328,11 +319,9 @@ ] }, "usage_policy_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "user_api_scopes": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -1108,12 +1097,10 @@ }, "compute_max_instances": { "description": "Maximum number of app instances. Must be set together with `compute_min_instances`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "compute_min_instances": { "description": "Minimum number of app instances. Must be set together with `compute_max_instances`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "compute_size": { @@ -1255,7 +1242,6 @@ "fields": { "active_instances": { "description": "The number of compute instances currently serving requests for this\napplication. An instance is considered active if it is reachable and ready\nto handle requests.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -1278,6 +1264,43 @@ } } }, + "apps.CreateAppDeploymentRequest": { + "fields": { + "app_deployment": { + "description": "The app deployment configuration.", + "ref": "apps.AppDeployment", + "launch_stage": "GA" + } + } + }, + "apps.CreateAppRequest": { + "fields": { + "app": { + "ref": "apps.App", + "launch_stage": "GA" + }, + "no_compute": { + "description": "If true, the app will not be started after creation.", + "launch_stage": "GA" + } + } + }, + "apps.CreateCustomTemplateRequest": { + "fields": { + "template": { + "ref": "apps.CustomTemplate", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.CreateSpaceRequest": { + "fields": { + "space": { + "ref": "apps.Space", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "apps.CustomTemplate": { "fields": { "creator": { @@ -1334,6 +1357,10 @@ } } }, + "apps.DeleteAppRequest": {}, + "apps.DeleteAppThumbnailRequest": {}, + "apps.DeleteCustomTemplateRequest": {}, + "apps.DeleteSpaceRequest": {}, "apps.EnvVar": { "fields": { "name": { @@ -1519,6 +1546,8 @@ "WORKSPACE_TEMPORARILY_UNAVAILABLE": "PRIVATE_PREVIEW" } }, + "apps.GetAppDeploymentRequest": {}, + "apps.GetAppPermissionLevelsRequest": {}, "apps.GetAppPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -1527,6 +1556,12 @@ } } }, + "apps.GetAppPermissionsRequest": {}, + "apps.GetAppRequest": {}, + "apps.GetAppUpdateRequest": {}, + "apps.GetCustomTemplateRequest": {}, + "apps.GetOperationRequest": {}, + "apps.GetSpaceRequest": {}, "apps.GitRepository": { "description": "Git repository configuration specifying the location of the repository.", "fields": { @@ -1576,6 +1611,18 @@ } } }, + "apps.ListAppDeploymentsRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "launch_stage": "GA" + } + } + }, "apps.ListAppDeploymentsResponse": { "fields": { "app_deployments": { @@ -1588,6 +1635,22 @@ } } }, + "apps.ListAppsRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Pagination token to go to the next page of apps. Requests first page if absent.", + "launch_stage": "GA" + }, + "space": { + "description": "Filter apps by app space name. When specified, only apps belonging to this space are returned.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "apps.ListAppsResponse": { "fields": { "apps": { @@ -1599,6 +1662,24 @@ } } }, + "apps.ListCustomTemplatesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of custom templates. Requests first page if absent.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "apps.ListCustomTemplatesResponse": { "fields": { "next_page_token": { @@ -1610,6 +1691,24 @@ } } }, + "apps.ListSpacesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of app spaces. Requests first page if absent.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "apps.ListSpacesResponse": { "fields": { "next_page_token": { @@ -1693,10 +1792,7 @@ }, "name": { "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "resources": { "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space.", @@ -1885,6 +1981,14 @@ } } }, + "apps.UpdateAppRequest": { + "fields": { + "app": { + "ref": "apps.App", + "launch_stage": "GA" + } + } + }, "apps.UpdateAppThumbnailRequest": { "fields": { "app_thumbnail": { @@ -1894,6 +1998,26 @@ } } }, + "apps.UpdateCustomTemplateRequest": { + "fields": { + "template": { + "ref": "apps.CustomTemplate", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "apps.UpdateSpaceRequest": { + "fields": { + "space": { + "ref": "apps.Space", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "billing.ActionConfiguration": { "fields": { "action_configuration_id": { @@ -2264,7 +2388,9 @@ } } }, + "billing.DeleteBudgetConfigurationRequest": {}, "billing.DeleteBudgetConfigurationResponse": {}, + "billing.DeleteBudgetPolicyRequest": {}, "billing.DeliveryStatus": { "description": "*\nThe status string for log delivery. Possible values are:\n`CREATED`: There were no log delivery attempts since the config was created.\n`SUCCEEDED`: The latest attempt of log delivery has succeeded completely.\n`USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage.\n`SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an Databricks internal error. Contact support if it doesn't go away soon.\n`NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account.", "enum": [ @@ -2282,6 +2408,29 @@ "USER_FAILURE": "GA" } }, + "billing.DownloadRequest": { + "fields": { + "end_month": { + "description": "Format: `YYYY-MM`. Last month to return billable usage logs for.\nThis field is required.", + "launch_stage": "GA" + }, + "personal_data": { + "description": "Specify whether to include personally identifiable information in\nthe billable usage logs, for example the email addresses of cluster\ncreators. Handle this information with care. Defaults to false.", + "launch_stage": "GA" + }, + "start_month": { + "description": "Format specification for month in the format `YYYY-MM`. This is\nused to specify billable usage `start_month` and `end_month`\nproperties. **Note**: Billable usage logs are unavailable before\nMarch 2019 (`2019-03`).", + "launch_stage": "GA" + } + } + }, + "billing.DownloadResponse": { + "fields": { + "contents": { + "launch_stage": "GA" + } + } + }, "billing.Filter": { "description": "Structured representation of a filter to be applied to a list of policies. All specified filters\nwill be applied in conjunction.", "fields": { @@ -2309,6 +2458,19 @@ } } }, + "billing.GetBillingUsageDashboardRequest": { + "fields": { + "dashboard_type": { + "description": "Workspace level usage dashboard shows usage data for the specified workspace ID. Global level usage dashboard shows usage data for all workspaces in the account.", + "ref": "billing.UsageDashboardType", + "launch_stage": "PUBLIC_PREVIEW" + }, + "workspace_id": { + "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "billing.GetBillingUsageDashboardResponse": { "fields": { "dashboard_id": { @@ -2321,6 +2483,7 @@ } } }, + "billing.GetBudgetConfigurationRequest": {}, "billing.GetBudgetConfigurationResponse": { "fields": { "budget": { @@ -2329,6 +2492,7 @@ } } }, + "billing.GetBudgetPolicyRequest": {}, "billing.GetLogDeliveryConfigurationResponse": { "fields": { "log_delivery_configuration": { @@ -2338,9 +2502,18 @@ } } }, + "billing.GetLogDeliveryRequest": {}, "billing.LimitConfig": { "description": "The limit configuration of the policy.\nLimit configuration provide a budget policy level cost control by enforcing the limit." }, + "billing.ListBudgetConfigurationsRequest": { + "fields": { + "page_token": { + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "billing.ListBudgetConfigurationsResponse": { "fields": { "budgets": { @@ -2352,6 +2525,40 @@ } } }, + "billing.ListBudgetPoliciesRequest": { + "fields": { + "filter_by": { + "description": "A filter to apply to the list of policies.", + "ref": "billing.Filter", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "The maximum number of budget policies to return.\nIf unspecified, at most 100 budget policies will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "sort_spec": { + "description": "The sort specification.", + "ref": "billing.SortSpec", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "billing.ListBudgetPoliciesResponse": { "description": "A list of policies.", "fields": { @@ -2368,6 +2575,27 @@ } } }, + "billing.ListLogDeliveryRequest": { + "fields": { + "credentials_id": { + "description": "The Credentials id to filter the search results with", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page.\nRequests first page if absent.", + "launch_stage": "GA" + }, + "status": { + "description": "The log delivery status to filter the search results with", + "ref": "billing.LogDeliveryConfigStatus", + "launch_stage": "GA" + }, + "storage_configuration_id": { + "description": "The Storage Configuration id to filter the search results with", + "launch_stage": "GA" + } + } + }, "billing.LogDeliveryConfigStatus": { "description": "*\nLog Delivery Status\n\n`ENABLED`: All dependencies have executed and succeeded\n`DISABLED`: At least one dependency has succeeded", "enum": [ @@ -2558,6 +2786,24 @@ } } }, + "billing.UpdateBudgetPolicyRequest": { + "fields": { + "limit_config": { + "description": "DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy", + "ref": "billing.LimitConfig", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "policy": { + "description": "The policy to update. `creator_user_id` cannot be specified in the request. All other fields\nmust be specified even if not changed. The `policy_id` is used to identify the policy to\nupdate.", + "ref": "billing.BudgetPolicy", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "billing.UpdateLogDeliveryConfigurationStatusRequest": { "description": "*\nUpdate Log Delivery Configuration", "fields": { @@ -2624,10 +2870,7 @@ "completion_reason": { "description": "The reason for completing the version. Must be a terminal reason:\nVERSION_COMPLETE_SUCCESS, VERSION_COMPLETE_FAILURE, or\nVERSION_COMPLETE_FORCE_ABORT.", "ref": "bundle.VersionComplete", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "force": { "description": "If true, force-completes the version even if the caller is not the\noriginal creator. The completion_reason must be\nVERSION_COMPLETE_FORCE_ABORT when force is true.", @@ -2638,6 +2881,46 @@ } } }, + "bundle.CreateDeploymentRequest": { + "fields": { + "deployment": { + "description": "The deployment to create.", + "ref": "bundle.Deployment", + "launch_stage": "PRIVATE_PREVIEW" + }, + "deployment_id": { + "description": "The ID to use for the deployment, which will become the final\ncomponent of the deployment's resource name\n(i.e. `deployments/{deployment_id}`).", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.CreateOperationRequest": { + "fields": { + "operation": { + "description": "The resource operation to create.", + "ref": "bundle.Operation", + "launch_stage": "PRIVATE_PREVIEW" + }, + "resource_key": { + "description": "The key identifying the resource this operation applies to.\nBecomes the final component of the operation's name.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.CreateVersionRequest": { + "fields": { + "version": { + "description": "The version to create.", + "ref": "bundle.Version", + "launch_stage": "PRIVATE_PREVIEW" + }, + "version_id": { + "description": "The version ID the caller expects to create. The server validates\nthis equals `last_version_id + 1` on the deployment. If it doesn't\nmatch, the server returns `ABORTED`.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "bundle.DeleteDeploymentRequest": {}, "bundle.Deployment": { "description": "A bundle deployment registered with the control plane.", "fields": { @@ -2801,6 +3084,10 @@ "DEPLOYMENT_STATUS_IN_PROGRESS": "PRIVATE_PREVIEW" } }, + "bundle.GetDeploymentRequest": {}, + "bundle.GetOperationRequest": {}, + "bundle.GetResourceRequest": {}, + "bundle.GetVersionRequest": {}, "bundle.HeartbeatRequest": { "description": "A request to send a heartbeat for a Version." }, @@ -2816,6 +3103,24 @@ } } }, + "bundle.ListDeploymentsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of deployments to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 deployments will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListDeployments` call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "bundle.ListDeploymentsResponse": { "description": "Response for ListDeployments.", "fields": { @@ -2832,6 +3137,24 @@ } } }, + "bundle.ListOperationsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of operations to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 operations will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListOperations` call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "bundle.ListOperationsResponse": { "description": "Response for ListOperations.", "fields": { @@ -2848,6 +3171,24 @@ } } }, + "bundle.ListResourcesRequest": { + "fields": { + "page_size": { + "description": "The maximum number of resources to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 resources will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListResources` call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "bundle.ListResourcesResponse": { "description": "Response for ListResources.", "fields": { @@ -2864,6 +3205,24 @@ } } }, + "bundle.ListVersionsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of versions to return. The service may return\nfewer than this value.\nIf unspecified, at most 50 versions will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListVersions` call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "bundle.ListVersionsResponse": { "description": "Response for ListVersions.", "fields": { @@ -2888,7 +3247,6 @@ "ref": "bundle.OperationActionType", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -2917,7 +3275,6 @@ "description": "ID reference for the actual resource in the workspace\n(e.g. the job ID, pipeline ID).", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -2948,7 +3305,6 @@ "ref": "bundle.OperationStatus", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] } @@ -3034,7 +3390,6 @@ "ref": "bundle.DeploymentResourceType", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -3054,7 +3409,6 @@ "description": "CLI version used to initiate the version.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -3143,7 +3497,6 @@ "ref": "bundle.VersionType", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] } @@ -3221,10 +3574,7 @@ "securable": { "description": "The securable for which the access request destinations are being modified or read.", "ref": "catalog.Securable", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "securable_type": { "description": "The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration", @@ -3644,7 +3994,7 @@ } } }, - "catalog.AzureUserDelegationSAS": { + "catalog.AzureUserDelegationSas": { "description": "Azure temporary credentials for API authentication.\nRead more at https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas", "fields": { "sas_token": { @@ -3669,6 +4019,7 @@ } } }, + "catalog.CancelRefreshRequest": {}, "catalog.CancelRefreshResponse": {}, "catalog.CatalogInfo": { "fields": { @@ -3892,17 +4243,11 @@ "fields": { "function_name": { "description": "The fully qualified name of the column mask function.\nThe function is called on each row of the target table.\nThe function's first argument and its return type should match the type of the masked column.\nRequired on create and update.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "on_column": { "description": "The alias of the column to be masked. The alias must refer to one of matched columns.\nThe values of the column is passed to the column mask function as the first argument.\nRequired on create and update.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "using": { "description": "Optional list of column aliases or constant literals to be passed as additional arguments to the column mask function.\nThe type of each column should match the positional argument of the column mask function.", @@ -4213,7 +4558,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -4350,6 +4694,22 @@ } } }, + "catalog.CreateEntityTagAssignmentRequest": { + "fields": { + "tag_assignment": { + "ref": "catalog.EntityTagAssignment", + "launch_stage": "GA" + } + } + }, + "catalog.CreateExternalLineageRelationshipRequest": { + "fields": { + "external_lineage_relationship": { + "ref": "catalog.CreateRequestExternalLineage", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.CreateExternalLocation": { "fields": { "comment": { @@ -4410,6 +4770,14 @@ } } }, + "catalog.CreateExternalMetadataRequest": { + "fields": { + "external_metadata": { + "ref": "catalog.ExternalMetadata", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.CreateFunction": { "fields": { "catalog_name": { @@ -4603,7 +4971,6 @@ "data_classification_config": { "description": "[Create:OPT Update:OPT] Data classification related config.", "ref": "catalog.MonitorDataClassificationConfig", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "inference_log": { @@ -4621,10 +4988,7 @@ }, "output_schema_name": { "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "schedule": { "description": "[Create:OPT Update:OPT] The monitor schedule.", @@ -4655,6 +5019,24 @@ } } }, + "catalog.CreateOnlineTableRequest": { + "fields": { + "table": { + "description": "Specification of the online table to be created.", + "ref": "catalog.OnlineTable", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.CreatePolicyRequest": { + "fields": { + "policy_info": { + "description": "Required. The policy to create.", + "ref": "catalog.PolicyInfo", + "launch_stage": "GA" + } + } + }, "catalog.CreateRegisteredModelRequest": { "fields": { "aliases": { @@ -4741,18 +5123,12 @@ "source": { "description": "Source object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "target": { "description": "Target object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -4780,6 +5156,15 @@ } } }, + "catalog.CreateSecretRequest": { + "fields": { + "secret": { + "description": "The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value**\nfields are required.", + "ref": "catalog.Secret", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "catalog.CreateStorageCredential": { "fields": { "aws_iam_role": { @@ -4800,7 +5185,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -4838,6 +5222,42 @@ } } }, + "catalog.CreateTableRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "columns": { + "description": "The array of __ColumnInfo__ definitions of the table's columns.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "data_source_format": { + "ref": "catalog.DataSourceFormat", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "Name of table, relative to parent schema.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "properties": { + "description": "A map of key-value properties attached to the securable.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "schema_name": { + "description": "Name of parent schema relative to its parent catalog.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "storage_location": { + "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "launch_stage": "PUBLIC_PREVIEW" + }, + "table_type": { + "ref": "catalog.TableType", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.CreateVolumeRequestContent": { "fields": { "catalog_name": { @@ -5020,6 +5440,7 @@ } } }, + "catalog.CurrentRequest": {}, "catalog.DataSourceFormat": { "description": "Data source format", "enum": [ @@ -5135,9 +5556,83 @@ } } }, + "catalog.DeleteAccountMetastoreAssignmentRequest": {}, + "catalog.DeleteAccountMetastoreRequest": { + "fields": { + "force": { + "description": "Force deletion even if the metastore is not empty. Default is false.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteAccountStorageCredentialRequest": { + "fields": { + "force": { + "description": "Force deletion even if the Storage Credential is not empty. Default is false.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteAliasRequest": {}, + "catalog.DeleteCatalogRequest": { + "fields": { + "force": { + "description": "Force deletion even if the catalog is not empty.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteConnectionRequest": {}, + "catalog.DeleteCredentialRequest": { + "fields": { + "force": { + "description": "Force an update even if there are dependent services (when purpose is\n**SERVICE**) or dependent external locations and external tables (when\npurpose is **STORAGE**).", + "launch_stage": "GA" + } + } + }, "catalog.DeleteCredentialResponse": {}, + "catalog.DeleteEntityTagAssignmentRequest": {}, + "catalog.DeleteExternalLineageRelationshipRequest": { + "fields": { + "external_lineage_relationship": { + "ref": "catalog.DeleteRequestExternalLineage", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "catalog.DeleteExternalLocationRequest": { + "fields": { + "force": { + "description": "Force deletion even if there are dependent external tables or mounts.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteExternalMetadataRequest": {}, + "catalog.DeleteFunctionRequest": { + "fields": { + "force": { + "description": "Force deletion even if the function is notempty.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteMetastoreRequest": { + "fields": { + "force": { + "description": "Force deletion even if the metastore is not empty. Default is false.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteModelVersionRequest": {}, "catalog.DeleteMonitorResponse": {}, + "catalog.DeleteOnlineTableRequest": {}, + "catalog.DeletePolicyRequest": {}, "catalog.DeletePolicyResponse": {}, + "catalog.DeleteQualityMonitorRequest": {}, + "catalog.DeleteRegisteredModelRequest": {}, "catalog.DeleteRequestExternalLineage": { "fields": { "id": { @@ -5150,24 +5645,49 @@ "source": { "description": "Source object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "target": { "description": "Target object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, "catalog.DeleteResponse": {}, + "catalog.DeleteSchemaRequest": { + "fields": { + "force": { + "description": "Force deletion even if the schema is not empty.", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteSecretRequest": {}, + "catalog.DeleteStorageCredentialRequest": { + "fields": { + "force": { + "description": "Force an update even if there are dependent external locations or external\ntables (when purpose is **STORAGE**) or dependent services (when purpose is\n**SERVICE**).", + "launch_stage": "GA" + } + } + }, + "catalog.DeleteTableConstraintRequest": { + "fields": { + "cascade": { + "description": "If true, try deleting all child constraints of the current constraint.\nIf false, reject this operation if the current constraint has any child constraints.", + "launch_stage": "GA" + }, + "constraint_name": { + "description": "The name of the constraint to delete.", + "launch_stage": "GA" + } + } + }, "catalog.DeleteTableConstraintResponse": {}, - "catalog.DeltaRuntimePropertiesKVPairs": { + "catalog.DeleteTableRequest": {}, + "catalog.DeleteVolumeRequest": {}, + "catalog.DeltaRuntimePropertiesKvPairs": { "description": "Properties pertaining to the current state of the delta table as given by the commit server.\nThis does not contain **delta.*** (input) properties in __TableInfo.properties__.", "fields": { "delta_runtime_properties": { @@ -5232,6 +5752,7 @@ "URL": "PUBLIC_PREVIEW" } }, + "catalog.DisableRequest": {}, "catalog.DisableResponse": {}, "catalog.EffectivePermissionsList": { "fields": { @@ -5315,6 +5836,14 @@ "INHERIT": "GA" } }, + "catalog.EnableRequest": { + "fields": { + "catalog_name": { + "description": "the catalog for which the system schema is to enabled in", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.EnableResponse": {}, "catalog.EncryptionDetails": { "description": "Encryption options that apply to clients connecting to cloud storage.", @@ -5351,7 +5880,6 @@ "description": "The fully qualified name of the entity to which the tag is assigned", "launch_stage": "GA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -5359,7 +5887,6 @@ "description": "The type of the entity to which the tag is assigned.", "launch_stage": "GA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -5375,7 +5902,6 @@ "description": "The key of the tag", "launch_stage": "GA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -5402,6 +5928,7 @@ } } }, + "catalog.ExistsRequest": {}, "catalog.ExternalLineageExternalMetadata": { "fields": { "name": { @@ -5566,18 +6093,12 @@ "source": { "description": "Source object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "target": { "description": "Target object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -5607,18 +6128,12 @@ "source": { "description": "Source object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "target": { "description": "Target object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -5774,10 +6289,7 @@ }, "entity_type": { "description": "Type of entity within the external system.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "id": { "description": "Unique identifier of the external metadata object.", @@ -5795,10 +6307,7 @@ }, "name": { "description": "Name of the external metadata object.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "owner": { "description": "Owner of the external metadata object.", @@ -5817,10 +6326,7 @@ "system_type": { "description": "Type of external system.", "ref": "catalog.SystemType", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "update_time": { "description": "Time at which this external metadata object was last modified.", @@ -6232,7 +6738,7 @@ "launch_stage": "GA" }, "azure_user_delegation_sas": { - "ref": "catalog.AzureUserDelegationSAS", + "ref": "catalog.AzureUserDelegationSas", "launch_stage": "GA" }, "expiration_time": { @@ -6311,7 +6817,7 @@ "launch_stage": "GA" }, "azure_user_delegation_sas": { - "ref": "catalog.AzureUserDelegationSAS", + "ref": "catalog.AzureUserDelegationSas", "launch_stage": "GA" }, "expiration_time": { @@ -6357,7 +6863,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "azure_user_delegation_sas": { - "ref": "catalog.AzureUserDelegationSAS", + "ref": "catalog.AzureUserDelegationSas", "launch_stage": "PUBLIC_PREVIEW" }, "expiration_time": { @@ -6378,6 +6884,39 @@ } } }, + "catalog.GetAccessRequestDestinationsRequest": {}, + "catalog.GetAccountMetastoreAssignmentRequest": {}, + "catalog.GetAccountMetastoreRequest": {}, + "catalog.GetAccountStorageCredentialRequest": {}, + "catalog.GetArtifactAllowlistRequest": {}, + "catalog.GetBindingsRequest": { + "fields": { + "max_results": { + "description": "Maximum number of workspace bindings to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the workspace bindings are returned (not recommended).", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, + "catalog.GetByAliasRequest": { + "fields": { + "include_aliases": { + "description": "Whether to include aliases associated with the model version in the response", + "launch_stage": "GA" + } + } + }, + "catalog.GetCatalogRequest": { + "fields": { + "include_browse": { + "description": "Whether to include catalogs in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, "catalog.GetCatalogWorkspaceBindingsResponse": { "fields": { "workspaces": { @@ -6386,6 +6925,59 @@ } } }, + "catalog.GetConnectionRequest": {}, + "catalog.GetCredentialRequest": {}, + "catalog.GetEffectiveRequest": { + "fields": { + "max_results": { + "description": "Specifies the maximum number of privileges to return (page length).\nEvery EffectivePrivilegeAssignment present in a single page response is guaranteed to contain all the effective\nprivileges granted on (or inherited by) the requested Securable for the respective principal.\n\nIf not set, all the effective permissions are returned.\nIf set to\n- lesser than 0: invalid parameter error\n- 0: page length is set to a server configured value\n- lesser than 150 but greater than 0: invalid parameter error (this is to ensure that server is able to return at\nleast one complete EffectivePrivilegeAssignment in a single page response)\n- greater than (or equal to) 150: page length is the minimum of this value and a server configured value", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token for the next page of results (pagination).", + "launch_stage": "GA" + }, + "principal": { + "description": "If provided, only the effective permissions for the specified principal (user or group) are returned.", + "launch_stage": "GA" + } + } + }, + "catalog.GetEntityTagAssignmentRequest": {}, + "catalog.GetExternalLocationRequest": { + "fields": { + "include_browse": { + "description": "Whether to include external locations in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, + "catalog.GetExternalMetadataRequest": {}, + "catalog.GetFunctionRequest": { + "fields": { + "include_browse": { + "description": "Whether to include functions in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, + "catalog.GetGrantRequest": { + "fields": { + "max_results": { + "description": "Specifies the maximum number of privileges to return (page length).\nEvery PrivilegeAssignment present in a single page response is guaranteed to contain all the privileges granted on\nthe requested Securable for the respective principal.\n\nIf not set, all the permissions are returned.\nIf set to\n- lesser than 0: invalid parameter error\n- 0: page length is set to a server configured value\n- lesser than 150 but greater than 0: invalid parameter error (this is to ensure that server is able to return at\nleast one complete PrivilegeAssignment in a single page response)\n- greater than (or equal to) 150: page length is the minimum of this value and a server configured value", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + }, + "principal": { + "description": "If provided, only the permissions for the specified principal (user or group) are returned.", + "launch_stage": "GA" + } + } + }, + "catalog.GetMetastoreRequest": {}, "catalog.GetMetastoreSummaryResponse": { "fields": { "cloud": { @@ -6468,6 +7060,19 @@ } } }, + "catalog.GetModelVersionRequest": { + "fields": { + "include_aliases": { + "description": "Whether to include aliases associated with the model version in the response", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include model versions in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, + "catalog.GetOnlineTableRequest": {}, "catalog.GetPermissionsResponse": { "fields": { "next_page_token": { @@ -6480,6 +7085,9 @@ } } }, + "catalog.GetPolicyRequest": {}, + "catalog.GetQualityMonitorRequest": {}, + "catalog.GetQuotaRequest": {}, "catalog.GetQuotaResponse": { "fields": { "quota_info": { @@ -6489,6 +7097,56 @@ } } }, + "catalog.GetRefreshRequest": {}, + "catalog.GetRegisteredModelRequest": { + "fields": { + "include_aliases": { + "description": "Whether to include registered model aliases in the response", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include registered models in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, + "catalog.GetSchemaRequest": { + "fields": { + "include_browse": { + "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, + "catalog.GetSecretRequest": { + "fields": { + "include_browse": { + "description": "Whether to include secrets in the response for which you only have the **BROWSE** privilege,\nwhich limits access to metadata.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "catalog.GetStorageCredentialRequest": {}, + "catalog.GetTableRequest": { + "fields": { + "include_browse": { + "description": "Whether to include tables in the response for which the principal can only access selective metadata for.", + "launch_stage": "GA" + }, + "include_delta_metadata": { + "description": "Whether delta metadata should be included in the response.", + "launch_stage": "GA" + }, + "include_manifest_capabilities": { + "description": "Whether to include a manifest containing table capabilities in the response.", + "launch_stage": "GA" + } + } + }, + "catalog.GetWorkspaceBindingRequest": {}, "catalog.GetWorkspaceBindingsResponse": { "fields": { "bindings": { @@ -6521,6 +7179,7 @@ "UPSTREAM": "PUBLIC_PREVIEW" } }, + "catalog.ListAccountMetastoreAssignmentsRequest": {}, "catalog.ListAccountMetastoreAssignmentsResponse": { "description": "The metastore assignments were successfully returned.", "fields": { @@ -6529,6 +7188,8 @@ } } }, + "catalog.ListAccountMetastoresRequest": {}, + "catalog.ListAccountStorageCredentialsRequest": {}, "catalog.ListAccountStorageCredentialsResponse": { "description": "The metastore storage credentials were successfully returned.", "fields": { @@ -6538,6 +7199,26 @@ } } }, + "catalog.ListCatalogsRequest": { + "fields": { + "include_browse": { + "description": "Whether to include catalogs in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "include_unbound": { + "description": "Whether to include catalogs not bound to the workspace.\nEffective only if the user has permission to update the catalog–workspace binding.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of catalogs to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid catalogs are returned (not recommended).\n- Note: The number of returned catalogs might be less than the specified max_results size, even zero.\nThe only definitive indication that no further catalogs can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListCatalogsResponse": { "fields": { "catalogs": { @@ -6550,6 +7231,18 @@ } } }, + "catalog.ListConnectionsRequest": { + "fields": { + "max_results": { + "description": "Maximum number of connections to return.\n- If not set, all connections are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListConnectionsResponse": { "fields": { "connections": { @@ -6562,6 +7255,27 @@ } } }, + "catalog.ListCredentialsRequest": { + "fields": { + "include_unbound": { + "description": "Whether to include credentials not bound to the workspace.\nEffective only if the user has permission to update the credential–workspace binding.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of credentials to return.\n- If not set, the default max page size is used.\n- When set to a value greater than 0, the page length is the minimum of\nthis value and a server-configured value.\n- When set to 0, the page length is set to a server-configured value\n(recommended).\n- When set to a value less than 0, an invalid parameter error is\nreturned.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token to retrieve the next page of results.", + "launch_stage": "GA" + }, + "purpose": { + "description": "Return only credentials for the specified purpose.", + "ref": "catalog.CredentialPurpose", + "launch_stage": "GA" + } + } + }, "catalog.ListCredentialsResponse": { "fields": { "credentials": { @@ -6573,6 +7287,24 @@ } } }, + "catalog.ListEntityTagAssignmentsRequest": { + "fields": { + "max_results": { + "description": "Optional. Maximum number of tag assignments to return in a single page", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Optional. Pagination token to retrieve the next page of results", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "catalog.ListEntityTagAssignmentsResponse": { "fields": { "next_page_token": { @@ -6585,6 +7317,28 @@ } } }, + "catalog.ListExternalLineageRelationshipsRequest": { + "fields": { + "lineage_direction": { + "description": "The lineage direction to filter on.", + "ref": "catalog.LineageDirection", + "launch_stage": "PUBLIC_PREVIEW" + }, + "object_info": { + "description": "The object to query external lineage relationships for.\nSince this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like:\n`object_info.table.name=main.sales.customers`", + "ref": "catalog.ExternalLineageObject", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "description": "Specifies the maximum number of external lineage relationships to return in a single response.\nThe value must be less than or equal to 1000.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.ListExternalLineageRelationshipsResponse": { "fields": { "external_lineage_relationships": { @@ -6595,6 +7349,26 @@ } } }, + "catalog.ListExternalLocationsRequest": { + "fields": { + "include_browse": { + "description": "Whether to include external locations in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "include_unbound": { + "description": "Whether to include external locations not bound to the workspace.\nEffective only if the user has permission to update the location–workspace binding.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of external locations to return.\nIf not set, all the external locations are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListExternalLocationsResponse": { "fields": { "external_locations": { @@ -6607,6 +7381,24 @@ } } }, + "catalog.ListExternalMetadataRequest": { + "fields": { + "page_size": { + "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "catalog.ListExternalMetadataResponse": { "fields": { "external_metadata": { @@ -6617,6 +7409,30 @@ } } }, + "catalog.ListFunctionsRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog for functions of interest.", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include functions in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of functions to return.\nIf not set, all the functions are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + }, + "schema_name": { + "description": "Parent schema of functions.", + "launch_stage": "GA" + } + } + }, "catalog.ListFunctionsResponse": { "fields": { "functions": { @@ -6629,6 +7445,18 @@ } } }, + "catalog.ListMetastoresRequest": { + "fields": { + "max_results": { + "description": "Maximum number of metastores to return.\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the metastores are returned (not recommended).\n- Note: The number of returned metastores might be less than the specified max_results size, even zero.\nThe only definitive indication that no further metastores can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListMetastoresResponse": { "fields": { "metastores": { @@ -6641,6 +7469,22 @@ } } }, + "catalog.ListModelVersionsRequest": { + "fields": { + "include_browse": { + "description": "Whether to include model versions in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of model versions to return.\nIf not set, the page length is set to a server configured value (100, as of 1/3/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value(1000, as of 1/3/2024);\n- when set to 0, the page length is set to a server configured value (100, as of 1/3/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListModelVersionsResponse": { "fields": { "model_versions": { @@ -6652,6 +7496,31 @@ } } }, + "catalog.ListPoliciesRequest": { + "fields": { + "include_inherited": { + "description": "Optional. Whether to include policies defined on parent securables.\nBy default, the inherited policies are not included.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "max_results": { + "description": "Optional. Maximum number of policies to return on a single page (page length).\n- When not set or set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Optional. Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "catalog.ListPoliciesResponse": { "fields": { "next_page_token": { @@ -6670,6 +7539,18 @@ } } }, + "catalog.ListQuotasRequest": { + "fields": { + "max_results": { + "description": "The number of quotas to return.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token for the next page of results.", + "launch_stage": "GA" + } + } + }, "catalog.ListQuotasResponse": { "fields": { "next_page_token": { @@ -6682,6 +7563,31 @@ } } }, + "catalog.ListRefreshesRequest": {}, + "catalog.ListRegisteredModelsRequest": { + "fields": { + "catalog_name": { + "description": "The identifier of the catalog under which to list registered models.\nIf specified, schema_name must be specified.", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include registered models in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "max_results": { + "description": "Max number of registered models to return.\n\nIf both catalog and schema are specified:\n- when max_results is not specified, the page length is set to a server configured value (10000, as of 4/2/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 4/2/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 4/2/2024);\n- when set to a value less than 0, an invalid parameter error is returned;\n\nIf neither schema nor catalog is specified:\n- when max_results is not specified, the page length is set to a server configured value (100, as of 4/2/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (1000, as of 4/2/2024);\n- when set to 0, the page length is set to a server configured value (100, as of 4/2/2024);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token to send for the next page of results (pagination).", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The identifier of the schema under which to list registered models.\nIf specified, catalog_name must be specified.", + "launch_stage": "GA" + } + } + }, "catalog.ListRegisteredModelsResponse": { "fields": { "next_page_token": { @@ -6693,6 +7599,26 @@ } } }, + "catalog.ListSchemasRequest": { + "fields": { + "catalog_name": { + "description": "Parent catalog for schemas of interest.", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of schemas to return.\nIf not set, all the schemas are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListSchemasResponse": { "fields": { "next_page_token": { @@ -6705,6 +7631,45 @@ } } }, + "catalog.ListSecretsRequest": { + "fields": { + "catalog_name": { + "description": "The name of the catalog under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "include_browse": { + "description": "Whether to include secrets in the response for which you only have the **BROWSE** privilege,\nwhich limits access to metadata.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "Maximum number of secrets to return.\n\n- If not specified, at most 10000 secrets are returned.\n- If set to a value greater than 0, the page length is the minimum of this value and 10000.\n- If set to 0, the page length is set to 10000.\n- If set to a value less than 0, an invalid parameter error is returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque pagination token to go to the next page based on previous query. The maximum page length\nis determined by a server configured value.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "schema_name": { + "description": "The name of the schema under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "catalog.ListSecretsResponse": { "description": "Response message for ListSecrets.", "fields": { @@ -6724,6 +7689,22 @@ } } }, + "catalog.ListStorageCredentialsRequest": { + "fields": { + "include_unbound": { + "description": "Whether to include credentials not bound to the workspace.\nEffective only if the user has permission to update the credential–workspace binding.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of storage credentials to return.\nIf not set, all the storage credentials are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of\nthis value and a server configured value;\n- when set to 0, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "catalog.ListStorageCredentialsResponse": { "fields": { "next_page_token": { @@ -6735,6 +7716,46 @@ } } }, + "catalog.ListSummariesRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog for tables of interest.", + "launch_stage": "GA" + }, + "include_manifest_capabilities": { + "description": "Whether to include a manifest containing table capabilities in the response.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of summaries for tables to return.\nIf not set, the page length is set to a server configured value (10000, as of 1/5/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/5/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 1/5/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + }, + "schema_name_pattern": { + "description": "A sql LIKE pattern (% and _) for schema names.\nAll schemas will be returned if not set or empty.", + "launch_stage": "GA" + }, + "table_name_pattern": { + "description": "A sql LIKE pattern (% and _) for table names.\nAll tables will be returned if not set or empty.", + "launch_stage": "GA" + } + } + }, + "catalog.ListSystemSchemasRequest": { + "fields": { + "max_results": { + "description": "Maximum number of schemas to return.\n- When set to 0, the page length is set to a server configured value (recommended);\n- When set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- When set to a value less than 0, an invalid parameter error is returned;\n- If not set, all the schemas are returned (not recommended).", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.ListSystemSchemasResponse": { "fields": { "next_page_token": { @@ -6759,6 +7780,46 @@ } } }, + "catalog.ListTablesRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog for tables of interest.", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include tables in the response for which the principal can only access selective metadata for.", + "launch_stage": "GA" + }, + "include_manifest_capabilities": { + "description": "Whether to include a manifest containing table capabilities in the response.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of tables to return.\nIf not set, all the tables are returned (not recommended).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;", + "launch_stage": "GA" + }, + "omit_columns": { + "description": "Whether to omit the columns of the table from the response or not.", + "launch_stage": "GA" + }, + "omit_properties": { + "description": "Whether to omit the properties of the table from the response or not.", + "launch_stage": "GA" + }, + "omit_username": { + "description": "Whether to omit the username of the table (e.g. owner, updated_by, created_by) from the response or not.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token to send for the next page of results (pagination).", + "launch_stage": "GA" + }, + "schema_name": { + "description": "Parent schema of tables.", + "launch_stage": "GA" + } + } + }, "catalog.ListTablesResponse": { "fields": { "next_page_token": { @@ -6771,6 +7832,30 @@ } } }, + "catalog.ListVolumesRequest": { + "fields": { + "catalog_name": { + "description": "The identifier of the catalog", + "launch_stage": "GA" + }, + "include_browse": { + "description": "Whether to include volumes in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of volumes to return (page length).\n\nIf not set, the page length is set to a server configured value (10000, as of 1/29/2024).\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/29/2024);\n- when set to 0, the page length is set to a server configured value (10000, as of 1/29/2024) (recommended);\n- when set to a value less than 0, an invalid parameter error is returned;\n\nNote: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page\nmay be smaller than this value, including 0, even if there are more pages.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).", + "launch_stage": "GA" + }, + "schema_name": { + "description": "The identifier of the schema", + "launch_stage": "GA" + } + } + }, "catalog.ListVolumesResponseContent": { "fields": { "next_page_token": { @@ -7001,17 +8086,11 @@ }, "quartz_cron_expression": { "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "timezone_id": { "description": "The timezone id (e.g., ``PST``) in which to evaluate the quartz expression.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -7049,10 +8128,7 @@ "fields": { "granularities": { "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "label_col": { "description": "Column for the label.", @@ -7060,17 +8136,11 @@ }, "model_id_col": { "description": "Column for the model identifier.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "prediction_col": { "description": "Column for the prediction.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "prediction_proba_col": { "description": "Column for prediction probabilities", @@ -7079,17 +8149,11 @@ "problem_type": { "description": "Problem type the model aims to solve.", "ref": "catalog.MonitorInferenceLogProblemType", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "timestamp_col": { "description": "Column for the timestamp.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -7124,7 +8188,6 @@ "data_classification_config": { "description": "[Create:OPT Update:OPT] Data classification related config.", "ref": "catalog.MonitorDataClassificationConfig", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "drift_metrics_table_name": { @@ -7150,10 +8213,7 @@ }, "output_schema_name": { "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "profile_metrics_table_name": { "description": "[Create:ERR Update:IGN] Table that stores profile metrics data. Format: `catalog.schema.table_name`.", @@ -7210,39 +8270,24 @@ "fields": { "definition": { "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "input_columns": { "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "name": { "description": "Name of the metric in the output tables.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "output_data_type": { "description": "The output type of the custom metric.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "type": { "description": "Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or ``\"CUSTOM_METRIC_TYPE_DRIFT\"``.\nThe ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics\nare computed on a single table, whereas the ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics", "ref": "catalog.MonitorMetricType", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -7269,7 +8314,6 @@ "on_new_classification_tag_detected": { "description": "Destinations to send notifications on new classification tag detected.", "ref": "catalog.MonitorDestination", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -7286,25 +8330,16 @@ }, "refresh_id": { "description": "Unique id of the refresh operation.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "start_time_ms": { "description": "Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "state": { "description": "The current state of the refresh.", "ref": "catalog.MonitorRefreshInfoState", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "trigger": { "description": "The method by which the refresh was triggered.", @@ -7360,17 +8395,11 @@ "fields": { "granularities": { "description": "Granularities for aggregating data into time windows based on their timestamp. Currently the following static\ngranularities are supported:\n{``\\\"5 minutes\\\"``, ``\\\"30 minutes\\\"``, ``\\\"1 hour\\\"``, ``\\\"1 day\\\"``, ``\\\"\\u003cn\\u003e week(s)\\\"``, ``\\\"1 month\\\"``, ``\\\"1 year\\\"``}.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "timestamp_col": { "description": "Column for the timestamp.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -7744,10 +8773,7 @@ "for_securable_type": { "description": "Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update.", "ref": "catalog.SecurableType", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "id": { "description": "Unique identifier of the policy. This field is output only and is generated by the system.", @@ -7779,10 +8805,7 @@ "policy_type": { "description": "Type of the policy. Required on create.", "ref": "catalog.PolicyType", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "row_filter": { "description": "Options for row filter policies. Valid only if `policy_type` is `POLICY_TYPE_ROW_FILTER`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole.", @@ -7794,10 +8817,7 @@ }, "to_principals": { "description": "List of user or group names that the policy applies to.\nRequired on create and optional on update.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "updated_at": { "description": "Time at which the policy was last modified, in epoch milliseconds. Output only.", @@ -8078,6 +9098,14 @@ } } }, + "catalog.ReadVolumeRequest": { + "fields": { + "include_browse": { + "description": "Whether to include volumes in the response for which the principal can only access selective metadata for", + "launch_stage": "GA" + } + } + }, "catalog.RegenerateDashboardRequest": { "fields": { "warehouse_id": { @@ -8189,10 +9217,7 @@ "fields": { "function_name": { "description": "The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "using": { "description": "Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function.", @@ -8203,6 +9228,7 @@ } } }, + "catalog.RunRefreshRequest": {}, "catalog.SchemaInfo": { "description": "Next ID: 45", "fields": { @@ -8296,7 +9322,6 @@ "description": "The name of the catalog where the schema and the secret reside.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -8366,7 +9391,6 @@ "description": "The name of the secret, relative to its parent schema.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -8374,15 +9398,14 @@ "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "schema_name": { "description": "The name of the schema where the secret resides.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -8404,7 +9427,6 @@ "description": "The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "INPUT_ONLY" ] } @@ -8750,7 +9772,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -8813,6 +9834,7 @@ } } }, + "catalog.SummaryRequest": {}, "catalog.SystemSchemaInfo": { "fields": { "schema": { @@ -8956,7 +9978,7 @@ }, "delta_runtime_properties_kvpairs": { "description": "Information pertaining to current state of the delta table.", - "ref": "catalog.DeltaRuntimePropertiesKVPairs", + "ref": "catalog.DeltaRuntimePropertiesKvPairs", "launch_stage": "GA" }, "effective_predictive_optimization_flag": { @@ -8969,7 +9991,6 @@ }, "encryption_details": { "ref": "catalog.EncryptionDetails", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "full_name": { @@ -9183,7 +10204,28 @@ } } }, + "catalog.UnassignRequest": { + "fields": { + "metastore_id": { + "description": "Query for the ID of the metastore to delete.", + "launch_stage": "GA" + } + } + }, "catalog.UnassignResponse": {}, + "catalog.UpdateAccessRequestDestinationsRequest": { + "fields": { + "access_request_destinations": { + "description": "The access request destinations to assign to the securable.\nFor each destination, a **destination_id** and **destination_type** must be defined.", + "ref": "catalog.AccessRequestDestinations", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.UpdateAccountsMetastore": { "fields": { "delta_sharing_organization_name": { @@ -9237,7 +10279,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -9381,6 +10422,30 @@ } } }, + "catalog.UpdateEntityTagAssignmentRequest": { + "fields": { + "tag_assignment": { + "ref": "catalog.EntityTagAssignment", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateExternalLineageRelationshipRequest": { + "fields": { + "external_lineage_relationship": { + "ref": "catalog.UpdateRequestExternalLineage", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.UpdateExternalLocation": { "fields": { "comment": { @@ -9453,6 +10518,18 @@ } } }, + "catalog.UpdateExternalMetadataRequest": { + "fields": { + "external_metadata": { + "ref": "catalog.ExternalMetadata", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "catalog.UpdateFunction": { "fields": { "owner": { @@ -9599,7 +10676,6 @@ "data_classification_config": { "description": "[Create:OPT Update:OPT] Data classification related config.", "ref": "catalog.MonitorDataClassificationConfig", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "inference_log": { @@ -9617,10 +10693,7 @@ }, "output_schema_name": { "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "schedule": { "description": "[Create:OPT Update:OPT] The monitor schedule.", @@ -9659,6 +10732,22 @@ } } }, + "catalog.UpdatePolicyRequest": { + "fields": { + "policy_info": { + "description": "Optional fields to update. This is the request body for updating a policy.\nUse `update_mask` field to specify which fields in the request is to be updated.\n- If `update_mask` is empty or \"*\", all specified fields will be updated.\n- If `update_mask` is specified, only the fields specified in the `update_mask` will be updated.\nIf a field is specified in `update_mask` and not set in the request, the field will be cleared.\nUsers can use the update mask to explicitly unset optional fields such as\n`exception_principals` and `when_condition`.", + "ref": "catalog.PolicyInfo", + "launch_stage": "GA" + }, + "update_mask": { + "description": "Optional. The update mask field for specifying user intentions on which\nfields to update in the request.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "catalog.UpdateRegisteredModelRequest": { "fields": { "aliases": { @@ -9745,18 +10834,12 @@ "source": { "description": "Source object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "target": { "description": "Target object of the external lineage relationship.", "ref": "catalog.ExternalLineageObject", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -9786,6 +10869,19 @@ } } }, + "catalog.UpdateSecretRequest": { + "fields": { + "secret": { + "description": "The secret object containing the fields to update. Only fields specified in **update_mask**\nwill be updated.", + "ref": "catalog.Secret", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The field mask specifying which fields of the secret to update. Supported fields: **value**,\n**comment**, **owner**, **expire_time**.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "catalog.UpdateStorageCredential": { "fields": { "aws_iam_role": { @@ -9806,7 +10902,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -9845,6 +10940,14 @@ } } }, + "catalog.UpdateTableRequest": { + "fields": { + "owner": { + "description": "Username of current owner of table.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "catalog.UpdateVolumeRequestContent": { "fields": { "comment": { @@ -9861,6 +10964,30 @@ } } }, + "catalog.UpdateWorkspaceBindings": { + "fields": { + "assign_workspaces": { + "description": "A list of workspace IDs.", + "launch_stage": "GA" + }, + "unassign_workspaces": { + "description": "A list of workspace IDs.", + "launch_stage": "GA" + } + } + }, + "catalog.UpdateWorkspaceBindingsParameters": { + "fields": { + "add": { + "description": "List of workspace bindings to add. If a binding for the workspace already exists with a\ndifferent binding_type, adding it again with a new binding_type will update the existing\nbinding (e.g., from READ_WRITE to READ_ONLY).", + "launch_stage": "GA" + }, + "remove": { + "description": "List of workspace bindings to remove.", + "launch_stage": "GA" + } + } + }, "catalog.UpdateWorkspaceBindingsResponse": { "description": "A list of workspace IDs that are bound to the securable", "fields": { @@ -9953,7 +11080,6 @@ "cloudflare_api_token": { "description": "The Cloudflare API token configuration.", "ref": "catalog.CloudflareApiToken", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "databricks_gcp_service_account": { @@ -10075,7 +11201,6 @@ }, "encryption_details": { "ref": "catalog.EncryptionDetails", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -10158,89 +11283,11 @@ "MANAGED": "GA" } }, - "catalog.cancelRefreshRequest": {}, - "catalog.createTableRequest": { - "fields": { - "catalog_name": { - "description": "Name of parent catalog.", - "launch_stage": "PUBLIC_PREVIEW" - }, - "columns": { - "description": "The array of __ColumnInfo__ definitions of the table's columns.", - "launch_stage": "PUBLIC_PREVIEW" - }, - "data_source_format": { - "ref": "catalog.DataSourceFormat", - "launch_stage": "PUBLIC_PREVIEW" - }, - "name": { - "description": "Name of table, relative to parent schema.", - "launch_stage": "PUBLIC_PREVIEW" - }, - "properties": { - "description": "A map of key-value properties attached to the securable.", - "launch_stage": "PUBLIC_PREVIEW" - }, - "schema_name": { - "description": "Name of parent schema relative to its parent catalog.", - "launch_stage": "PUBLIC_PREVIEW" - }, - "storage_location": { - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", - "launch_stage": "PUBLIC_PREVIEW" - }, - "table_type": { - "ref": "catalog.TableType", - "launch_stage": "PUBLIC_PREVIEW" - } - } - }, - "catalog.enableRequest": { - "fields": { - "catalog_name": { - "description": "the catalog for which the system schema is to enabled in", - "launch_stage": "PUBLIC_PREVIEW" - } - } - }, - "catalog.runRefreshRequest": {}, - "catalog.updateTableRequest": { - "fields": { - "owner": { - "description": "Username of current owner of table.", - "launch_stage": "PRIVATE_PREVIEW" - } - } - }, - "catalog.updateWorkspaceBindings": { - "fields": { - "assign_workspaces": { - "description": "A list of workspace IDs.", - "launch_stage": "GA" - }, - "unassign_workspaces": { - "description": "A list of workspace IDs.", - "launch_stage": "GA" - } - } - }, - "catalog.updateWorkspaceBindingsParameters": { - "fields": { - "add": { - "description": "List of workspace bindings to add. If a binding for the workspace already exists with a\ndifferent binding_type, adding it again with a new binding_type will update the existing\nbinding (e.g., from READ_WRITE to READ_ONLY).", - "launch_stage": "GA" - }, - "remove": { - "description": "List of workspace bindings to remove.", - "launch_stage": "GA" - } - } - }, - "catalog.workspaceBinding": { + "catalog.WorkspaceBinding": { "fields": { "binding_type": { "description": "One of READ_WRITE/READ_ONLY. Default is READ_WRITE.", - "ref": "catalog.workspaceBindingBindingType", + "ref": "catalog.WorkspaceBindingBindingType", "launch_stage": "GA" }, "workspace_id": { @@ -10249,7 +11296,7 @@ } } }, - "catalog.workspaceBindingBindingType": { + "catalog.WorkspaceBindingBindingType": { "description": "Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in `credentials_common.proto`.", "enum": [ "BINDING_TYPE_READ_WRITE", @@ -10351,10 +11398,7 @@ "asset_type": { "description": "The type of the asset.", "ref": "cleanrooms.CleanRoomAssetAssetType", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "clean_room_name": { "description": "The name of the clean room this asset belongs to.\nThis field is required for create operations and populated by the server for responses.", @@ -10381,10 +11425,7 @@ }, "name": { "description": "A fully qualified name that uniquely identifies the asset within the clean room.\nThis is also the name displayed in the clean room UI.\n\nFor UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name*\n\nFor notebooks, the name is the notebook file name.\nFor jar analyses, the name is the jar analysis name.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "notebook": { "description": "Notebook details available to all collaborators of the clean room.\nPresent if and only if **asset_type** is **NOTEBOOK_FILE**", @@ -10482,10 +11523,7 @@ "fields": { "local_name": { "description": "The fully qualified name of the foreign table in its owner's local metastore,\nin the format of *catalog*.*schema*.*foreign_table_name*", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -10500,10 +11538,7 @@ }, "notebook_content": { "description": "Base 64 representation of the notebook contents.\nThis is the same format as returned by :method:workspace/export with the format of **HTML**.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "review_state": { "description": "Top-level status derived from all reviews", @@ -10556,10 +11591,7 @@ "fields": { "local_name": { "description": "The fully qualified name of the table in its owner's local metastore,\nin the format of *catalog*.*schema*.*table_name*", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "partitions": { "description": "Partition filtering specification for a shared table.", @@ -10585,10 +11617,7 @@ "fields": { "local_name": { "description": "The fully qualified name of the view in its owner's local metastore,\nin the format of *catalog*.*schema*.*view_name*", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -10596,10 +11625,7 @@ "fields": { "local_name": { "description": "The fully qualified name of the volume in its owner's local metastore,\nin the format of *catalog*.*schema*.*volume_name*", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -10934,6 +11960,14 @@ } } }, + "cleanrooms.CreateCleanRoomAssetRequest": { + "fields": { + "asset": { + "ref": "cleanrooms.CleanRoomAsset", + "launch_stage": "GA" + } + } + }, "cleanrooms.CreateCleanRoomAssetReviewRequest": { "fields": { "notebook_review": { @@ -10963,20 +11997,58 @@ } } }, + "cleanrooms.CreateCleanRoomOutputCatalogRequest": { + "fields": { + "output_catalog": { + "ref": "cleanrooms.CleanRoomOutputCatalog", + "launch_stage": "GA" + } + } + }, "cleanrooms.CreateCleanRoomOutputCatalogResponse": { "fields": { "output_catalog": { "ref": "cleanrooms.CleanRoomOutputCatalog", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" + } + } + }, + "cleanrooms.CreateCleanRoomRequest": { + "fields": { + "clean_room": { + "ref": "cleanrooms.CleanRoom", + "launch_stage": "GA" } } }, + "cleanrooms.DeleteCleanRoomAssetRequest": {}, "cleanrooms.DeleteCleanRoomAssetResponse": { "description": "Response for delete clean room request. Using an empty message since the generic Empty proto does not externd\nUnshadedMessageMarker." }, + "cleanrooms.DeleteCleanRoomAutoApprovalRuleRequest": {}, + "cleanrooms.DeleteCleanRoomRequest": {}, + "cleanrooms.GetCleanRoomAssetRequest": {}, + "cleanrooms.GetCleanRoomAssetRevisionRequest": {}, + "cleanrooms.GetCleanRoomAutoApprovalRuleRequest": {}, + "cleanrooms.GetCleanRoomRequest": {}, + "cleanrooms.ListCleanRoomAssetRevisionsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of asset revisions to return. Defaults to 10.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on the previous query.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "cleanrooms.ListCleanRoomAssetRevisionsResponse": { "fields": { "next_page_token": { @@ -10987,6 +12059,17 @@ } } }, + "cleanrooms.ListCleanRoomAssetsRequest": { + "fields": { + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "cleanrooms.ListCleanRoomAssetsResponse": { "fields": { "assets": { @@ -10999,6 +12082,24 @@ } } }, + "cleanrooms.ListCleanRoomAutoApprovalRulesRequest": { + "fields": { + "page_size": { + "description": "Maximum number of auto-approval rules to return. Defaults to 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "cleanrooms.ListCleanRoomAutoApprovalRulesResponse": { "fields": { "next_page_token": { @@ -11010,6 +12111,22 @@ } } }, + "cleanrooms.ListCleanRoomNotebookTaskRunsRequest": { + "fields": { + "notebook_name": { + "description": "Notebook name", + "launch_stage": "GA" + }, + "page_size": { + "description": "The maximum number of task runs to return. Currently ignored - all runs will be returned.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "cleanrooms.ListCleanRoomNotebookTaskRunsResponse": { "fields": { "next_page_token": { @@ -11022,6 +12139,18 @@ } } }, + "cleanrooms.ListCleanRoomsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of clean rooms to return (i.e., the page length). Defaults to 100.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "cleanrooms.ListCleanRoomsResponse": { "fields": { "clean_rooms": { @@ -11050,6 +12179,24 @@ } } }, + "cleanrooms.UpdateCleanRoomAssetRequest": { + "fields": { + "asset": { + "description": "The asset to update.\nThe asset's `name` and `asset_type` fields are used to identify the asset to update.", + "ref": "cleanrooms.CleanRoomAsset", + "launch_stage": "GA" + } + } + }, + "cleanrooms.UpdateCleanRoomAutoApprovalRuleRequest": { + "fields": { + "auto_approval_rule": { + "description": "The auto-approval rule to update. The rule_id field is used to identify the rule to update.", + "ref": "cleanrooms.CleanRoomAutoApprovalRule", + "launch_stage": "PUBLIC_BETA" + } + } + }, "cleanrooms.UpdateCleanRoomRequest": { "fields": { "clean_room": { @@ -11381,7 +12528,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "node_type_id": { @@ -11582,7 +12729,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "last_restarted_time": { @@ -12025,7 +13172,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "node_type_id": { @@ -12088,6 +13235,14 @@ } } }, + "compute.ClusterStatus": { + "fields": { + "cluster_id": { + "description": "Unique identifier of the cluster whose status should be retrieved.", + "launch_stage": "GA" + } + } + }, "compute.Command": { "fields": { "clusterId": { @@ -12126,6 +13281,19 @@ "Running": "GA" } }, + "compute.CommandStatusRequest": { + "fields": { + "clusterId": { + "launch_stage": "GA" + }, + "commandId": { + "launch_stage": "GA" + }, + "contextId": { + "launch_stage": "GA" + } + } + }, "compute.CommandStatusResponse": { "fields": { "id": { @@ -12164,6 +13332,16 @@ "Running": "GA" } }, + "compute.ContextStatusRequest": { + "fields": { + "clusterId": { + "launch_stage": "GA" + }, + "contextId": { + "launch_stage": "GA" + } + } + }, "compute.ContextStatusResponse": { "fields": { "id": { @@ -12266,7 +13444,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "node_type_id": { @@ -12579,6 +13757,7 @@ } }, "compute.DeleteClusterResponse": {}, + "compute.DeleteGlobalInitScriptRequest": {}, "compute.DeleteInstancePool": { "fields": { "instance_pool_id": { @@ -12794,7 +13973,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "node_type_id": { @@ -12992,7 +14171,6 @@ }, "java_dependencies": { "description": "List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -13195,7 +14373,6 @@ "confidential_compute_type": { "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "ref": "compute.ConfidentialComputeType", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "first_on_demand": { @@ -13243,6 +14420,14 @@ } } }, + "compute.GetClusterComplianceRequest": { + "fields": { + "cluster_id": { + "description": "The ID of the cluster to get the compliance status", + "launch_stage": "GA" + } + } + }, "compute.GetClusterComplianceResponse": { "fields": { "is_compliant": { @@ -13255,6 +14440,7 @@ } } }, + "compute.GetClusterPermissionLevelsRequest": {}, "compute.GetClusterPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -13263,6 +14449,8 @@ } } }, + "compute.GetClusterPermissionsRequest": {}, + "compute.GetClusterPolicyPermissionLevelsRequest": {}, "compute.GetClusterPolicyPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -13271,6 +14459,23 @@ } } }, + "compute.GetClusterPolicyPermissionsRequest": {}, + "compute.GetClusterPolicyRequest": { + "fields": { + "policy_id": { + "description": "Canonical unique identifier for the Cluster Policy.", + "launch_stage": "GA" + } + } + }, + "compute.GetClusterRequest": { + "fields": { + "cluster_id": { + "description": "The cluster about which to retrieve information.", + "launch_stage": "GA" + } + } + }, "compute.GetEvents": { "fields": { "cluster_id": { @@ -13350,6 +14555,7 @@ } } }, + "compute.GetGlobalInitScriptRequest": {}, "compute.GetInstancePool": { "fields": { "aws_attributes": { @@ -13446,6 +14652,7 @@ } } }, + "compute.GetInstancePoolPermissionLevelsRequest": {}, "compute.GetInstancePoolPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -13454,6 +14661,23 @@ } } }, + "compute.GetInstancePoolPermissionsRequest": {}, + "compute.GetInstancePoolRequest": { + "fields": { + "instance_pool_id": { + "description": "The canonical unique identifier for the instance pool.", + "launch_stage": "GA" + } + } + }, + "compute.GetPolicyFamilyRequest": { + "fields": { + "version": { + "description": "The version number for the family to fetch. Defaults to the latest version.", + "launch_stage": "GA" + } + } + }, "compute.GetSparkVersionsResponse": { "fields": { "versions": { @@ -13887,7 +15111,6 @@ }, "instance_profile_arn": { "description": "All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances\nwill initially be launched with the workspace's default instance profile. If defined, clusters that use the\npool will inherit the instance profile, and must not specify their own instance profile on cluster creation or\nupdate. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.\nThe instance profile must have previously been added to the Databricks environment by an account administrator.\n\nThis feature may only be available to certain customer plans.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "spot_bid_price_percent": { @@ -14062,6 +15285,15 @@ } } }, + "compute.Kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", + "enum": [ + "CLASSIC_PREVIEW" + ], + "enum_launch_stages": { + "CLASSIC_PREVIEW": "GA" + } + }, "compute.Language": { "enum": [ "python", @@ -14158,6 +15390,7 @@ "UNINSTALL_ON_RESTART": "GA" } }, + "compute.ListAllClusterLibraryStatuses": {}, "compute.ListAllClusterLibraryStatusesResponse": { "fields": { "statuses": { @@ -14178,6 +15411,22 @@ } } }, + "compute.ListClusterCompliancesRequest": { + "fields": { + "page_size": { + "description": "Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "Canonical unique identifier for the cluster policy.", + "launch_stage": "GA" + } + } + }, "compute.ListClusterCompliancesResponse": { "fields": { "clusters": { @@ -14194,6 +15443,20 @@ } } }, + "compute.ListClusterPoliciesRequest": { + "fields": { + "sort_column": { + "description": "The cluster policy attribute to sort by.\n* `POLICY_CREATION_TIME` - Sort result list by policy creation time.\n* `POLICY_NAME` - Sort result list by policy name.", + "ref": "compute.ListSortColumn", + "launch_stage": "GA" + }, + "sort_order": { + "description": "The order in which the policies get listed.\n* `DESC` - Sort result list in descending order.\n* `ASC` - Sort result list in ascending order.", + "ref": "compute.ListSortOrder", + "launch_stage": "GA" + } + } + }, "compute.ListClustersFilterBy": { "fields": { "cluster_sources": { @@ -14214,6 +15477,28 @@ } } }, + "compute.ListClustersRequest": { + "fields": { + "filter_by": { + "description": "Filters to apply to the list of clusters.", + "ref": "compute.ListClustersFilterBy", + "launch_stage": "GA" + }, + "page_size": { + "description": "Use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Use next_page_token or prev_page_token returned from the previous request to list the next or previous page of clusters respectively.", + "launch_stage": "GA" + }, + "sort_by": { + "description": "Sort the list of clusters by a specific criteria.", + "ref": "compute.ListClustersSortBy", + "launch_stage": "GA" + } + } + }, "compute.ListClustersResponse": { "fields": { "clusters": { @@ -14263,6 +15548,7 @@ "DEFAULT": "GA" } }, + "compute.ListGlobalInitScriptsRequest": {}, "compute.ListGlobalInitScriptsResponse": { "fields": { "scripts": { @@ -14277,6 +15563,8 @@ } } }, + "compute.ListInstancePoolsRequest": {}, + "compute.ListInstanceProfilesRequest": {}, "compute.ListInstanceProfilesResponse": { "fields": { "instance_profiles": { @@ -14285,6 +15573,7 @@ } } }, + "compute.ListNodeTypesRequest": {}, "compute.ListNodeTypesResponse": { "fields": { "node_types": { @@ -14301,6 +15590,18 @@ } } }, + "compute.ListPolicyFamiliesRequest": { + "fields": { + "max_results": { + "description": "Maximum number of policy families to return.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A token that can be used to get the next page of results.", + "launch_stage": "GA" + } + } + }, "compute.ListPolicyFamiliesResponse": { "fields": { "next_page_token": { @@ -14333,6 +15634,7 @@ "DESC": "GA" } }, + "compute.ListZonesRequest": {}, "compute.LocalFileInfo": { "fields": { "destination": { @@ -14364,9 +15666,7 @@ } } }, - "compute.MapAny": { - "launch_stage": "GA" - }, + "compute.MapAny": {}, "compute.MavenLibrary": { "fields": { "coordinates": { @@ -14821,6 +16121,7 @@ } } }, + "compute.SparkVersionsRequest": {}, "compute.StartCluster": { "fields": { "cluster_id": { @@ -15387,7 +16688,7 @@ "launch_stage": "GA" }, "kind": { - "ref": "compute.kind", + "ref": "compute.Kind", "launch_stage": "GA" }, "node_type_id": { @@ -15480,15 +16781,6 @@ } } }, - "compute.kind": { - "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", - "enum": [ - "CLASSIC_PREVIEW" - ], - "enum_launch_stages": { - "CLASSIC_PREVIEW": "GA" - } - }, "dashboards.AuthorizationDetails": { "fields": { "grant_rules": { @@ -15517,6 +16809,40 @@ } } }, + "dashboards.CreateDashboardRequest": { + "fields": { + "dashboard": { + "ref": "dashboards.Dashboard", + "launch_stage": "GA" + }, + "dataset_catalog": { + "description": "Sets the default catalog for all datasets in this dashboard.\nDoes not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "launch_stage": "GA" + }, + "dataset_schema": { + "description": "Sets the default schema for all datasets in this dashboard.\nDoes not impact table references that use fully qualified schema names (ex: nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "launch_stage": "GA" + } + } + }, + "dashboards.CreateScheduleRequest": { + "fields": { + "schedule": { + "description": "The schedule to create. A dashboard is limited to 10 schedules.", + "ref": "dashboards.Schedule", + "launch_stage": "GA" + } + } + }, + "dashboards.CreateSubscriptionRequest": { + "fields": { + "subscription": { + "description": "The subscription to create. A schedule is limited to 100 subscriptions.", + "ref": "dashboards.Subscription", + "launch_stage": "GA" + } + } + }, "dashboards.CronSchedule": { "fields": { "quartz_cron_expression": { @@ -15600,6 +16926,22 @@ "DASHBOARD_VIEW_BASIC": "GA" } }, + "dashboards.DeleteScheduleRequest": { + "fields": { + "etag": { + "description": "The etag for the schedule. Optionally, it can be provided to verify that the schedule has not\nbeen modified from its last retrieval.", + "launch_stage": "GA" + } + } + }, + "dashboards.DeleteSubscriptionRequest": { + "fields": { + "etag": { + "description": "The etag for the subscription. Can be optionally provided to ensure that the subscription has not been\nmodified since the last read.", + "launch_stage": "GA" + } + } + }, "dashboards.EvaluationStatusType": { "enum": [ "RUNNING", @@ -15658,10 +17000,7 @@ "fields": { "conversation_id": { "description": "Conversation ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "created_timestamp": { "description": "Timestamp when the message was created", @@ -15687,17 +17026,11 @@ }, "space_id": { "description": "Genie space ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "title": { "description": "Conversation title", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "user_id": { "description": "ID of the user who created the conversation", @@ -15711,10 +17044,7 @@ "dashboards.GenieConversationSummary": { "fields": { "conversation_id": { - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "created_timestamp": { "launch_stage": "GA", @@ -15734,10 +17064,7 @@ "fields": { "content": { "description": "User message content.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -15756,10 +17083,7 @@ "fields": { "content": { "description": "Comment text content.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -15781,10 +17105,7 @@ }, "serialized_space": { "description": "The contents of the Genie Space in serialized string form.\nUse the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field.\nThis field provides the structure of the JSON string that represents the space's layout and components.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "title": { "description": "Optional title override", @@ -15795,13 +17116,12 @@ }, "warehouse_id": { "description": "Warehouse to associate with the new space", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, + "dashboards.GenieDeleteConversationMessageRequest": {}, + "dashboards.GenieDeleteConversationRequest": {}, "dashboards.GenieEvalAssessment": { "enum": [ "GOOD", @@ -15863,10 +17183,7 @@ }, "benchmark_question_id": { "description": "The ID of the benchmark question that was evaluated.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "created_by_user": { "description": "User ID who created evaluation result.", @@ -15884,17 +17201,11 @@ }, "result_id": { "description": "Unique identifier for this evaluation result.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "space_id": { "description": "The ID of the space the evaluation result belongs to.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "status": { "description": "Current status of this evaluation result.", @@ -15933,10 +17244,7 @@ }, "benchmark_question_id": { "description": "The ID of the benchmark question that was evaluated.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "eval_run_status": { "description": "Current status of the evaluation run.", @@ -15962,17 +17270,11 @@ }, "result_id": { "description": "The unique identifier for the evaluation result.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "space_id": { "description": "The ID of the space the evaluation result belongs to.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -15984,10 +17286,7 @@ }, "eval_run_id": { "description": "The unique identifier for the evaluation run.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "eval_run_status": { "description": "Current status of the evaluation run.", @@ -16027,7 +17326,6 @@ "fields": { "comment": { "description": "Optional feedback comment text", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -16069,6 +17367,15 @@ } } }, + "dashboards.GenieGetConversationMessageRequest": {}, + "dashboards.GenieGetDownloadFullQueryResultRequest": { + "fields": { + "download_id_signature": { + "description": "JWT signature for the download_id to ensure secure access to query results", + "launch_stage": "GA" + } + } + }, "dashboards.GenieGetDownloadFullQueryResultResponse": { "fields": { "statement_response": { @@ -16078,6 +17385,10 @@ } } }, + "dashboards.GenieGetEvalResultDetailsRequest": {}, + "dashboards.GenieGetEvalRunRequest": {}, + "dashboards.GenieGetMessageAttachmentQueryResultRequest": {}, + "dashboards.GenieGetMessageQueryResultRequest": {}, "dashboards.GenieGetMessageQueryResultResponse": { "fields": { "statement_response": { @@ -16087,6 +17398,36 @@ } } }, + "dashboards.GenieGetQueryResultByAttachmentRequest": {}, + "dashboards.GenieGetSpaceRequest": { + "fields": { + "include_serialized_space": { + "description": "Whether to include the serialized space export in the response.\nRequires at least CAN EDIT permission on the space.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "dashboards.GenieListConversationCommentsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of comments to return per page.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token for getting the next page of results.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListConversationCommentsResponse": { "fields": { "comments": { @@ -16099,6 +17440,24 @@ } } }, + "dashboards.GenieListConversationMessagesRequest": { + "fields": { + "page_size": { + "description": "Maximum number of messages to return per page", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Token to get the next page of results", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListConversationMessagesResponse": { "fields": { "messages": { @@ -16111,6 +17470,31 @@ } } }, + "dashboards.GenieListConversationsRequest": { + "fields": { + "include_all": { + "description": "Include all conversations in the space across all users.\nRequires at least CAN MANAGE permission on the space.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "Maximum number of conversations to return per page", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Token to get the next page of results", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListConversationsResponse": { "fields": { "conversations": { @@ -16123,6 +17507,24 @@ } } }, + "dashboards.GenieListEvalResultsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of eval results to return per page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque token to retrieve the next page of results.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListEvalResultsResponse": { "fields": { "eval_results": { @@ -16135,6 +17537,24 @@ } } }, + "dashboards.GenieListEvalRunsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of evaluation runs to return per page", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Token to get the next page of results", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListEvalRunsResponse": { "fields": { "eval_runs": { @@ -16147,6 +17567,24 @@ } } }, + "dashboards.GenieListMessageCommentsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of comments to return per page.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token for getting the next page of results.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListMessageCommentsResponse": { "fields": { "comments": { @@ -16159,6 +17597,24 @@ } } }, + "dashboards.GenieListSpacesRequest": { + "fields": { + "page_size": { + "description": "Maximum number of spaces to return per page", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token for getting the next page of results", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dashboards.GenieListSpacesResponse": { "fields": { "next_page_token": { @@ -16182,17 +17638,11 @@ }, "content": { "description": "User message content", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "conversation_id": { "description": "Conversation ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "created_timestamp": { "description": "Timestamp when the message was created", @@ -16234,10 +17684,7 @@ }, "message_id": { "description": "Message ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "query_result": { "description": "The result of SQL query if the message includes a query attachment.\nDeprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead.", @@ -16250,10 +17697,7 @@ }, "space_id": { "description": "Genie space ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "status": { "ref": "dashboards.MessageStatus", @@ -16276,17 +17720,11 @@ "fields": { "content": { "description": "Comment text content", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "conversation_id": { "description": "Conversation ID", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "created_timestamp": { "description": "Timestamp when the comment was created", @@ -16297,24 +17735,15 @@ }, "message_comment_id": { "description": "Comment ID", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "message_id": { "description": "Message ID", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "space_id": { "description": "Genie space ID", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "user_id": { "description": "ID of the user who created the comment", @@ -16378,7 +17807,6 @@ }, "thoughts": { "description": "Insights into how Genie came to generate the SQL.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -16415,7 +17843,6 @@ "fields": { "comment": { "description": "Optional text feedback that will be stored as a comment.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -16424,10 +17851,7 @@ "rating": { "description": "The rating (POSITIVE, NEGATIVE, or NONE).", "ref": "dashboards.GenieFeedbackRating", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -16442,7 +17866,6 @@ }, "etag": { "description": "ETag for this space. Pass this value back in the update request to prevent overwriting\nconcurrent changes.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -16450,7 +17873,6 @@ }, "parent_path": { "description": "Parent folder path of the Genie Space", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -16465,17 +17887,11 @@ }, "space_id": { "description": "Genie space ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "title": { "description": "Title of the Genie Space", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "warehouse_id": { "description": "Warehouse associated with the Genie Space", @@ -16490,10 +17906,7 @@ "fields": { "content": { "description": "The text of the message that starts the conversation.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -16505,10 +17918,7 @@ }, "conversation_id": { "description": "Conversation ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "message": { "ref": "dashboards.GenieMessage", @@ -16516,10 +17926,7 @@ }, "message_id": { "description": "Message ID", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -16535,6 +17942,7 @@ } } }, + "dashboards.GenieTrashSpaceRequest": {}, "dashboards.GenieUpdateSpaceRequest": { "fields": { "description": { @@ -16546,7 +17954,6 @@ }, "etag": { "description": "ETag returned by a previous GET or UPDATE. When set, the update will fail if the space\nhas been modified since. Omit to apply the update unconditionally.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -16554,7 +17961,6 @@ }, "parent_path": { "description": "Parent workspace folder path to move this Genie space under.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -16583,6 +17989,20 @@ } } }, + "dashboards.GetDashboardRequest": {}, + "dashboards.GetPublishedDashboardRequest": {}, + "dashboards.GetPublishedDashboardTokenInfoRequest": { + "fields": { + "external_value": { + "description": "Provided external value to be included in the custom claim.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "external_viewer_id": { + "description": "Provided external viewer id to be included in the custom claim.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "dashboards.GetPublishedDashboardTokenInfoResponse": { "fields": { "authorization_details": { @@ -16599,6 +18019,8 @@ } } }, + "dashboards.GetScheduleRequest": {}, + "dashboards.GetSubscriptionRequest": {}, "dashboards.LifecycleState": { "enum": [ "ACTIVE", @@ -16609,6 +18031,27 @@ "TRASHED": "GA" } }, + "dashboards.ListDashboardsRequest": { + "fields": { + "page_size": { + "description": "The number of dashboards to return per page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token, received from a previous `ListDashboards` call.\nThis token can be used to retrieve the subsequent page.", + "launch_stage": "GA" + }, + "show_trashed": { + "description": "The flag to include dashboards located in the trash.\nIf unspecified, only active dashboards will be returned.", + "launch_stage": "GA" + }, + "view": { + "description": "`DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard.", + "ref": "dashboards.DashboardView", + "launch_stage": "GA" + } + } + }, "dashboards.ListDashboardsResponse": { "fields": { "dashboards": { @@ -16620,6 +18063,18 @@ } } }, + "dashboards.ListSchedulesRequest": { + "fields": { + "page_size": { + "description": "The number of schedules to return per page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token, received from a previous `ListSchedules` call.\nUse this to retrieve the subsequent page.", + "launch_stage": "GA" + } + } + }, "dashboards.ListSchedulesResponse": { "fields": { "next_page_token": { @@ -16631,6 +18086,18 @@ } } }, + "dashboards.ListSubscriptionsRequest": { + "fields": { + "page_size": { + "description": "The number of subscriptions to return per page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token, received from a previous `ListSubscriptions` call.\nUse this to retrieve the subsequent page.", + "launch_stage": "GA" + } + } + }, "dashboards.ListSubscriptionsResponse": { "fields": { "next_page_token": { @@ -17208,8 +18675,82 @@ "THOUGHT_TYPE_UNDERSTANDING": "How ambiguous parts of the question were resolved." } }, + "dashboards.TrashDashboardRequest": {}, "dashboards.TrashDashboardResponse": {}, + "dashboards.UnpublishDashboardRequest": {}, "dashboards.UnpublishDashboardResponse": {}, + "dashboards.UpdateDashboardRequest": { + "fields": { + "dashboard": { + "ref": "dashboards.Dashboard", + "launch_stage": "GA" + }, + "dataset_catalog": { + "description": "Sets the default catalog for all datasets in this dashboard.\nDoes not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "launch_stage": "GA" + }, + "dataset_schema": { + "description": "Sets the default schema for all datasets in this dashboard.\nDoes not impact table references that use fully qualified schema names (ex: nyctaxi.trips).\nLeave blank to keep each dataset’s existing configuration.", + "launch_stage": "GA" + } + } + }, + "dashboards.UpdateScheduleRequest": { + "fields": { + "schedule": { + "description": "The schedule to update.", + "ref": "dashboards.Schedule", + "launch_stage": "GA" + } + } + }, + "database.CreateDatabaseCatalogRequest": { + "fields": { + "catalog": { + "ref": "database.DatabaseCatalog", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.CreateDatabaseInstanceRequest": { + "fields": { + "database_instance": { + "description": "Instance to create.", + "ref": "database.DatabaseInstance", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.CreateDatabaseInstanceRoleRequest": { + "fields": { + "database_instance_name": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "database_instance_role": { + "ref": "database.DatabaseInstanceRole", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "database.CreateDatabaseTableRequest": { + "fields": { + "table": { + "ref": "database.DatabaseTable", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.CreateSyncedDatabaseTableRequest": { + "fields": { + "synced_table": { + "ref": "database.SyncedDatabaseTable", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "database.CustomTag": { "fields": { "key": { @@ -17294,11 +18835,10 @@ }, "custom_tags": { "description": "Custom tags associated with the instance. This field is only included on create and update responses.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "effective_capacity": { @@ -17311,7 +18851,6 @@ }, "effective_custom_tags": { "description": "The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -17354,7 +18893,6 @@ }, "effective_usage_policy_id": { "description": "The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -17364,8 +18902,8 @@ "description": "Whether to enable PG native password login on the instance. Defaults to false.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "enable_readable_secondaries": { @@ -17393,8 +18931,8 @@ "ref": "database.DatabaseInstanceRef", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] }, "pg_version": { @@ -17438,8 +18976,8 @@ "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "uid": { @@ -17451,11 +18989,10 @@ }, "usage_policy_id": { "description": "The desired usage policy to associate with the instance.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] } } @@ -17481,8 +19018,8 @@ "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.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "name": { @@ -17544,10 +19081,7 @@ }, "name": { "description": "The name of the role. This is the unique identifier for the role in an instance.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -17631,6 +19165,55 @@ } } }, + "database.DeleteDatabaseCatalogRequest": {}, + "database.DeleteDatabaseInstanceRequest": { + "fields": { + "force": { + "description": "By default, a instance cannot be deleted if it has descendant instances created via PITR. If\nthis flag is specified as true, all descendent instances will be deleted as well.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "purge": { + "description": "Deprecated. Omitting the field or setting it to true will result in the field being hard deleted. Setting a value\nof false will throw a bad request.", + "deprecated": true, + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.DeleteDatabaseInstanceRoleRequest": { + "fields": { + "allow_missing": { + "description": "This is the AIP standard name for the equivalent of Postgres' `IF EXISTS` option", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "reassign_owned_to": { + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "database.DeleteDatabaseTableRequest": {}, + "database.DeleteSyncedDatabaseTableRequest": { + "fields": { + "purge_data": { + "description": "Optional. When set to true, the actual PostgreSQL table will be dropped from the database.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "database.DeltaTableSyncInfo": { "fields": { "delta_commit_timestamp": { @@ -17649,6 +19232,14 @@ } } }, + "database.FindDatabaseInstanceByUidRequest": { + "fields": { + "uid": { + "description": "UID of the cluster to get.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "database.GenerateDatabaseCredentialRequest": { "description": "Generates a credential that can be used to access database instances", "fields": { @@ -17665,6 +19256,29 @@ } } }, + "database.GetDatabaseCatalogRequest": {}, + "database.GetDatabaseInstanceRequest": {}, + "database.GetDatabaseInstanceRoleRequest": {}, + "database.GetDatabaseTableRequest": {}, + "database.GetSyncedDatabaseTableRequest": {}, + "database.ListDatabaseCatalogsRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "database.ListDatabaseCatalogsResponse": { "fields": { "database_catalogs": { @@ -17676,6 +19290,24 @@ } } }, + "database.ListDatabaseInstanceRolesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "database.ListDatabaseInstanceRolesResponse": { "fields": { "database_instance_roles": { @@ -17694,6 +19326,24 @@ } } }, + "database.ListDatabaseInstancesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned. The maximum value is 100.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of Database Instances. Requests first page if absent.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "database.ListDatabaseInstancesResponse": { "fields": { "database_instances": { @@ -17706,6 +19356,24 @@ } } }, + "database.ListSyncedDatabaseTablesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of synced database tables. Requests first page if absent.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "database.ListSyncedDatabaseTablesResponse": { "fields": { "next_page_token": { @@ -17722,7 +19390,6 @@ "fields": { "budget_policy_id": { "description": "Budget policy to set on the newly created pipeline.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -17818,8 +19485,8 @@ "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "effective_database_instance_name": { @@ -17840,8 +19507,8 @@ "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "name": { @@ -18187,23 +19854,55 @@ } } }, + "database.UpdateDatabaseCatalogRequest": { + "fields": { + "database_catalog": { + "description": "Note that updating a database catalog is not yet supported.", + "ref": "database.DatabaseCatalog", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update. Setting this field is not yet supported.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "database.UpdateDatabaseInstanceRequest": { + "fields": { + "database_instance": { + "ref": "database.DatabaseInstance", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags,\nspecify custom_tags in the update_mask with an empty custom_tags map.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "database.UpdateSyncedDatabaseTableRequest": { + "fields": { + "synced_table": { + "description": "Note that updating a synced database table is not yet supported.", + "ref": "database.SyncedDatabaseTable", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update. Setting this field is not yet supported.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "dataclassification.AutoTaggingConfig": { "description": "Auto-tagging configuration for a classification tag.\nWhen enabled, detected columns are automatically tagged with Unity Catalog\ntags.", "fields": { "auto_tagging_mode": { "description": "Whether auto-tagging is enabled or disabled for this classification tag.", "ref": "dataclassification.AutoTaggingConfigAutoTaggingMode", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "classification_tag": { "description": "The Classification Tag. For built-in classes this is a system tag (e.g., \"class.name\",\n\"class.location\"); for custom classes it is a user-defined governance tag key.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -18246,10 +19945,31 @@ "description": "Wrapper message for a list of schema names.", "fields": { "names": { - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dataclassification.CreateCatalogConfigRequest": { + "fields": { + "catalog_config": { + "description": "The configuration to create.", + "ref": "dataclassification.CatalogConfig", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "dataclassification.DeleteCatalogConfigRequest": {}, + "dataclassification.GetCatalogConfigRequest": {}, + "dataclassification.UpdateCatalogConfigRequest": { + "fields": { + "catalog_config": { + "description": "The configuration to apply to the catalog.\nThe name field in catalog_config identifies which resource to update.", + "ref": "dataclassification.CatalogConfig", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Field mask specifying which fields to update.", + "launch_stage": "PUBLIC_BETA" } } }, @@ -18285,7 +20005,6 @@ "fields": { "excluded_table_full_names": { "description": "List of fully qualified table names to exclude from anomaly detection.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -18309,6 +20028,24 @@ } } }, + "dataquality.CreateMonitorRequest": { + "fields": { + "monitor": { + "description": "The monitor to create.", + "ref": "dataquality.Monitor", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dataquality.CreateRefreshRequest": { + "fields": { + "refresh": { + "description": "The refresh to create", + "ref": "dataquality.Refresh", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "dataquality.CronSchedule": { "description": "The data quality monitoring workflow cron schedule.", "fields": { @@ -18322,17 +20059,11 @@ }, "quartz_cron_expression": { "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "timezone_id": { "description": "A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -18431,10 +20162,7 @@ }, "output_schema_id": { "description": "ID of the schema where output tables are created.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "profile_metrics_table_name": { "description": "Table that stores profile metrics data. Format: `catalog.schema.table_name`.", @@ -18503,39 +20231,24 @@ "fields": { "definition": { "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "input_columns": { "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "Name of the metric in the output tables.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "output_data_type": { "description": "The output type of the custom metric.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "type": { "description": "The type of the custom metric.", "ref": "dataquality.DataProfilingCustomMetricType", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -18569,15 +20282,16 @@ "DATA_PROFILING_STATUS_PENDING": "PUBLIC_PREVIEW" } }, + "dataquality.DeleteMonitorRequest": {}, + "dataquality.DeleteRefreshRequest": {}, + "dataquality.GetMonitorRequest": {}, + "dataquality.GetRefreshRequest": {}, "dataquality.InferenceLogConfig": { "description": "Inference log configuration.", "fields": { "granularities": { "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "label_column": { "description": "Column for the label.", @@ -18588,32 +20302,20 @@ }, "model_id_column": { "description": "Column for the model identifier.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "prediction_column": { "description": "Column for the prediction.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "problem_type": { "description": "Problem type the model aims to solve.", "ref": "dataquality.InferenceProblemType", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "timestamp_column": { "description": "Column for the timestamp.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -18628,6 +20330,22 @@ "INFERENCE_PROBLEM_TYPE_REGRESSION": "PUBLIC_PREVIEW" } }, + "dataquality.ListMonitorRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dataquality.ListMonitorResponse": { "description": "Response for listing Monitors.", "fields": { @@ -18639,6 +20357,22 @@ } } }, + "dataquality.ListRefreshRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "dataquality.ListRefreshResponse": { "description": "Response for listing refreshes.", "fields": { @@ -18671,17 +20405,11 @@ }, "object_id": { "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "object_type": { "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -18729,17 +20457,11 @@ }, "object_id": { "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "object_type": { "description": "The type of the monitored object. Can be one of the following: `schema`or `table`.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "refresh_id": { "description": "Unique id of the refresh operation.", @@ -18815,20 +20537,92 @@ "fields": { "granularities": { "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "timestamp_column": { "description": "Column for the timestamp.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dataquality.UpdateMonitorRequest": { + "fields": { + "monitor": { + "description": "The monitor to update.", + "ref": "dataquality.Monitor", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask to specify which fields to update as a comma-separated list.\nExample value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "dataquality.UpdateRefreshRequest": { + "fields": { + "refresh": { + "description": "The refresh to update.", + "ref": "dataquality.Refresh", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask to specify which fields to update.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "disasterrecovery.CreateFailoverGroupRequest": { + "fields": { + "failover_group": { + "description": "The failover group to create.", + "ref": "disasterrecovery.FailoverGroup", + "launch_stage": "PRIVATE_PREVIEW" + }, + "failover_group_id": { + "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "validate_only": { + "description": "When true, validates the request without creating the failover group.", + "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED" + "OPTIONAL" ] } } }, + "disasterrecovery.CreateStableUrlRequest": { + "fields": { + "stable_url": { + "description": "The stable URL to create.", + "ref": "disasterrecovery.StableUrl", + "launch_stage": "PRIVATE_PREVIEW" + }, + "stable_url_id": { + "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "validate_only": { + "description": "When true, validates the request without creating the stable URL.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "disasterrecovery.DeleteFailoverGroupRequest": { + "fields": { + "etag": { + "description": "Opaque version string for optimistic locking. If provided, must match the\ncurrent etag. If omitted, the delete proceeds without an etag check.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "disasterrecovery.DeleteStableUrlRequest": {}, "disasterrecovery.FailoverFailoverGroupRequest": { "description": "Request to failover a failover group to a new primary region.", "fields": { @@ -18842,17 +20636,11 @@ "failover_type": { "description": "The type of failover to perform.", "ref": "disasterrecovery.FailoverFailoverGroupRequestFailoverType", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "target_primary_region": { "description": "The target primary region. Must be one of the derived regions and different\nfrom the current effective_primary_region. Serves as an idempotency check.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -18890,9 +20678,8 @@ "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", - "INPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "INPUT_ONLY" ] }, "name": { @@ -18906,7 +20693,6 @@ "description": "List of all regions participating in this failover group.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -18942,10 +20728,7 @@ }, "workspace_sets": { "description": "Workspace sets, each containing workspaces that replicate to each other.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -18972,6 +20755,26 @@ "INITIAL_REPLICATION": "PRIVATE_PREVIEW" } }, + "disasterrecovery.GetFailoverGroupRequest": {}, + "disasterrecovery.GetStableUrlRequest": {}, + "disasterrecovery.ListFailoverGroupsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of failover groups to return per page:\n- when set to a value greater than 0, the page length is the minimum of this value\nand a server configured value;\n- when set to 0 or unset, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token received from a previous ListFailoverGroups call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "disasterrecovery.ListFailoverGroupsResponse": { "description": "Response for listing failover groups.", "fields": { @@ -18985,6 +20788,24 @@ } } }, + "disasterrecovery.ListStableUrlsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of stable URLs to return per page:\n- when set to a value greater than 0, the page length is the minimum of this value\nand a server configured value;\n- when set to 0 or unset, the page length is set to a server configured value\n(recommended);\n- when set to a value less than 0, an invalid parameter error is returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token received from a previous ListStableUrls call.\nProvide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "disasterrecovery.ListStableUrlsResponse": { "description": "Response for listing stable URLs.", "fields": { @@ -19003,17 +20824,11 @@ "fields": { "name": { "description": "Resource name for this location.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "uri_by_region": { "description": "URI for each region. Each entry maps a region name to a storage URI.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -19022,17 +20837,11 @@ "fields": { "region": { "description": "The region name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "uri": { "description": "The storage URI for this region.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -19050,9 +20859,8 @@ "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", - "INPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "INPUT_ONLY" ] }, "name": { @@ -19066,8 +20874,8 @@ "description": "The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] } } @@ -19077,10 +20885,7 @@ "fields": { "name": { "description": "The name of the UC catalog to replicate.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -19091,16 +20896,12 @@ "description": "UC catalogs to replicate.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, "data_replication_workspace_set": { "description": "The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "location_mappings": { "description": "Location mappings - storage URI per region for each location.", @@ -19111,15 +20912,25 @@ } } }, + "disasterrecovery.UpdateFailoverGroupRequest": { + "fields": { + "failover_group": { + "description": "The failover group with updated fields. The name field identifies the resource\nand is populated from the URL path.", + "ref": "disasterrecovery.FailoverGroup", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "Comma-separated list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "disasterrecovery.WorkspaceSet": { "description": "A set of workspaces that replicate to each other across regions.", "fields": { "name": { "description": "Resource name for this workspace set.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "replicate_workspace_assets": { "description": "Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nRequires all workspaces in the set to be Mission Critical tier.", @@ -19137,10 +20948,7 @@ }, "workspace_ids": { "description": "Workspace IDs in this set. The system derives and validates regions.\nEA: exactly 2 workspaces (one per region).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -19155,6 +20963,29 @@ "GPU": "GA" } }, + "environments.CreateWorkspaceBaseEnvironmentRequest": { + "fields": { + "request_id": { + "description": "A unique identifier for this request. A random UUID is recommended.\nThis request is only idempotent if a request_id is provided.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "workspace_base_environment": { + "description": "Required. The workspace base environment to create.", + "ref": "environments.WorkspaceBaseEnvironment", + "launch_stage": "GA" + }, + "workspace_base_environment_id": { + "description": "The ID to use for the workspace base environment, which will become the final component of\nthe resource name.\nThis value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "environments.DatabricksServiceExceptionWithDetailsProto": { "description": "Databricks Error that is returned by all Databricks APIs.", "fields": { @@ -19199,6 +21030,7 @@ } } }, + "environments.DeleteWorkspaceBaseEnvironmentRequest": {}, "environments.ErrorCode": { "description": "Error codes returned by Databricks APIs to indicate specific failure conditions.", "enum": [ @@ -19368,6 +21200,27 @@ "WORKSPACE_TEMPORARILY_UNAVAILABLE": "GA" } }, + "environments.GetDefaultWorkspaceBaseEnvironmentRequest": {}, + "environments.GetOperationRequest": {}, + "environments.GetWorkspaceBaseEnvironmentRequest": {}, + "environments.ListWorkspaceBaseEnvironmentsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of environments to return per page.\nDefault is 1000.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "environments.ListWorkspaceBaseEnvironmentsResponse": { "description": "Response message for ListWorkspaceBaseEnvironments.", "fields": { @@ -19410,6 +21263,28 @@ "environments.RefreshWorkspaceBaseEnvironmentRequest": { "description": "Request message for RefreshWorkspaceBaseEnvironments." }, + "environments.UpdateDefaultWorkspaceBaseEnvironmentRequest": { + "fields": { + "default_workspace_base_environment": { + "description": "Required. The default workspace base environment configuration to update.", + "ref": "environments.DefaultWorkspaceBaseEnvironment", + "launch_stage": "GA" + }, + "update_mask": { + "description": "Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).\nThe special value '*' indicates that all fields should be updated (full replacement).\nValid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment\n\nTo unset one or both defaults, include the field path(s) in the mask and omit them from the request body.\nTo unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.", + "launch_stage": "GA" + } + } + }, + "environments.UpdateWorkspaceBaseEnvironmentRequest": { + "fields": { + "workspace_base_environment": { + "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "ref": "environments.WorkspaceBaseEnvironment", + "launch_stage": "GA" + } + } + }, "environments.WorkspaceBaseEnvironment": { "description": "A WorkspaceBaseEnvironment defines a workspace-level environment configuration\nconsisting of an environment version and a list of dependencies.", "fields": { @@ -19437,10 +21312,7 @@ }, "display_name": { "description": "Human-readable display name for the workspace base environment.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "filepath": { "description": "The WSFS or UC Volumes path to the environment YAML file.", @@ -19547,6 +21419,7 @@ } } }, + "files.CreateDirectoryRequest": {}, "files.CreateResponse": { "fields": { "handle": { @@ -19567,6 +21440,8 @@ } } }, + "files.DeleteDirectoryRequest": {}, + "files.DeleteFileRequest": {}, "files.DeleteResponse": {}, "files.DirectoryEntry": { "fields": { @@ -19592,6 +21467,14 @@ } } }, + "files.DownloadRequest": {}, + "files.DownloadResponse": { + "fields": { + "contents": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "files.FileInfo": { "fields": { "file_size": { @@ -19612,6 +21495,37 @@ } } }, + "files.GetDirectoryMetadataRequest": {}, + "files.GetMetadataRequest": {}, + "files.GetMetadataResponse": {}, + "files.GetStatusRequest": { + "fields": { + "path": { + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.ListDbfsRequest": { + "fields": { + "path": { + "description": "The path of the file or directory. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, + "files.ListDirectoryContentsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of directory entries to return. The response may contain fewer\nentries. If the response contains a `next_page_token`, there may be more entries,\neven if fewer than `page_size` entries are in the response.\n\nWe recommend not to set this value unless you are intentionally listing less than\nthe complete directory contents.\n\nIf unspecified, at most 1000 directory entries will be returned.\nThe maximum value is 1000. Values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "description": "An opaque page token which was the `next_page_token` in the response of the previous\nrequest to list the contents of this directory. Provide this token to retrieve the\nnext page of directory entries.\nWhen providing a `page_token`, all other parameters provided to the request must match\nthe previous request.\nTo list all of the entries in a directory, it is necessary to continue requesting\npages of entries until the response contains no `next_page_token`. Note that the\nnumber of entries returned must not be used to determine when the listing is complete.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "files.ListDirectoryResponse": { "fields": { "contents": { @@ -19671,6 +21585,22 @@ } }, "files.PutResponse": {}, + "files.ReadDbfsRequest": { + "fields": { + "length": { + "description": "The number of bytes to read starting from the offset. This has a limit of 1 MB, and a default\nvalue of 0.5 MB.", + "launch_stage": "GA" + }, + "offset": { + "description": "The offset to read from in bytes.", + "launch_stage": "GA" + }, + "path": { + "description": "The path of the file to read. The path should be the absolute DBFS path.", + "launch_stage": "GA" + } + } + }, "files.ReadResponse": { "fields": { "bytes_read": { @@ -19683,6 +21613,17 @@ } } }, + "files.UploadRequest": { + "fields": { + "contents": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "overwrite": { + "description": "If true or unspecified, an existing file will be overwritten. If false, an error will be returned if the path points to an existing file.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "iam.AccessControlRequest": { "fields": { "group_name": { @@ -19751,7 +21692,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -19858,6 +21798,34 @@ "AUTOSCOPE_STATE_USER_SELECTED": "PRIVATE_PREVIEW" } }, + "iam.CheckPolicyRequest": { + "fields": { + "actor": { + "ref": "iam.Actor", + "launch_stage": "PRIVATE_PREVIEW" + }, + "authz_identity": { + "ref": "iam.RequestAuthzIdentity", + "launch_stage": "PRIVATE_PREVIEW" + }, + "consistency_token": { + "ref": "iam.ConsistencyToken", + "launch_stage": "PRIVATE_PREVIEW" + }, + "permission": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "resource": { + "description": "Ex: (servicePrincipal/use, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e)\nEx: (servicePrincipal.ruleSet/update, accounts/\u003caccount-id\u003e/servicePrincipals/\u003csp-id\u003e/ruleSets/default)", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "resource_info": { + "ref": "iam.ResourceInfo", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "iam.CheckPolicyResponse": { "fields": { "consistency_token": { @@ -19914,7 +21882,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -20012,7 +21979,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -20110,7 +22076,57 @@ } } }, + "iam.DeleteAccountGroupRequest": {}, + "iam.DeleteAccountServicePrincipalRequest": {}, + "iam.DeleteAccountUserRequest": {}, + "iam.DeleteGroupRequest": {}, + "iam.DeleteServicePrincipalRequest": {}, + "iam.DeleteUserRequest": {}, + "iam.DeleteWorkspaceAssignmentRequest": {}, "iam.DeleteWorkspacePermissionAssignmentResponse": {}, + "iam.GetAccountGroupRequest": {}, + "iam.GetAccountServicePrincipalRequest": {}, + "iam.GetAccountUserRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "GA" + }, + "count": { + "description": "Desired number of results per page. Default is 10000.", + "launch_stage": "GA" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "GA" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "GA" + }, + "sortBy": { + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "launch_stage": "GA" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.GetSortOrder", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "GA" + } + } + }, + "iam.GetAssignableRolesForResourceRequest": { + "fields": { + "resource": { + "description": "The resource name for which assignable roles will be listed.\n\nExamples | Summary\n:--- | :---\n`resource=accounts/\u003cACCOUNT_ID\u003e` | A resource name for the account.\n`resource=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e` | A resource name for the group.\n`resource=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSP_ID\u003e` | A resource name for the service principal.\n`resource=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e` | A resource name for the tag policy.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "iam.GetAssignableRolesForResourceResponse": { "fields": { "roles": { @@ -20118,6 +22134,8 @@ } } }, + "iam.GetGroupRequest": {}, + "iam.GetPasswordPermissionLevelsRequest": {}, "iam.GetPasswordPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -20126,6 +22144,8 @@ } } }, + "iam.GetPasswordPermissionsRequest": {}, + "iam.GetPermissionLevelsRequest": {}, "iam.GetPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -20134,6 +22154,64 @@ } } }, + "iam.GetPermissionRequest": {}, + "iam.GetRuleSetRequest": { + "fields": { + "etag": { + "description": "Etag used for versioning. The response is at least as fresh as the eTag provided. Etag is used for optimistic\nconcurrency control as a way to help prevent simultaneous updates of a rule set from overwriting each other. It is\nstrongly suggested that systems make use of the etag in the read -\u003e modify -\u003e write pattern to perform rule set\nupdates in order to avoid race conditions that is get an etag from a GET rule set request, and pass it with the\nPUT update request to identify the rule set version you are updating.\n\nExamples | Summary\n:--- | :---\n`etag=` | An empty etag can only be used in GET to indicate no freshness requirements.\n`etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "name": { + "description": "The ruleset name associated with the request.\n\nExamples | Summary\n:--- | :---\n`name=accounts/\u003cACCOUNT_ID\u003e/ruleSets/default` | A name for a rule set on the account.\n`name=accounts/\u003cACCOUNT_ID\u003e/groups/\u003cGROUP_ID\u003e/ruleSets/default` | A name for a rule set on the group.\n`name=accounts/\u003cACCOUNT_ID\u003e/servicePrincipals/\u003cSERVICE_PRINCIPAL_APPLICATION_ID\u003e/ruleSets/default` | A name for a rule set on the service principal.\n`name=accounts/\u003cACCOUNT_ID\u003e/tagPolicies/\u003cTAG_POLICY_ID\u003e/ruleSets/default` | A name for a rule set on the tag policy.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.GetServicePrincipalRequest": {}, + "iam.GetSortOrder": { + "enum": [ + "ascending", + "descending" + ], + "enum_launch_stages": { + "ascending": "GA", + "descending": "GA" + } + }, + "iam.GetUserRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "count": { + "description": "Desired number of results per page.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortBy": { + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.GetSortOrder", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.GetWorkspaceAssignmentRequest": {}, "iam.GrantRule": { "fields": { "principals": { @@ -20173,7 +22251,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -20194,6 +22271,39 @@ "urn:ietf:params:scim:schemas:core:2.0:Group": "PUBLIC_PREVIEW" } }, + "iam.ListAccountGroupsRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "GA" + }, + "count": { + "description": "Desired number of results per page. Default is 10000.", + "launch_stage": "GA" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "GA" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "GA" + }, + "sortBy": { + "description": "Attribute to sort the results.", + "launch_stage": "GA" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "GA" + } + } + }, "iam.ListAccountGroupsResponse": { "fields": { "Resources": { @@ -20214,6 +22324,39 @@ } } }, + "iam.ListAccountServicePrincipalsRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "GA" + }, + "count": { + "description": "Desired number of results per page. Default is 10000.", + "launch_stage": "GA" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "GA" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "GA" + }, + "sortBy": { + "description": "Attribute to sort the results.", + "launch_stage": "GA" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "GA" + } + } + }, "iam.ListAccountServicePrincipalsResponse": { "fields": { "Resources": { @@ -20234,6 +22377,39 @@ } } }, + "iam.ListAccountUsersRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "GA" + }, + "count": { + "description": "Desired number of results per page. Default is 10000.", + "launch_stage": "GA" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "GA" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "GA" + }, + "sortBy": { + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "launch_stage": "GA" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "GA" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "GA" + } + } + }, "iam.ListAccountUsersResponse": { "fields": { "Resources": { @@ -20254,6 +22430,39 @@ } } }, + "iam.ListGroupsRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "count": { + "description": "Desired number of results per page.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortBy": { + "description": "Attribute to sort the results.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "iam.ListGroupsResponse": { "fields": { "Resources": { @@ -20310,6 +22519,82 @@ } } }, + "iam.ListServicePrincipalsRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "count": { + "description": "Desired number of results per page.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortBy": { + "description": "Attribute to sort the results.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "iam.ListSortOrder": { + "enum": [ + "ascending", + "descending" + ], + "enum_launch_stages": { + "ascending": "GA", + "descending": "GA" + } + }, + "iam.ListUsersRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "count": { + "description": "Desired number of results per page.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "filter": { + "description": "Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortBy": { + "description": "Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "sortOrder": { + "description": "The order to sort the results.", + "ref": "iam.ListSortOrder", + "launch_stage": "PUBLIC_PREVIEW" + }, + "startIndex": { + "description": "Specifies the index of the first result. First item is number 1.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "iam.ListUsersResponse": { "fields": { "Resources": { @@ -20334,6 +22619,25 @@ } } }, + "iam.ListWorkspaceAssignmentRequest": {}, + "iam.MeRequest": { + "fields": { + "attributes": { + "description": "Comma-separated list of attributes to return in response.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "excludedAttributes": { + "description": "Comma-separated list of attributes to exclude in response.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "iam.MigratePermissionsRequest": { "fields": { "from_workspace_group_name": { @@ -20869,7 +23173,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -20955,7 +23258,6 @@ "meta": { "description": "Container for the group identifier. Workspace local versus account.", "ref": "iam.ResourceMeta", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "roles": { @@ -21149,26 +23451,26 @@ } } }, - "iam.getSortOrder": { - "enum": [ - "ascending", - "descending" - ], - "enum_launch_stages": { - "ascending": "GA", - "descending": "GA" + "iamv2.CreateWorkspaceAssignmentDetailProxyRequest": { + "fields": { + "workspace_assignment_detail": { + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "ref": "iamv2.WorkspaceAssignmentDetail", + "launch_stage": "PRIVATE_PREVIEW" + } } }, - "iam.listSortOrder": { - "enum": [ - "ascending", - "descending" - ], - "enum_launch_stages": { - "ascending": "GA", - "descending": "GA" + "iamv2.CreateWorkspaceAssignmentDetailRequest": { + "fields": { + "workspace_assignment_detail": { + "description": "Required. Workspace assignment detail to be created in \u003cDatabricks\u003e.", + "ref": "iamv2.WorkspaceAssignmentDetail", + "launch_stage": "PRIVATE_PREVIEW" + } } }, + "iamv2.DeleteWorkspaceAssignmentDetailProxyRequest": {}, + "iamv2.DeleteWorkspaceAssignmentDetailRequest": {}, "iamv2.Entitlement": { "enum": [ "WORKSPACE_ACCESS", @@ -21187,6 +23489,32 @@ "WORKSPACE_CONSUME": "PRIVATE_PREVIEW" } }, + "iamv2.GetWorkspaceAccessDetailLocalRequest": { + "fields": { + "view": { + "description": "Controls what fields are returned.", + "ref": "iamv2.WorkspaceAccessDetailView", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "iamv2.GetWorkspaceAccessDetailRequest": { + "fields": { + "view": { + "description": "Controls what fields are returned.", + "ref": "iamv2.WorkspaceAccessDetailView", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "iamv2.GetWorkspaceAssignmentDetailProxyRequest": {}, + "iamv2.GetWorkspaceAssignmentDetailRequest": {}, "iamv2.Group": { "description": "The details of a Group resource.", "fields": { @@ -21220,6 +23548,42 @@ } } }, + "iamv2.ListWorkspaceAssignmentDetailsProxyRequest": { + "fields": { + "page_size": { + "description": "The maximum number of workspace assignment details to return. The service may return fewer than this value.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous ListWorkspaceAssignmentDetailsProxy call. Provide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "iamv2.ListWorkspaceAssignmentDetailsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of workspace assignment details to return. The service may return fewer than this value.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous ListWorkspaceAssignmentDetails call. Provide this to retrieve the subsequent page.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "iamv2.ListWorkspaceAssignmentDetailsResponse": { "description": "Response message for listing workspace assignment details.", "fields": { @@ -21385,6 +23749,32 @@ "INACTIVE": "PUBLIC_BETA" } }, + "iamv2.UpdateWorkspaceAssignmentDetailProxyRequest": { + "fields": { + "update_mask": { + "description": "Required. The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "workspace_assignment_detail": { + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "ref": "iamv2.WorkspaceAssignmentDetail", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "iamv2.UpdateWorkspaceAssignmentDetailRequest": { + "fields": { + "update_mask": { + "description": "Required. The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "workspace_assignment_detail": { + "description": "Required. Workspace assignment detail to be updated in \u003cDatabricks\u003e.", + "ref": "iamv2.WorkspaceAssignmentDetail", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "iamv2.User": { "description": "The details of a User resource.", "fields": { @@ -21545,10 +23935,7 @@ }, "principal_id": { "description": "The internal ID of the principal (user/sp/group) in Databricks.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "principal_type": { "ref": "iamv2.PrincipalType", @@ -21600,17 +23987,14 @@ }, "subscribers": { "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "warehouse_id": { "description": "The warehouse_id identifies the warehouse settings used by the alert task.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -21619,7 +24003,6 @@ "fields": { "alert_state": { "ref": "jobs.AlertEvaluationState", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -21628,12 +24011,10 @@ "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).", "fields": { "destination_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "user_name": { "description": "A valid workspace email address.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -21660,7 +24041,6 @@ }, "effective_budget_policy_id": { "description": "The id of the budget policy used by this job for cost attribution purposes.\nThis may be set through (in order of precedence):\n1. Budget admins through the account or workspace console\n2. Jobs UI in the job details page and Jobs API using `budget_policy_id`\n3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -21668,7 +24048,6 @@ }, "effective_usage_policy_id": { "description": "The id of the usage policy used by this job for cost attribution purposes.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -21732,7 +24111,6 @@ }, "effective_usage_policy_id": { "description": "The id of the usage policy used by this run for cost attribution purposes.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -22111,7 +24489,6 @@ }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "continuous": { @@ -22217,7 +24594,6 @@ }, "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.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "webhook_notifications": { @@ -22272,7 +24648,6 @@ }, "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\\\"}\"`)", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "subscription": { @@ -22543,6 +24918,19 @@ } } }, + "jobs.ExportRunRequest": { + "fields": { + "run_id": { + "description": "The canonical identifier for the run. This field is required.", + "launch_stage": "GA" + }, + "views_to_export": { + "description": "Which views to export (CODE, DASHBOARDS, or ALL). Defaults to CODE.", + "ref": "jobs.ViewsToExport", + "launch_stage": "GA" + } + } + }, "jobs.FileArrivalTriggerConfiguration": { "fields": { "min_time_between_triggers_seconds": { @@ -22688,6 +25076,7 @@ } } }, + "jobs.GetJobPermissionLevelsRequest": {}, "jobs.GetJobPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -22696,6 +25085,31 @@ } } }, + "jobs.GetJobPermissionsRequest": {}, + "jobs.GetJobRequest": { + "fields": { + "include_trigger_state": { + "description": "Flag that indicates that trigger state should be included in the response.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The canonical identifier of the job to retrieve information about. This field is required.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Use `next_page_token` returned from the previous GetJob response to request the next page of the job's array properties.", + "launch_stage": "GA" + } + } + }, + "jobs.GetPolicyComplianceRequest": { + "fields": { + "job_id": { + "description": "The ID of the job whose compliance status you are requesting.", + "launch_stage": "GA" + } + } + }, "jobs.GetPolicyComplianceResponse": { "fields": { "is_compliant": { @@ -22708,6 +25122,34 @@ } } }, + "jobs.GetRunOutputRequest": { + "fields": { + "run_id": { + "description": "The canonical identifier for the run.", + "launch_stage": "GA" + } + } + }, + "jobs.GetRunRequest": { + "fields": { + "include_history": { + "description": "Whether to include the repair history in the response.", + "launch_stage": "GA" + }, + "include_resolved_values": { + "description": "Whether to include resolved parameter values in the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Use `next_page_token` returned from the previous GetRun response to request the next page of the run's array properties.", + "launch_stage": "GA" + }, + "run_id": { + "description": "The canonical identifier of the run for which to retrieve the metadata.\nThis field is required.", + "launch_stage": "GA" + } + } + }, "jobs.GitProvider": { "enum": [ "gitHub", @@ -22771,7 +25213,6 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "ref": "jobs.JobSource", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "sparse_checkout": { @@ -22793,7 +25234,6 @@ }, "effective_budget_policy_id": { "description": "The id of the budget policy used by this job for cost attribution purposes.\nThis may be set through (in order of precedence):\n1. Budget admins through the account or workspace console\n2. Jobs UI in the job details page and Jobs API using `budget_policy_id`\n3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -22801,7 +25241,6 @@ }, "effective_usage_policy_id": { "description": "The id of the usage policy used by this job for cost attribution purposes.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -22915,7 +25354,6 @@ "fields": { "deployment_id": { "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "kind": { @@ -22929,7 +25367,6 @@ }, "version_id": { "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -22985,7 +25422,6 @@ }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -23105,7 +25541,6 @@ "fields": { "group_name": { "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "service_principal_name": { @@ -23122,7 +25557,6 @@ "fields": { "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "continuous": { @@ -23228,7 +25662,6 @@ }, "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.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "webhook_notifications": { @@ -23344,13 +25777,53 @@ } } }, + "jobs.ListJobComplianceRequest": { + "fields": { + "page_size": { + "description": "Use this field to specify the maximum number of results to be returned by the server.\nThe server may further constrain the maximum number of results returned in a\nsingle page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token that can be used to navigate to the next page or previous page as\nreturned by `next_page_token` or `prev_page_token`.", + "launch_stage": "GA" + }, + "policy_id": { + "description": "Canonical unique identifier for the cluster policy.", + "launch_stage": "GA" + } + } + }, + "jobs.ListJobsRequest": { + "fields": { + "expand_tasks": { + "description": "Whether to include task and cluster details in the response. Note that only the first 100 elements will be shown.\nUse :method:jobs/get to paginate through all tasks and clusters.", + "launch_stage": "GA" + }, + "limit": { + "description": "The number of jobs to return. This value must be greater than 0 and less or equal to 100. The default value is 20.", + "launch_stage": "GA" + }, + "name": { + "description": "A filter on the list based on the exact (case insensitive) job name.", + "launch_stage": "GA" + }, + "offset": { + "description": "The offset of the first job to return, relative to the most recently created job.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "page_token": { + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of jobs respectively.", + "launch_stage": "GA" + } + } + }, "jobs.ListJobsResponse": { "description": "List of jobs was retrieved successfully.", "fields": { "has_more": { "description": "If true, additional jobs matching the provided filter are available for listing.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "jobs": { @@ -23367,13 +25840,58 @@ } } }, + "jobs.ListRunsRequest": { + "fields": { + "active_only": { + "description": "If active_only is `true`, only active runs are included in the results; otherwise,\nlists both active and completed runs. An active run is a run in the `QUEUED`, `PENDING`,\n`RUNNING`, or `TERMINATING`. This field cannot be `true` when completed_only is `true`.", + "launch_stage": "GA" + }, + "completed_only": { + "description": "If completed_only is `true`, only completed runs are included in the results;\notherwise, lists both active and completed runs. This field cannot be `true` when\nactive_only is `true`.", + "launch_stage": "GA" + }, + "expand_tasks": { + "description": "Whether to include task and cluster details in the response. Note that only the first 100 elements will be shown.\nUse :method:jobs/getrun to paginate through all tasks and clusters.", + "launch_stage": "GA" + }, + "job_id": { + "description": "The job for which to list runs. If omitted, the Jobs service lists runs from all jobs.", + "launch_stage": "GA" + }, + "limit": { + "description": "The number of runs to return. This value must be greater than 0 and less than 25.\nThe default value is 20. If a request specifies a limit of 0, the service instead\nuses the maximum limit.", + "launch_stage": "GA" + }, + "offset": { + "description": "The offset of the first run to return, relative to the most recent run.\nDeprecated since June 2023. Use `page_token` to iterate through the pages instead.", + "deprecated": true, + "launch_stage": "PRIVATE_PREVIEW" + }, + "page_token": { + "description": "Use `next_page_token` or `prev_page_token` returned from the previous request to list the next or previous page of runs respectively.", + "launch_stage": "GA" + }, + "run_type": { + "description": "The type of runs to return. For a description of run types, see :method:jobs/getRun.", + "ref": "jobs.RunType", + "launch_stage": "GA" + }, + "start_time_from": { + "description": "Show runs that started _at or after_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_to_ to filter by a time range.", + "launch_stage": "GA" + }, + "start_time_to": { + "description": "Show runs that started _at or before_ this value. The value must be a UTC timestamp\nin milliseconds. Can be combined with _start_time_from_ to filter by a time range.", + "launch_stage": "GA" + } + } + }, "jobs.ListRunsResponse": { "description": "List of runs was retrieved successfully.", "fields": { "has_more": { "description": "If true, additional runs matching the provided filter are available for listing.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "next_page_token": { @@ -23529,22 +26047,18 @@ }, "full_refresh_selection": { "description": "A list of tables to update with fullRefresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "refresh_flow_selection": { "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "refresh_selection": { "description": "A list of tables to update without fullRefresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { "description": "A list of streaming flows to reset checkpoints without clearing data.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" } } @@ -23557,12 +26071,10 @@ }, "full_refresh_selection": { "description": "A list of tables to update with fullRefresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "parameters": { "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -23574,17 +26086,14 @@ }, "refresh_flow_selection": { "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "refresh_selection": { "description": "A list of tables to update without fullRefresh.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { "description": "A list of streaming flows to reset checkpoints without clearing data.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" } } @@ -23797,13 +26306,11 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "job_parameters": { @@ -23817,7 +26324,6 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "performance_target": { @@ -23832,13 +26338,11 @@ }, "python_named_params": { "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "rerun_all_failed_tasks": { @@ -23860,13 +26364,11 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -23928,7 +26430,6 @@ "fields": { "parameters": { "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -23979,7 +26480,6 @@ }, "pipeline_task": { "ref": "jobs.ResolvedPipelineTaskValues", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "python_wheel_task": { @@ -24048,7 +26548,6 @@ }, "effective_usage_policy_id": { "description": "The id of the usage policy used by this run for cost attribution purposes.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -24257,13 +26756,11 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "job_id": { @@ -24277,7 +26774,6 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "pipeline_params": { @@ -24287,25 +26783,21 @@ }, "python_named_params": { "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -24372,7 +26864,6 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "idempotency_token": { @@ -24382,7 +26873,6 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "job_id": { @@ -24396,7 +26886,6 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "only": { @@ -24415,13 +26904,11 @@ }, "python_named_params": { "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "queue": { @@ -24432,13 +26919,11 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -24463,7 +26948,6 @@ "alert_output": { "description": "The output of an alert task, if available", "ref": "jobs.AlertTaskOutput", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "clean_rooms_notebook_output": { @@ -24480,7 +26964,6 @@ "description": "Deprecated in favor of the new dbt_platform_output", "ref": "jobs.DbtCloudTaskOutput", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_output": { @@ -24490,7 +26973,6 @@ }, "dbt_platform_output": { "ref": "jobs.DbtPlatformTaskOutput", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "error": { @@ -24539,19 +27021,16 @@ "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "pipeline_params": { @@ -24561,25 +27040,21 @@ }, "python_named_params": { "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -24675,7 +27150,6 @@ "alert_task": { "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "ref": "jobs.AlertTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "attempt_number": { @@ -24699,7 +27173,6 @@ "compute": { "description": "Task level compute configuration.", "ref": "jobs.Compute", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "INPUT_ONLY" @@ -24719,12 +27192,10 @@ "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "ref": "jobs.DbtCloudTask", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_platform_task": { "ref": "jobs.DbtPlatformTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_task": { @@ -24787,7 +27258,6 @@ }, "gen_ai_compute_task": { "ref": "jobs.GenAiComputeTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "git_source": { @@ -24834,13 +27304,11 @@ "power_bi_task": { "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "ref": "jobs.PowerBiTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "python_operator_task": { "description": "The task runs a Python operator task.", "ref": "jobs.PythonOperatorTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "python_wheel_task": { @@ -25302,7 +27770,6 @@ }, "budget_policy_id": { "description": "The user specified id of the budget policy to use for this one-time run.\nIf not specified, the run will be not be attributed to any budget policy.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "INPUT_ONLY" @@ -25358,7 +27825,6 @@ }, "usage_policy_id": { "description": "The user specified id of the usage policy to use for this one-time run.\nIf not specified, a default usage policy may be applied when creating or modifying the job.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "INPUT_ONLY" @@ -25385,7 +27851,6 @@ "alert_task": { "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "ref": "jobs.AlertTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "clean_rooms_notebook_task": { @@ -25396,7 +27861,6 @@ "compute": { "description": "Task level compute configuration.", "ref": "jobs.Compute", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "INPUT_ONLY" @@ -25416,12 +27880,10 @@ "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "ref": "jobs.DbtCloudTask", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_platform_task": { "ref": "jobs.DbtPlatformTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_task": { @@ -25468,7 +27930,6 @@ }, "gen_ai_compute_task": { "ref": "jobs.GenAiComputeTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "health": { @@ -25510,13 +27971,11 @@ "power_bi_task": { "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "ref": "jobs.PowerBiTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "python_operator_task": { "description": "The task runs a Python operator task.", "ref": "jobs.PythonOperatorTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "python_wheel_task": { @@ -25638,10 +28097,7 @@ }, "table_names": { "description": "A list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`.", - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" }, "wait_after_last_change_seconds": { "description": "If set, the trigger starts a run only after no table updates have occurred for the specified time\nand can be used to wait for a series of table updates before triggering a run. The\nminimum allowed value is 60 seconds.", @@ -25654,7 +28110,6 @@ "alert_task": { "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "ref": "jobs.AlertTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "clean_rooms_notebook_task": { @@ -25665,7 +28120,6 @@ "compute": { "description": "Task level compute configuration.", "ref": "jobs.Compute", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "condition_task": { @@ -25682,12 +28136,10 @@ "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "ref": "jobs.DbtCloudTask", "deprecated": true, - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_platform_task": { "ref": "jobs.DbtPlatformTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "dbt_task": { @@ -25731,7 +28183,6 @@ }, "gen_ai_compute_task": { "ref": "jobs.GenAiComputeTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "health": { @@ -25777,13 +28228,11 @@ "power_bi_task": { "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "ref": "jobs.PowerBiTask", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "python_operator_task": { "description": "The task runs a Python operator task.", "ref": "jobs.PythonOperatorTask", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "python_wheel_task": { @@ -25874,7 +28323,6 @@ }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -25974,7 +28422,6 @@ "CLOUD_FAILURE": "The run failed due to a cloud provider issue. Refer to the state message for further details.", "CLUSTER_ERROR": "The run failed due to a cluster error. Refer to the state message for further details.", "CLUSTER_REQUEST_LIMIT_EXCEEDED": "The number of cluster creation, start, and upsize requests have exceeded the allotted rate limit. Consider spreading the run execution over a larger time frame.", - "CLUSTER_TERMINATED_BY_USER": "The run failed because the externally managed cluster entered an unusable state, likely due to the user terminating or restarting it outside the jobs service.", "DISABLED": "The run was never executed because it was disabled explicitly by the user.", "DRIVER_ERROR": "The run encountered an error while communicating with the Spark Driver.", "FEATURE_DISABLED": "The run failed because it tried to access a feature unavailable for the workspace.", @@ -26052,7 +28499,6 @@ }, "model": { "ref": "jobs.ModelTriggerConfiguration", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "pause_status": { @@ -26206,7 +28652,6 @@ }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -26222,6 +28667,35 @@ } } }, + "knowledgeassistants.CreateExampleRequest": { + "fields": { + "example": { + "description": "The example to create under the parent Knowledge Assistant.", + "ref": "knowledgeassistants.Example", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.CreateKnowledgeAssistantRequest": { + "fields": { + "knowledge_assistant": { + "description": "The Knowledge Assistant to create.", + "ref": "knowledgeassistants.KnowledgeAssistant", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.CreateKnowledgeSourceRequest": { + "fields": { + "knowledge_source": { + "ref": "knowledgeassistants.KnowledgeSource", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.DeleteExampleRequest": {}, + "knowledgeassistants.DeleteKnowledgeAssistantRequest": {}, + "knowledgeassistants.DeleteKnowledgeSourceRequest": {}, "knowledgeassistants.Example": { "description": "An example associated with a Knowledge Assistant.\nContains a question and guidelines for how the assistant should respond.", "fields": { @@ -26249,10 +28723,7 @@ }, "question": { "description": "The example question.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "update_time": { "description": "Timestamp when this example was last updated.", @@ -26268,17 +28739,11 @@ "fields": { "file_col": { "description": "The name of the column containing BINARY file content to be indexed.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "table_name": { "description": "Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -26287,13 +28752,12 @@ "fields": { "path": { "description": "A UC volume path that includes a list of files.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, + "knowledgeassistants.GetExampleRequest": {}, + "knowledgeassistants.GetKnowledgeAssistantPermissionLevelsRequest": {}, "knowledgeassistants.GetKnowledgeAssistantPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -26302,29 +28766,23 @@ } } }, + "knowledgeassistants.GetKnowledgeAssistantPermissionsRequest": {}, + "knowledgeassistants.GetKnowledgeAssistantRequest": {}, + "knowledgeassistants.GetKnowledgeSourceRequest": {}, "knowledgeassistants.IndexSpec": { "description": "IndexSpec specifies a vector search index source configuration.", "fields": { "doc_uri_col": { "description": "The column that specifies a link or reference to where the information came from.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "index_name": { "description": "Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "text_col": { "description": "The column that includes the document text for retrieval.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -26347,17 +28805,11 @@ }, "description": { "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "display_name": { "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "endpoint_name": { "description": "The name of the knowledge assistant agent endpoint.", @@ -26529,17 +28981,11 @@ }, "description": { "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "display_name": { "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "file_table": { "ref": "knowledgeassistants.FileTableSpec", @@ -26581,10 +29027,7 @@ }, "source_type": { "description": "The type of the source: \"index\", \"files\", or \"file_table\".\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "state": { "ref": "knowledgeassistants.KnowledgeSourceState", @@ -26607,6 +29050,24 @@ "UPDATING": "PUBLIC_BETA" } }, + "knowledgeassistants.ListExamplesRequest": { + "fields": { + "page_size": { + "description": "The maximum number of examples to return.\nIf unspecified, at most 100 examples will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "knowledgeassistants.ListExamplesResponse": { "description": "A list of Knowledge Assistant examples.", "fields": { @@ -26618,6 +29079,24 @@ } } }, + "knowledgeassistants.ListKnowledgeAssistantsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of knowledge assistants to return.\nIf unspecified, at most 100 knowledge assistants will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListKnowledgeAssistants` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "knowledgeassistants.ListKnowledgeAssistantsResponse": { "description": "A list of Knowledge Assistants.", "fields": { @@ -26630,6 +29109,22 @@ } } }, + "knowledgeassistants.ListKnowledgeSourcesRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "knowledgeassistants.ListKnowledgeSourcesResponse": { "fields": { "knowledge_sources": { @@ -26641,6 +29136,44 @@ } }, "knowledgeassistants.SyncKnowledgeSourcesRequest": {}, + "knowledgeassistants.UpdateExampleRequest": { + "fields": { + "example": { + "ref": "knowledgeassistants.Example", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.UpdateKnowledgeAssistantRequest": { + "fields": { + "knowledge_assistant": { + "description": "The Knowledge Assistant update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Assistant fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "ref": "knowledgeassistants.KnowledgeAssistant", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Comma-delimited list of fields to update on the Knowledge Assistant.\nAllowed values: `display_name`, `description`, `instructions`.\nExamples:\n- `display_name`\n- `description,instructions`", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "knowledgeassistants.UpdateKnowledgeSourceRequest": { + "fields": { + "knowledge_source": { + "description": "The Knowledge Source update payload.\nOnly fields listed in update_mask are updated.\nREQUIRED annotations on Knowledge Source fields describe create-time\nrequirements and do not mean all those fields are required for update.", + "ref": "knowledgeassistants.KnowledgeSource", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Comma-delimited list of fields to update on the Knowledge Source.\nAllowed values: `display_name`, `description`.\nExamples:\n- `display_name`\n- `display_name,description`", + "launch_stage": "PUBLIC_BETA" + } + } + }, "marketplace.AddExchangeForListingRequest": { "fields": { "exchange_id": { @@ -26681,6 +29214,13 @@ "ASSET_TYPE_PARTNER_INTEGRATION": "PUBLIC_PREVIEW" } }, + "marketplace.BatchGetListingsRequest": { + "fields": { + "ids": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.BatchGetListingsResponse": { "fields": { "listings": { @@ -26688,6 +29228,13 @@ } } }, + "marketplace.BatchGetProvidersRequest": { + "fields": { + "ids": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.BatchGetProvidersResponse": { "fields": { "providers": { @@ -26966,11 +29513,17 @@ } } }, + "marketplace.DeleteExchangeFilterRequest": {}, "marketplace.DeleteExchangeFilterResponse": {}, + "marketplace.DeleteExchangeRequest": {}, "marketplace.DeleteExchangeResponse": {}, + "marketplace.DeleteFileRequest": {}, "marketplace.DeleteFileResponse": {}, + "marketplace.DeleteInstallationRequest": {}, "marketplace.DeleteInstallationResponse": {}, + "marketplace.DeleteListingRequest": {}, "marketplace.DeleteListingResponse": {}, + "marketplace.DeleteProviderRequest": {}, "marketplace.DeleteProviderResponse": {}, "marketplace.DeltaSharingRecipientType": { "enum": [ @@ -27165,6 +29718,7 @@ "REQUEST_ACCESS": "PUBLIC_PREVIEW" } }, + "marketplace.GetExchangeRequest": {}, "marketplace.GetExchangeResponse": { "fields": { "exchange": { @@ -27173,6 +29727,7 @@ } } }, + "marketplace.GetFileRequest": {}, "marketplace.GetFileResponse": { "fields": { "file_info": { @@ -27181,6 +29736,7 @@ } } }, + "marketplace.GetLatestVersionProviderAnalyticsDashboardRequest": {}, "marketplace.GetLatestVersionProviderAnalyticsDashboardResponse": { "fields": { "version": { @@ -27189,6 +29745,16 @@ } } }, + "marketplace.GetListingContentMetadataRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.GetListingContentMetadataResponse": { "fields": { "next_page_token": { @@ -27199,6 +29765,7 @@ } } }, + "marketplace.GetListingRequest": {}, "marketplace.GetListingResponse": { "fields": { "listing": { @@ -27207,6 +29774,16 @@ } } }, + "marketplace.GetListingsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.GetListingsResponse": { "fields": { "listings": { @@ -27217,6 +29794,7 @@ } } }, + "marketplace.GetPersonalizationRequestRequest": {}, "marketplace.GetPersonalizationRequestResponse": { "fields": { "personalization_requests": { @@ -27224,6 +29802,7 @@ } } }, + "marketplace.GetProviderRequest": {}, "marketplace.GetProviderResponse": { "fields": { "provider": { @@ -27296,6 +29875,16 @@ "INSTALLED": "PUBLIC_PREVIEW" } }, + "marketplace.ListAllInstallationsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListAllInstallationsResponse": { "fields": { "installations": { @@ -27306,6 +29895,16 @@ } } }, + "marketplace.ListAllPersonalizationRequestsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListAllPersonalizationRequestsResponse": { "fields": { "next_page_token": { @@ -27316,6 +29915,32 @@ } } }, + "marketplace.ListConsumerProvidersRequest": { + "fields": { + "is_featured": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "marketplace.ListExchangeFiltersRequest": { + "fields": { + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListExchangeFiltersResponse": { "fields": { "filters": { @@ -27326,6 +29951,19 @@ } } }, + "marketplace.ListExchangesForListingRequest": { + "fields": { + "listing_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListExchangesForListingResponse": { "fields": { "exchange_listing": { @@ -27336,6 +29974,16 @@ } } }, + "marketplace.ListExchangesRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListExchangesResponse": { "fields": { "exchanges": { @@ -27346,6 +29994,20 @@ } } }, + "marketplace.ListFilesRequest": { + "fields": { + "file_parent": { + "ref": "marketplace.FileParent", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListFilesResponse": { "fields": { "file_infos": { @@ -27356,6 +30018,16 @@ } } }, + "marketplace.ListFulfillmentsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListFulfillmentsResponse": { "fields": { "fulfillments": { @@ -27366,6 +30038,16 @@ } } }, + "marketplace.ListInstallationsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListInstallationsResponse": { "fields": { "installations": { @@ -27376,6 +30058,19 @@ } } }, + "marketplace.ListListingsForExchangeRequest": { + "fields": { + "exchange_id": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListListingsForExchangeResponse": { "fields": { "exchange_listings": { @@ -27386,6 +30081,45 @@ } } }, + "marketplace.ListListingsRequest": { + "fields": { + "assets": { + "description": "Matches any of the following asset types", + "launch_stage": "PUBLIC_PREVIEW" + }, + "categories": { + "description": "Matches any of the following categories", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_free": { + "description": "Filters each listing based on if it is free.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_private_exchange": { + "description": "Filters each listing based on if it is a private exchange.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_staff_pick": { + "description": "Filters each listing based on whether it is a staff pick.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "provider_ids": { + "description": "Matches any of the following provider ids", + "launch_stage": "PUBLIC_PREVIEW" + }, + "tags": { + "description": "Matches listings with this tag", + "ref": "marketplace.ListingTag", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListListingsResponse": { "fields": { "listings": { @@ -27396,6 +30130,7 @@ } } }, + "marketplace.ListProviderAnalyticsDashboardRequest": {}, "marketplace.ListProviderAnalyticsDashboardResponse": { "fields": { "dashboard_id": { @@ -27410,6 +30145,16 @@ } } }, + "marketplace.ListProvidersRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.ListProvidersResponse": { "fields": { "next_page_token": { @@ -27817,6 +30562,7 @@ } } }, + "marketplace.RemoveExchangeForListingRequest": {}, "marketplace.RemoveExchangeForListingResponse": {}, "marketplace.RepoInfo": { "fields": { @@ -27838,6 +30584,38 @@ } } }, + "marketplace.SearchListingsRequest": { + "fields": { + "assets": { + "description": "Matches any of the following asset types", + "launch_stage": "PUBLIC_PREVIEW" + }, + "categories": { + "description": "Matches any of the following categories", + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_free": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "is_private_exchange": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_size": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW" + }, + "provider_ids": { + "description": "Matches any of the following provider ids", + "launch_stage": "PUBLIC_PREVIEW" + }, + "query": { + "description": "Fuzzy matches query", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "marketplace.SearchListingsResponse": { "fields": { "listings": { @@ -28296,10 +31074,7 @@ "fields": { "input": { "description": "The input column from which the approximate count of distinct values is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "relative_sd": { "description": "The maximum relative standard deviation allowed (default defined by Spark).", @@ -28322,17 +31097,11 @@ }, "input": { "description": "The input column from which the approximate percentile is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "percentile": { "description": "The percentile value to compute (between 0 and 1).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28360,10 +31129,7 @@ "fields": { "input": { "description": "The input column from which the average is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28391,10 +31157,7 @@ "fields": { "requests": { "description": "The requests to create materialized features.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28410,10 +31173,7 @@ "fields": { "variant_expr_path": { "description": "String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28422,10 +31182,7 @@ "fields": { "column": { "description": "Column name from source to select as the feature value.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28494,10 +31251,7 @@ }, "window_duration": { "description": "The duration of the continuous window (must be positive).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28506,10 +31260,7 @@ "fields": { "input": { "description": "The input column from which the count is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28563,6 +31314,23 @@ } } }, + "ml.CreateFeatureRequest": { + "fields": { + "feature": { + "description": "Feature to create.", + "ref": "ml.Feature", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.CreateFeatureTagRequest": { + "fields": { + "feature_tag": { + "ref": "ml.FeatureTag", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.CreateForecastingExperimentRequest": { "fields": { "custom_weights_column": { @@ -28643,6 +31411,14 @@ } } }, + "ml.CreateKafkaConfigRequest": { + "fields": { + "kafka_config": { + "ref": "ml.KafkaConfig", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.CreateLoggedModelRequest": { "fields": { "experiment_id": { @@ -28685,10 +31461,7 @@ "materialized_feature": { "description": "The materialized feature to create.", "ref": "ml.MaterializedFeature", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -28753,6 +31526,15 @@ } } }, + "ml.CreateOnlineStoreRequest": { + "fields": { + "online_store": { + "description": "Online store to create.", + "ref": "ml.OnlineStore", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.CreateRegistryWebhook": { "description": "Details required to create a registry webhook.", "fields": { @@ -28819,6 +31601,15 @@ } } }, + "ml.CreateStreamRequest": { + "fields": { + "stream": { + "description": "The Stream to create.", + "ref": "ml.Stream", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.CreateTransitionRequest": { "description": "Details required to create a model version stage transition request.", "fields": { @@ -28941,6 +31732,14 @@ } } }, + "ml.DeleteCommentRequest": { + "fields": { + "id": { + "description": "Unique identifier of an activity", + "launch_stage": "GA" + } + } + }, "ml.DeleteCommentResponse": {}, "ml.DeleteExperiment": { "fields": { @@ -28951,12 +31750,68 @@ } }, "ml.DeleteExperimentResponse": {}, + "ml.DeleteFeatureRequest": {}, + "ml.DeleteFeatureTagRequest": {}, + "ml.DeleteKafkaConfigRequest": {}, + "ml.DeleteLoggedModelRequest": {}, "ml.DeleteLoggedModelResponse": {}, + "ml.DeleteLoggedModelTagRequest": {}, "ml.DeleteLoggedModelTagResponse": {}, + "ml.DeleteMaterializedFeatureRequest": {}, + "ml.DeleteModelRequest": { + "fields": { + "name": { + "description": "Registered model unique name identifier.", + "launch_stage": "GA" + } + } + }, "ml.DeleteModelResponse": {}, + "ml.DeleteModelTagRequest": { + "fields": { + "key": { + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the registered model that the tag was logged under.", + "launch_stage": "GA" + } + } + }, "ml.DeleteModelTagResponse": {}, + "ml.DeleteModelVersionRequest": { + "fields": { + "name": { + "description": "Name of the registered model", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number", + "launch_stage": "GA" + } + } + }, "ml.DeleteModelVersionResponse": {}, + "ml.DeleteModelVersionTagRequest": { + "fields": { + "key": { + "description": "Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the registered model that the tag was logged under.", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number that the tag was logged under.", + "launch_stage": "GA" + } + } + }, "ml.DeleteModelVersionTagResponse": {}, + "ml.DeleteOnlineStoreRequest": {}, + "ml.DeleteOnlineTableRequest": {}, "ml.DeleteRun": { "fields": { "run_id": { @@ -28990,6 +31845,7 @@ } } }, + "ml.DeleteStreamRequest": {}, "ml.DeleteTag": { "fields": { "key": { @@ -29003,6 +31859,30 @@ } }, "ml.DeleteTagResponse": {}, + "ml.DeleteTransitionRequestRequest": { + "fields": { + "comment": { + "description": "User-provided comment on the action.", + "launch_stage": "GA" + }, + "creator": { + "description": "Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted.", + "launch_stage": "GA" + }, + "name": { + "description": "Name of the model.", + "launch_stage": "GA" + }, + "stage": { + "description": "Target stage of the transition request. Valid values are:\n\n* `None`: The initial stage of a model version.\n\n* `Staging`: Staging or pre-production stage.\n\n* `Production`: Production stage.\n\n* `Archived`: Archived stage.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, "ml.DeleteTransitionRequestResponse": { "fields": { "activity": { @@ -29012,6 +31892,14 @@ } } }, + "ml.DeleteWebhookRequest": { + "fields": { + "id": { + "description": "Webhook ID required to delete a registry webhook.", + "launch_stage": "GA" + } + } + }, "ml.DeleteWebhookResponse": {}, "ml.DeltaTableSource": { "fields": { @@ -29039,10 +31927,7 @@ }, "full_name": { "description": "The full three-part (catalog, schema, table) name of the Delta table.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "timeseries_column": { "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table.", @@ -29066,18 +31951,12 @@ "fields": { "bootstrap_servers": { "description": "A comma-separated list of host:port pairs for the Kafka bootstrap servers.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "mtls_config": { "description": "Mutual-TLS authentication configuration.", "ref": "ml.MtlsConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29106,10 +31985,7 @@ "fields": { "name": { "description": "The name of the entity column. For Kafka sources, use dot-prefixed path notation to reference\nfields within the key or value schema (e.g., \"value.user_id\", \"key.partition_key\"). For nested\nfields, the leaf node name (e.g., \"user_id\" from \"value.trip_details.user_id\") is what will\nbe present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:user_id\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29305,8 +32181,7 @@ "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "IMMUTABLE", - "REQUIRED" + "IMMUTABLE" ] }, "function": { @@ -29314,8 +32189,7 @@ "ref": "ml.Function", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "IMMUTABLE", - "REQUIRED" + "IMMUTABLE" ] }, "inputs": { @@ -29354,8 +32228,7 @@ "ref": "ml.DataSource", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "IMMUTABLE", - "REQUIRED" + "IMMUTABLE" ] }, "time_window": { @@ -29438,10 +32311,7 @@ "description": "Represents a tag on a feature in a feature table.", "fields": { "key": { - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "value": { "launch_stage": "PRIVATE_PREVIEW", @@ -29457,17 +32327,11 @@ "data_type": { "description": "The scalar data type of the field.", "ref": "ml.ScalarDataType", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "name": { "description": "The name of the field.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29511,10 +32375,7 @@ "fields": { "input": { "description": "The input column from which the first value is returned.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29523,10 +32384,7 @@ "fields": { "fields": { "description": "The list of fields in this schema.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29606,17 +32464,11 @@ "fields": { "key": { "description": "The name of the parameter.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "value": { "description": "The value of the parameter.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -29653,6 +32505,14 @@ "VAR_SAMP": "PRIVATE_PREVIEW" } }, + "ml.GetByNameRequest": { + "fields": { + "experiment_name": { + "description": "Name of the associated experiment.", + "launch_stage": "GA" + } + } + }, "ml.GetExperimentByNameResponse": { "fields": { "experiment": { @@ -29662,6 +32522,7 @@ } } }, + "ml.GetExperimentPermissionLevelsRequest": {}, "ml.GetExperimentPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -29670,6 +32531,15 @@ } } }, + "ml.GetExperimentPermissionsRequest": {}, + "ml.GetExperimentRequest": { + "fields": { + "experiment_id": { + "description": "ID of the associated experiment.", + "launch_stage": "GA" + } + } + }, "ml.GetExperimentResponse": { "fields": { "experiment": { @@ -29679,6 +32549,36 @@ } } }, + "ml.GetFeatureLineageRequest": {}, + "ml.GetFeatureRequest": {}, + "ml.GetFeatureTagRequest": {}, + "ml.GetForecastingExperimentRequest": {}, + "ml.GetHistoryRequest": { + "fields": { + "max_results": { + "description": "Maximum number of Metric records to return per paginated request. Default is set to 25,000. If set higher than\n25,000, a request Exception will be raised.", + "launch_stage": "GA" + }, + "metric_key": { + "description": "Name of the metric.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token indicating the page of metric histories to fetch.", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run from which to fetch metric values. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run from which to fetch metric values. This field\nwill be removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, + "ml.GetKafkaConfigRequest": {}, "ml.GetLatestVersionsRequest": { "fields": { "name": { @@ -29699,6 +32599,7 @@ } } }, + "ml.GetLoggedModelRequest": {}, "ml.GetLoggedModelResponse": { "fields": { "model": { @@ -29708,6 +32609,7 @@ } } }, + "ml.GetMaterializedFeatureRequest": {}, "ml.GetMetricHistoryResponse": { "fields": { "metrics": { @@ -29720,6 +32622,14 @@ } } }, + "ml.GetModelRequest": { + "fields": { + "name": { + "description": "Registered model unique name identifier.", + "launch_stage": "GA" + } + } + }, "ml.GetModelResponse": { "fields": { "registered_model_databricks": { @@ -29728,6 +32638,18 @@ } } }, + "ml.GetModelVersionDownloadUriRequest": { + "fields": { + "name": { + "description": "Name of the registered model", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number", + "launch_stage": "GA" + } + } + }, "ml.GetModelVersionDownloadUriResponse": { "fields": { "artifact_uri": { @@ -29736,6 +32658,18 @@ } } }, + "ml.GetModelVersionRequest": { + "fields": { + "name": { + "description": "Name of the registered model", + "launch_stage": "GA" + }, + "version": { + "description": "Model version number", + "launch_stage": "GA" + } + } + }, "ml.GetModelVersionResponse": { "fields": { "model_version": { @@ -29744,6 +32678,8 @@ } } }, + "ml.GetOnlineStoreRequest": {}, + "ml.GetRegisteredModelPermissionLevelsRequest": {}, "ml.GetRegisteredModelPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -29752,6 +32688,20 @@ } } }, + "ml.GetRegisteredModelPermissionsRequest": {}, + "ml.GetRunRequest": { + "fields": { + "run_id": { + "description": "ID of the run to fetch. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run to fetch. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, "ml.GetRunResponse": { "fields": { "run": { @@ -29761,6 +32711,7 @@ } } }, + "ml.GetStreamRequest": {}, "ml.HttpUrlSpec": { "fields": { "authorization": { @@ -29821,10 +32772,7 @@ "ingestion_destination": { "description": "Destination for the Databricks-managed Delta table that holds an offline copy of the streaming data for querying and training.\nThis table contains both 1) forward-filled data from the Stream and 2) backfilled data from the BackfillSource (if provided).\nThis table is created and managed by Databricks and is deleted when the Stream is deleted.", "ref": "ml.IngestionDestination", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "ingestion_job_id": { "description": "The ID of the Databricks Job that performs the forward-fill ingestion.", @@ -29918,10 +32866,7 @@ "auth_config": { "description": "Authentication configuration for connection to topics.", "ref": "ml.AuthConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "backfill_source": { "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config.", @@ -29933,10 +32878,7 @@ }, "bootstrap_servers": { "description": "A comma-separated list of host/port pairs pointing to Kafka cluster.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "extra_options": { "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)", @@ -29955,18 +32897,12 @@ }, "name": { "description": "Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "subscription_mode": { "description": "Options to configure which Kafka topics to pull data from.", "ref": "ml.SubscriptionMode", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "value_schema": { "description": "Schema configuration for extracting message values from topics. At least one of key_schema and value_schema must be provided.", @@ -29997,10 +32933,7 @@ }, "name": { "description": "Name of the Kafka source, used to identify it. This is used to look up the corresponding KafkaConfig object. Can be distinct from topic name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "timeseries_column_identifier": { "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column identifier of the Kafka source.", @@ -30026,10 +32959,7 @@ "subscription_mode": { "description": "Options to configure which Kafka topics to pull data from.", "ref": "ml.KafkaSubscriptionMode", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -30064,10 +32994,7 @@ "fields": { "input": { "description": "The input column from which the last value is returned.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -30108,6 +33035,27 @@ } } }, + "ml.ListArtifactsRequest": { + "fields": { + "page_token": { + "description": "The token indicating the page of artifact results to fetch. `page_token` is not supported when listing artifacts in UC\nVolumes. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call\n`/api/2.0/fs/directories{directory_path}` for listing artifacts in UC Volumes, which supports pagination. See [List\ndirectory contents | Files API](/api/workspace/files/listdirectorycontents).", + "launch_stage": "GA" + }, + "path": { + "description": "Filter artifacts matching this path (a relative path from the root artifact directory).", + "launch_stage": "GA" + }, + "run_id": { + "description": "ID of the run whose artifacts to list. Must be provided.", + "launch_stage": "GA" + }, + "run_uuid": { + "description": "[Deprecated, use `run_id` instead] ID of the run whose artifacts to list. This field will\nbe removed in a future MLflow version.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, "ml.ListArtifactsResponse": { "fields": { "files": { @@ -30124,6 +33072,23 @@ } } }, + "ml.ListExperimentsRequest": { + "fields": { + "max_results": { + "description": "Maximum number of experiments desired.\nIf `max_results` is unspecified, return all experiments.\nIf `max_results` is too large, it'll be automatically capped at 1000.\nCallers of this endpoint are encouraged to pass max_results explicitly and leverage\npage_token to iterate through experiments.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token indicating the page of experiments to fetch", + "launch_stage": "GA" + }, + "view_type": { + "description": "Qualifier for type of experiments to be returned.\nIf unspecified, return only active experiments.", + "ref": "ml.ViewType", + "launch_stage": "GA" + } + } + }, "ml.ListExperimentsResponse": { "fields": { "experiments": { @@ -30136,6 +33101,24 @@ } } }, + "ml.ListFeatureTagsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of results to return.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "ml.ListFeatureTagsResponse": { "description": "Response message for ListFeatureTag.", "fields": { @@ -30148,6 +33131,32 @@ } } }, + "ml.ListFeaturesRequest": { + "fields": { + "catalog_name": { + "description": "Name of parent catalog for features of interest.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "page_size": { + "description": "The maximum number of results to return.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "schema_name": { + "description": "Name of parent schema relative to its parent catalog.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.ListFeaturesResponse": { "fields": { "features": { @@ -30160,21 +33169,61 @@ } } }, - "ml.ListKafkaConfigsResponse": { + "ml.ListKafkaConfigsRequest": { "fields": { - "kafka_configs": { - "description": "List of Kafka configs. Schemas are not included in the response.", + "page_size": { + "description": "The maximum number of results to return.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ - "REQUIRED" + "OPTIONAL" ] }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.ListKafkaConfigsResponse": { + "fields": { + "kafka_configs": { + "description": "List of Kafka configs. Schemas are not included in the response.", + "launch_stage": "PRIVATE_PREVIEW" + }, "next_page_token": { "description": "Pagination token to request the next page of results for this query.", "launch_stage": "PRIVATE_PREVIEW" } } }, + "ml.ListMaterializedFeaturesRequest": { + "fields": { + "feature_name": { + "description": "Filter by feature name. If specified, only materialized features materialized from this feature will be returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "The maximum number of results to return. Defaults to 100 if not specified. Cannot be greater than 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "ml.ListMaterializedFeaturesResponse": { "fields": { "materialized_features": { @@ -30187,6 +33236,18 @@ } } }, + "ml.ListModelsRequest": { + "fields": { + "max_results": { + "description": "Maximum number of registered models desired. Max threshold is 1000.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "GA" + } + } + }, "ml.ListModelsResponse": { "fields": { "next_page_token": { @@ -30198,6 +33259,24 @@ } } }, + "ml.ListOnlineStoresRequest": { + "fields": { + "page_size": { + "description": "The maximum number of results to return. Defaults to 100 if not specified.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "ml.ListOnlineStoresResponse": { "fields": { "next_page_token": { @@ -30222,6 +33301,31 @@ } } }, + "ml.ListStreamsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of results to return.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous query.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "parent": { + "description": "Two-part name (catalog.schema) of the parent under which to list Streams.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "ml.ListStreamsResponse": { "description": "Response to a ListStreamsRequest.", "fields": { @@ -30235,6 +33339,18 @@ } } }, + "ml.ListTransitionRequestsRequest": { + "fields": { + "name": { + "description": "Name of the registered model.", + "launch_stage": "GA" + }, + "version": { + "description": "Version of the model.", + "launch_stage": "GA" + } + } + }, "ml.ListTransitionRequestsResponse": { "fields": { "requests": { @@ -30243,6 +33359,25 @@ } } }, + "ml.ListWebhooksRequest": { + "fields": { + "events": { + "description": "Events that trigger the webhook.\n* `MODEL_VERSION_CREATED`: A new model version was created for the associated model.\n\n* `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was changed.\n\n* `TRANSITION_REQUEST_CREATED`: A user requested a model version’s stage be transitioned.\n\n* `COMMENT_CREATED`: A user wrote a comment on a registered model.\n\n* `REGISTERED_MODEL_CREATED`: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.\n\n* `MODEL_VERSION_TAG_SET`: A user set a tag on the model version.\n\n* `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was transitioned to staging.\n\n* `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was transitioned to production.\n\n* `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived.\n\n* `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model version be transitioned to staging.\n\n* `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production.\n\n* `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived.\n\nIf `events` is specified, any webhook with one or more of the specified trigger events is included in the output.\nIf `events` is not specified, webhooks of all event types are included in the output.", + "launch_stage": "GA" + }, + "max_results": { + "launch_stage": "GA" + }, + "model_name": { + "description": "Registered model name\nIf not specified, all webhooks associated with the specified events are listed, regardless of their associated model.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token indicating the page of artifact results to fetch", + "launch_stage": "GA" + } + } + }, "ml.LogBatch": { "fields": { "metrics": { @@ -30521,10 +33656,7 @@ }, "feature_name": { "description": "The full name of the feature in Unity Catalog.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "is_online": { "description": "True if this is an online materialized feature. False if it is an offline materialized feature.", @@ -30613,10 +33745,7 @@ "fields": { "input": { "description": "The input column from which the maximum is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -30662,10 +33791,7 @@ "fields": { "input": { "description": "The input column from which the minimum is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -30886,7 +34012,7 @@ "launch_stage": "GA" }, "status": { - "ref": "ml.status", + "ref": "ml.Status", "launch_stage": "GA" }, "status_message": { @@ -30950,40 +34076,25 @@ "key_password_ref": { "description": "Secret-scope reference for the private key password. Often the same value as the\nkeystore password (keytool's default), but provided as a separate field because\nApache Kafka requires it as a distinct option (kafka.ssl.key.password).", "ref": "ml.SecretScopeReference", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "keystore_location": { "description": "Unity Catalog volume path to the JKS keystore file containing the client certificate\nand private key. e.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/client.jks\". The\nmaterialization compute must have read permission on this volume.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "keystore_password_ref": { "description": "Secret-scope reference for the JKS keystore password.", "ref": "ml.SecretScopeReference", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "truststore_location": { "description": "Unity Catalog volume path to the JKS truststore file containing the CA certificate(s)\ntrusted to verify the Kafka broker's server certificate.\ne.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/truststore.jks\".", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "truststore_password_ref": { "description": "Secret-scope reference for the JKS truststore password.", "ref": "ml.SecretScopeReference", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -30992,24 +34103,15 @@ "fields": { "catalog_name": { "description": "The Unity Catalog catalog name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "schema_name": { "description": "The Unity Catalog schema name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "table_name_prefix": { "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a table with this prefix and a generated postfix.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31018,10 +34120,7 @@ "fields": { "capacity": { "description": "The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "creation_time": { "description": "The timestamp when the online store was created.", @@ -31039,10 +34138,7 @@ }, "name": { "description": "The name of the online store. This is the unique identifier for the online store.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "read_replica_count": { "description": "The number of read replicas for the online store. Defaults to 0.", @@ -31073,31 +34169,19 @@ "fields": { "catalog_name": { "description": "The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "online_store_name": { "description": "The name of the target online store.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "schema_name": { "description": "The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "table_name_prefix": { "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31155,25 +34239,16 @@ "fields": { "online_store": { "description": "The name of the target online store.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "online_table_name": { "description": "The full three-part (catalog, schema, table) name of the online table.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "publish_mode": { "description": "The publish mode of the pipeline that syncs the online table with the source table.", "ref": "ml.PublishSpecPublishMode", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31194,10 +34269,7 @@ "publish_spec": { "description": "The specification for publishing the online table from the source table.", "ref": "ml.PublishSpec", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31538,10 +34610,7 @@ }, "window_duration": { "description": "The duration of the rolling window (must be positive).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31822,6 +34891,26 @@ } } }, + "ml.SearchModelVersionsRequest": { + "fields": { + "filter": { + "description": "String filter condition, like \"name='my-model-name'\". Must be a single boolean condition,\nwith string values wrapped in single quotes.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of models desired. Max threshold is 10K.", + "launch_stage": "GA" + }, + "order_by": { + "description": "List of columns to be ordered by including model name, version, stage with an\noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Pagination token to go to next page based on previous search query.", + "launch_stage": "GA" + } + } + }, "ml.SearchModelVersionsResponse": { "fields": { "model_versions": { @@ -31834,6 +34923,26 @@ } } }, + "ml.SearchModelsRequest": { + "fields": { + "filter": { + "description": "String filter condition, like \"name LIKE 'my-model-name'\".\nInterpreted in the backend automatically as \"name LIKE '%my-model-name%'\".\nSingle boolean condition, with string values wrapped in single quotes.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of models desired. Default is 100. Max threshold is 1000.", + "launch_stage": "GA" + }, + "order_by": { + "description": "List of columns for ordering search results, which can include model name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by model name ASC.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Pagination token to go to the next page based on a previous search query.", + "launch_stage": "GA" + } + } + }, "ml.SearchModelsResponse": { "fields": { "next_page_token": { @@ -31892,17 +35001,11 @@ "fields": { "key": { "description": "The key within the scope.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "scope": { "description": "The Databricks secret scope name.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -31996,29 +35099,38 @@ "fields": { "slide_duration": { "description": "The slide duration (interval by which windows advance, must be positive and less than duration).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "window_duration": { "description": "The duration of the sliding window.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, + "ml.Status": { + "description": "The status of the model version. Valid values are:\n* `PENDING_REGISTRATION`: Request to register a new model version is pending as server performs background tasks.\n\n* `FAILED_REGISTRATION`: Request to register a new model version has failed.\n\n* `READY`: Model version is ready for use.", + "enum": [ + "PENDING_REGISTRATION", + "FAILED_REGISTRATION", + "READY" + ], + "enum_launch_stages": { + "FAILED_REGISTRATION": "GA", + "PENDING_REGISTRATION": "GA", + "READY": "GA" + }, + "enum_descriptions": { + "FAILED_REGISTRATION": "Request to register a new model version has failed.", + "PENDING_REGISTRATION": "Request to register a new model version is pending as server performs background tasks.", + "READY": "Model version is ready for use." + } + }, "ml.StddevPopFunction": { "description": "Computes the population standard deviation.", "fields": { "input": { "description": "The input column from which the population standard deviation is computed. For Kafka sources,\nuse dot-prefixed path notation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32027,10 +35139,7 @@ "fields": { "input": { "description": "The input column from which the sample standard deviation is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32047,10 +35156,7 @@ "connection_config": { "description": "Specifies how to connect and authenticate to the stream platform.", "ref": "ml.StreamConnectionConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "create_time": { "description": "Time at which this Stream was created.", @@ -32076,33 +35182,21 @@ "ingestion_config": { "description": "Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill.", "ref": "ml.IngestionConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "name": { "description": "Full three-part (catalog.schema.stream) name of the stream.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "schema_config": { "description": "Schema definitions for the stream. Currently only direct schemas are supported.\nIn a future milestone, we will support schema registries through a UC Connection.", "ref": "ml.StreamSchemaConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "source_config": { "description": "Source-specific configuration. Determines the streaming platform source.", "ref": "ml.StreamSourceConfig", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" }, "update_time": { "description": "Time at which this Stream was last modified.", @@ -32220,10 +35314,7 @@ "fields": { "input": { "description": "The input column from which the sum is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32293,10 +35384,7 @@ "fields": { "name": { "description": "The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \"event_timestamp\" from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32363,10 +35451,7 @@ "fields": { "window_duration": { "description": "The duration of each tumbling window (non-overlapping, fixed-duration windows).", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32405,6 +35490,60 @@ } }, "ml.UpdateExperimentResponse": {}, + "ml.UpdateFeatureRequest": { + "fields": { + "feature": { + "description": "Feature to update.", + "ref": "ml.Feature", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.UpdateFeatureTagRequest": { + "fields": { + "feature_tag": { + "ref": "ml.FeatureTag", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.UpdateKafkaConfigRequest": { + "fields": { + "kafka_config": { + "description": "The Kafka config to update.", + "ref": "ml.KafkaConfig", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "ml.UpdateMaterializedFeatureRequest": { + "fields": { + "materialized_feature": { + "description": "The materialized feature to update.", + "ref": "ml.MaterializedFeature", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "Provide the materialization feature fields which should be updated.\nCurrently, only the pipeline_state field can be updated.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.UpdateModelRequest": { "fields": { "description": { @@ -32450,6 +35589,19 @@ } } }, + "ml.UpdateOnlineStoreRequest": { + "fields": { + "online_store": { + "description": "Online store to update.", + "ref": "ml.OnlineStore", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.UpdateRegistryWebhook": { "description": "Details required to update a registry webhook. Only the fields that need to be updated should be specified, and both `http_url_spec` and `job_spec` should not be specified in the same request.", "fields": { @@ -32531,6 +35683,19 @@ "SCHEDULED": "GA" } }, + "ml.UpdateStreamRequest": { + "fields": { + "stream": { + "description": "The Stream to update.", + "ref": "ml.Stream", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "The list of fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "ml.UpdateWebhookResponse": { "fields": { "webhook": { @@ -32544,10 +35709,7 @@ "fields": { "input": { "description": "The input column from which the population variance is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32556,10 +35718,7 @@ "fields": { "input": { "description": "The input column from which the sample variance is computed.", - "launch_stage": "PRIVATE_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PRIVATE_PREVIEW" } } }, @@ -32576,39 +35735,15 @@ "DELETED_ONLY": "GA" } }, - "ml.status": { - "description": "The status of the model version. Valid values are:\n* `PENDING_REGISTRATION`: Request to register a new model version is pending as server performs background tasks.\n\n* `FAILED_REGISTRATION`: Request to register a new model version has failed.\n\n* `READY`: Model version is ready for use.", - "enum": [ - "PENDING_REGISTRATION", - "FAILED_REGISTRATION", - "READY" - ], - "enum_launch_stages": { - "FAILED_REGISTRATION": "GA", - "PENDING_REGISTRATION": "GA", - "READY": "GA" - }, - "enum_descriptions": { - "FAILED_REGISTRATION": "Request to register a new model version has failed.", - "PENDING_REGISTRATION": "Request to register a new model version is pending as server performs background tasks.", - "READY": "Model version is ready for use." - } - }, "networking.AzurePrivateEndpointInfo": { "fields": { "private_endpoint_name": { "description": "The name of the Private Endpoint in the Azure subscription.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "private_endpoint_resource_guid": { "description": "The GUID of the Private Endpoint resource in the Azure subscription.\nThis is assigned by Azure when the user sets up the Private Endpoint.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "private_endpoint_resource_id": { "description": "The full resource ID of the Private Endpoint.", @@ -32626,6 +35761,15 @@ } } }, + "networking.CreateEndpointRequest": { + "fields": { + "endpoint": { + "ref": "networking.Endpoint", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "networking.DeleteEndpointRequest": {}, "networking.Endpoint": { "description": "Endpoint represents a cloud networking resource in a user's cloud account and binds it to the Databricks account.", "fields": { @@ -32633,8 +35777,8 @@ "description": "The Databricks Account in which the endpoint object exists.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "azure_private_endpoint_info": { @@ -32642,23 +35786,22 @@ "ref": "networking.AzurePrivateEndpointInfo", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] }, "create_time": { "description": "The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "display_name": { "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -32666,23 +35809,22 @@ "description": "The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "name": { "description": "The resource name of the endpoint, which uniquely identifies the endpoint.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "region": { "description": "The cloud provider region where this endpoint is located.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -32699,8 +35841,8 @@ "ref": "networking.EndpointUseCase", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] } } @@ -32727,6 +35869,23 @@ "SERVICE_DIRECT": "PUBLIC_PREVIEW" } }, + "networking.GetEndpointRequest": {}, + "networking.ListEndpointsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "networking.ListEndpointsResponse": { "fields": { "items": { @@ -32737,6 +35896,21 @@ } } }, + "oauth2.CreateAccountFederationPolicyRequest": { + "fields": { + "policy": { + "ref": "oauth2.FederationPolicy", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "oauth2.CreateCustomAppIntegration": { "fields": { "confidential": { @@ -32803,6 +35977,21 @@ } } }, + "oauth2.CreateServicePrincipalFederationPolicyRequest": { + "fields": { + "policy": { + "ref": "oauth2.FederationPolicy", + "launch_stage": "GA" + }, + "policy_id": { + "description": "The identifier for the federation policy. The identifier must contain only lowercase\nalphanumeric characters, numbers, hyphens, and slashes. If unspecified, the id will be\nassigned by Databricks.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "oauth2.CreateServicePrincipalSecretRequest": { "fields": { "lifetime": { @@ -32843,16 +36032,21 @@ } } }, + "oauth2.DeleteAccountFederationPolicyRequest": {}, "oauth2.DeleteCustomAppIntegrationOutput": {}, + "oauth2.DeleteCustomAppIntegrationRequest": {}, "oauth2.DeletePublishedAppIntegrationOutput": {}, + "oauth2.DeletePublishedAppIntegrationRequest": {}, + "oauth2.DeleteServicePrincipalFederationPolicyRequest": {}, + "oauth2.DeleteServicePrincipalSecretRequest": {}, "oauth2.FederationPolicy": { "fields": { "create_time": { "description": "Creation time of the federation policy.", "launch_stage": "GA", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "description": { @@ -32866,8 +36060,8 @@ "description": "Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL.", "launch_stage": "GA", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "oidc_policy": { @@ -32881,26 +36075,26 @@ "description": "The ID of the federation policy. Output only.", "launch_stage": "GA", "behaviors": [ + "IMMUTABLE", "OPTIONAL", - "OUTPUT_ONLY", - "IMMUTABLE" + "OUTPUT_ONLY" ] }, "service_principal_id": { "description": "The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.", "launch_stage": "GA", "behaviors": [ + "IMMUTABLE", "OPTIONAL", - "OUTPUT_ONLY", - "IMMUTABLE" + "OUTPUT_ONLY" ] }, "uid": { "description": "Unique, immutable id of the federation policy.", "launch_stage": "GA", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "update_time": { @@ -32912,6 +36106,7 @@ } } }, + "oauth2.GetAccountFederationPolicyRequest": {}, "oauth2.GetCustomAppIntegrationOutput": { "fields": { "client_id": { @@ -32957,6 +36152,7 @@ } } }, + "oauth2.GetCustomAppIntegrationRequest": {}, "oauth2.GetCustomAppIntegrationsOutput": { "fields": { "apps": { @@ -32995,6 +36191,7 @@ } } }, + "oauth2.GetPublishedAppIntegrationRequest": {}, "oauth2.GetPublishedAppIntegrationsOutput": { "fields": { "apps": { @@ -33018,6 +36215,36 @@ } } }, + "oauth2.GetServicePrincipalFederationPolicyRequest": {}, + "oauth2.ListAccountFederationPoliciesRequest": { + "fields": { + "page_size": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "oauth2.ListCustomAppIntegrationsRequest": { + "fields": { + "include_creator_username": { + "launch_stage": "GA" + }, + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "launch_stage": "GA" + } + } + }, "oauth2.ListFederationPoliciesResponse": { "fields": { "next_page_token": { @@ -33028,6 +36255,55 @@ } } }, + "oauth2.ListOAuthPublishedAppsRequest": { + "fields": { + "page_size": { + "description": "The max number of OAuth published apps to return in one page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A token that can be used to get the next page of results.", + "launch_stage": "GA" + } + } + }, + "oauth2.ListPublishedAppIntegrationsRequest": { + "fields": { + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "launch_stage": "GA" + } + } + }, + "oauth2.ListServicePrincipalFederationPoliciesRequest": { + "fields": { + "page_size": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "oauth2.ListServicePrincipalSecretsRequest": { + "fields": { + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "description": "An opaque page token which was the `next_page_token` in the response of the previous request to list the secrets for this service principal. Provide this token to retrieve the next page of secret entries.\nWhen providing a `page_token`, all other parameters provided to the request must match the previous request.\nTo list all of the secrets for a service principal, it is necessary to continue requesting pages of entries until the response contains no `next_page_token`. Note that the number of entries returned must not be used to determine when the listing is complete.", + "launch_stage": "GA" + } + } + }, "oauth2.ListServicePrincipalSecretsResponse": { "fields": { "next_page_token": { @@ -33151,7 +36427,6 @@ "fields": { "absolute_session_lifetime_in_minutes": { "description": "Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature is enabled.\nThis is the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is issued\nduring refresh token rotation, it will inherit the same absolute TTL as the old refresh token.\nIn other words, this represents the maximum amount of time a user can stay logged in without re-authenticating.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "access_token_ttl_in_minutes": { @@ -33160,7 +36435,6 @@ }, "enable_single_use_refresh_tokens": { "description": "Whether to enable single-use refresh tokens (refresh token rotation).\nIf this feature is enabled, upon successfully getting a new access token using a refresh token, Databricks will\nissue a new refresh token along with the access token in the response and invalidate the old refresh token.\nThe client should use the new refresh token to get access tokens in future requests.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "refresh_token_ttl_in_minutes": { @@ -33169,6 +36443,21 @@ } } }, + "oauth2.UpdateAccountFederationPolicyRequest": { + "fields": { + "policy": { + "ref": "oauth2.FederationPolicy", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "oauth2.UpdateCustomAppIntegration": { "fields": { "redirect_urls": { @@ -33201,6 +36490,22 @@ } }, "oauth2.UpdatePublishedAppIntegrationOutput": {}, + "oauth2.UpdateServicePrincipalFederationPolicyRequest": { + "fields": { + "policy": { + "ref": "oauth2.FederationPolicy", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask specifies which fields of the policy to update. To specify multiple fields\nin the field mask, use comma as the separator (no space). The special value '*' indicates\nthat all fields should be updated (full replacement). If unspecified, all fields that are\nset in the policy provided in the update request will overwrite the corresponding fields\nin the existing policy. Example value: 'description,oidc_policy.audiences'.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "pipelines.ApplyEnvironmentRequest": {}, "pipelines.ApplyEnvironmentRequestResponse": {}, "pipelines.AutoFullRefreshPolicy": { "description": "Policy for auto full refresh.", @@ -33232,7 +36537,6 @@ }, "budget_policy_id": { "description": "Budget policy of this pipeline.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "catalog": { @@ -33276,7 +36580,6 @@ "environment": { "description": "Environment specification for this pipeline used to install dependencies.", "ref": "pipelines.PipelinesEnvironment", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "event_log": { @@ -33296,7 +36599,6 @@ "gateway_definition": { "description": "The definition of a gateway pipeline to support change data capture.", "ref": "pipelines.IngestionGatewayPipelineDefinition", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "id": { @@ -33306,7 +36608,6 @@ "ingestion_definition": { "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "ref": "pipelines.IngestionPipelineDefinition", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "libraries": { @@ -33328,12 +36629,10 @@ "restart_window": { "description": "Restart window of this pipeline.", "ref": "pipelines.RestartWindow", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "schema": { @@ -33365,7 +36664,6 @@ }, "usage_policy_id": { "description": "Usage policy of this pipeline.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -33391,7 +36689,6 @@ "fields": { "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.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -33405,52 +36702,42 @@ }, "gdrive_options": { "ref": "pipelines.GoogleDriveOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "google_ads_options": { "ref": "pipelines.GoogleAdsOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "jira_options": { "ref": "pipelines.JiraConnectorOptions", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "kafka_options": { "ref": "pipelines.KafkaOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "meta_ads_options": { "ref": "pipelines.MetaMarketingOptions", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "outlook_options": { "ref": "pipelines.OutlookOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "sharepoint_options": { "ref": "pipelines.SharepointOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "smartsheet_options": { "ref": "pipelines.SmartsheetOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "tiktok_ads_options": { "ref": "pipelines.TikTokAdsOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "zendesk_support_options": { "ref": "pipelines.ZendeskSupportOptions", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -33474,7 +36761,6 @@ }, "budget_policy_id": { "description": "Budget policy of this pipeline.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "catalog": { @@ -33516,7 +36802,6 @@ "environment": { "description": "Environment specification for this pipeline used to install dependencies.", "ref": "pipelines.PipelinesEnvironment", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "event_log": { @@ -33532,7 +36817,6 @@ "gateway_definition": { "description": "The definition of a gateway pipeline to support change data capture.", "ref": "pipelines.IngestionGatewayPipelineDefinition", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "id": { @@ -33542,7 +36826,6 @@ "ingestion_definition": { "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "ref": "pipelines.IngestionPipelineDefinition", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "libraries": { @@ -33559,7 +36842,6 @@ }, "parameters": { "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "photon": { @@ -33569,12 +36851,10 @@ "restart_window": { "description": "Restart window of this pipeline.", "ref": "pipelines.RestartWindow", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "run_as": { @@ -33610,7 +36890,6 @@ }, "usage_policy_id": { "description": "Usage policy of this pipeline.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -33688,6 +36967,18 @@ "WEDNESDAY": "PUBLIC_PREVIEW" } }, + "pipelines.DeletePipelineRequest": { + "fields": { + "cascade": { + "description": "If false, pipeline deletion will not cascade to its datasets (MVs, STs, Views).\nBy default, this parameter will be true and all tables will be deleted with the pipeline.", + "launch_stage": "PUBLIC_BETA" + }, + "force": { + "description": "If true, deletion will proceed even if resource cleanup fails.\nBy default, deletion will fail if resources cleanup is required but fails.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "pipelines.DeletePipelineResponse": {}, "pipelines.DeploymentKind": { "description": "The deployment method that manages the pipeline:\n- BUNDLE: The pipeline is managed by a Databricks Asset Bundle.", @@ -33706,7 +36997,6 @@ }, "budget_policy_id": { "description": "Budget policy of this pipeline.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "catalog": { @@ -33745,7 +37035,6 @@ "environment": { "description": "Environment specification for this pipeline used to install dependencies.", "ref": "pipelines.PipelinesEnvironment", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "event_log": { @@ -33765,7 +37054,6 @@ "gateway_definition": { "description": "The definition of a gateway pipeline to support change data capture.", "ref": "pipelines.IngestionGatewayPipelineDefinition", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "id": { @@ -33775,7 +37063,6 @@ "ingestion_definition": { "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "ref": "pipelines.IngestionPipelineDefinition", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "libraries": { @@ -33792,7 +37079,6 @@ }, "parameters": { "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "photon": { @@ -33802,12 +37088,10 @@ "restart_window": { "description": "Restart window of this pipeline.", "ref": "pipelines.RestartWindow", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "run_as": { @@ -33843,7 +37127,6 @@ }, "usage_policy_id": { "description": "Usage policy of this pipeline.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -34012,6 +37295,7 @@ } } }, + "pipelines.GetPipelinePermissionLevelsRequest": {}, "pipelines.GetPipelinePermissionLevelsResponse": { "fields": { "permission_levels": { @@ -34020,6 +37304,8 @@ } } }, + "pipelines.GetPipelinePermissionsRequest": {}, + "pipelines.GetPipelineRequest": {}, "pipelines.GetPipelineResponse": { "fields": { "cause": { @@ -34036,7 +37322,6 @@ }, "effective_budget_policy_id": { "description": "Serverless budget policy ID of this pipeline.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "effective_publishing_mode": { @@ -34063,7 +37348,6 @@ }, "parameters": { "description": "Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "pipeline_id": { @@ -34102,6 +37386,7 @@ "UNHEALTHY": "GA" } }, + "pipelines.GetUpdateRequest": {}, "pipelines.GetUpdateResponse": { "fields": { "update": { @@ -34197,7 +37482,6 @@ "connection_parameters": { "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", "ref": "pipelines.ConnectionParameters", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "gateway_storage_catalog": { @@ -34223,24 +37507,20 @@ "connector_type": { "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", "ref": "pipelines.ConnectorType", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "data_staging_options": { "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "ref": "pipelines.DataStagingOptions", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "full_refresh_window": { "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "ref": "pipelines.OperationTimeWindow", - "preview": "PUBLIC", "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "ingestion_gateway_id": { @@ -34249,7 +37529,6 @@ }, "netsuite_jar_path": { "description": "Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "objects": { @@ -34258,7 +37537,6 @@ }, "source_configurations": { "description": "Top-level source configurations", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "source_type": { @@ -34281,17 +37559,14 @@ "fields": { "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.", - "preview": "PUBLIC", "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.", - "preview": "PUBLIC", "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" } } @@ -34410,7 +37685,6 @@ "fields": { "client_config": { "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "key_transformer": { @@ -34420,7 +37694,6 @@ }, "max_offsets_per_trigger": { "description": "Internal option to control the maximum number of offsets to process per trigger.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "starting_offset": { @@ -34442,6 +37715,26 @@ } } }, + "pipelines.ListPipelineEventsRequest": { + "fields": { + "filter": { + "description": "Criteria to select a subset of results, expressed using a SQL-like syntax.\nThe supported filters are:\n1. level='INFO' (or WARN or ERROR)\n2. level in ('INFO', 'WARN')\n3. id='[event-id]'\n4. timestamp \u003e 'TIMESTAMP' (or \u003e=,\u003c,\u003c=,=)\n\nComposite expressions are supported, for example: level in ('ERROR', 'WARN')\nAND timestamp\u003e '2021-07-22T06:37:33.083Z'", + "launch_stage": "GA" + }, + "max_results": { + "description": "Max number of entries to return in a single page. The system may return\nfewer than max_results events in a response, even if there are more events\navailable.", + "launch_stage": "GA" + }, + "order_by": { + "description": "A string indicating a sort order by timestamp for the results, for example, [\"timestamp asc\"].\nThe sort order can be ascending or descending. By default, events are returned\nin descending order by timestamp.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Page token returned by previous call. This field is mutually\nexclusive with all fields in this request except max_results. An error is\nreturned if any fields other than max_results are set when this field is set.", + "launch_stage": "GA" + } + } + }, "pipelines.ListPipelineEventsResponse": { "fields": { "events": { @@ -34458,6 +37751,26 @@ } } }, + "pipelines.ListPipelinesRequest": { + "fields": { + "filter": { + "description": "Select a subset of results based on the specified criteria.\nThe supported filters are:\n\n* `notebook='\u003cpath\u003e'` to select pipelines that reference the provided notebook path.\n* `name LIKE '[pattern]'` to select pipelines with a name that matches pattern.\nWildcards are supported, for example: `name LIKE '%shopping%'`\n\nComposite filters are not supported. This field is optional.", + "launch_stage": "GA" + }, + "max_results": { + "description": "The maximum number of entries to return in a single page. The system may\nreturn fewer than max_results events in a response, even if there are\nmore events available. This field is optional. The default value is 25.\nThe maximum value is 100. An error is returned if the value of max_results\nis greater than 100.", + "launch_stage": "GA" + }, + "order_by": { + "description": "A list of strings specifying the order of results.\nSupported order_by fields are id and name. The default is id asc.\nThis field is optional.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Page token returned by previous call", + "launch_stage": "GA" + } + } + }, "pipelines.ListPipelinesResponse": { "fields": { "next_page_token": { @@ -34470,6 +37783,22 @@ } } }, + "pipelines.ListUpdatesRequest": { + "fields": { + "max_results": { + "description": "Max number of entries to return in a single page.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Page token returned by previous call", + "launch_stage": "GA" + }, + "until_update_id": { + "description": "If present, returns updates until and including this update_id.", + "launch_stage": "GA" + } + } + }, "pipelines.ListUpdatesResponse": { "fields": { "next_page_token": { @@ -34605,27 +37934,22 @@ }, "ingestion_source_catalog_name": { "description": "The name of the source catalog name (if known) from whose data ingestion is described by this event.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "ingestion_source_connection_name": { "description": "The name of the source UC connection (if known) from whose data ingestion is described by this event.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "ingestion_source_schema_name": { "description": "The name of the source schema name (if known) from whose data ingestion is described by this event.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "ingestion_source_table_name": { "description": "The name of the source table name (if known) from whose data ingestion is described by this event.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "ingestion_source_table_version": { "description": "An optional implementation-defined source table version of a dataset being (re)ingested.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "maintenance_id": { @@ -34915,7 +38239,6 @@ "fields": { "deployment_id": { "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "kind": { @@ -34929,7 +38252,6 @@ }, "version_id": { "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -34994,18 +38316,15 @@ "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": "pipelines.PathPattern", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "jar": { "description": "URI of the jar to be installed. Currently only DBFS is supported.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "maven": { "description": "Specification of a maven library to be installed.", "ref": "compute.MavenLibrary", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "notebook": { @@ -35078,7 +38397,6 @@ "fields": { "budget_policy_id": { "description": "Budget policy of this pipeline.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "catalog": { @@ -35117,7 +38435,6 @@ "environment": { "description": "Environment specification for this pipeline used to install dependencies.", "ref": "pipelines.PipelinesEnvironment", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "event_log": { @@ -35133,7 +38450,6 @@ "gateway_definition": { "description": "The definition of a gateway pipeline to support change data capture.", "ref": "pipelines.IngestionGatewayPipelineDefinition", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "id": { @@ -35143,7 +38459,6 @@ "ingestion_definition": { "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "ref": "pipelines.IngestionPipelineDefinition", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "libraries": { @@ -35165,12 +38480,10 @@ "restart_window": { "description": "Restart window of this pipeline.", "ref": "pipelines.RestartWindow", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "schema": { @@ -35202,7 +38515,6 @@ }, "usage_policy_id": { "description": "Usage policy of this pipeline.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -35302,7 +38614,6 @@ }, "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\"`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -35313,7 +38624,6 @@ "slot_config": { "description": "Optional. The Postgres slot configuration to use for logical replication", "ref": "pipelines.PostgresSlotConfig", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -35323,12 +38633,10 @@ "fields": { "publication_name": { "description": "The name of the publication to use for the Postgres source", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "slot_name": { "description": "The name of the logical replication slot to use for the Postgres source", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -35551,12 +38859,10 @@ "postgres": { "description": "Postgres-specific catalog-level configuration parameters", "ref": "pipelines.PostgresCatalogConfig", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "source_catalog": { "description": "Source catalog name", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -35566,12 +38872,10 @@ "catalog": { "description": "Catalog-level source configuration parameters", "ref": "pipelines.SourceCatalogConfig", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "google_ads_config": { "ref": "pipelines.GoogleAdsConfig", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -35612,7 +38916,6 @@ }, "parameters": { "description": "Key/value map of parameters to pass to the pipeline execution", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "refresh_selection": { @@ -35621,7 +38924,6 @@ }, "replace_where_overrides": { "description": "A list of predicate overrides for replace_where flows in this update.\nOnly replace_where flows may be specified. Flows not listed use their original predicate.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "reset_checkpoint_selection": { @@ -35631,7 +38933,6 @@ "rewind_spec": { "description": "The information about the requested rewind operation.\nIf specified this is a rewind mode update.", "ref": "pipelines.RewindSpec", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "validate_only": { @@ -35669,6 +38970,7 @@ } }, "pipelines.StopPipelineResponse": {}, + "pipelines.StopRequest": {}, "pipelines.TableSpec": { "fields": { "connector_options": { @@ -35712,17 +39014,14 @@ "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": "pipelines.AutoFullRefreshPolicy", - "preview": "PUBLIC", "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`.", - "preview": "PUBLIC", "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`.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "primary_keys": { @@ -35731,22 +39030,18 @@ }, "query_based_connector_config": { "ref": "pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", - "preview": "PUBLIC", "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.", - "preview": "PUBLIC", "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", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "scd_type": { "ref": "pipelines.TableSpecificConfigScdType", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "sequence_by": { @@ -35756,7 +39051,6 @@ "workday_report_parameters": { "description": "(Optional) Additional custom parameters for Workday Report", "ref": "pipelines.IngestionPipelineDefinitionWorkdayReportParameters", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -35915,7 +39209,6 @@ }, "parameters": { "description": "Key/value map of parameters used to initiate the update", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "pipeline_id": { @@ -36068,8 +39361,8 @@ "ref": "postgres.BranchSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -36124,24 +39417,24 @@ "description": "The name of the source branch from which this branch was created (data lineage for point-in-time recovery).\nIf not specified, defaults to the project's default branch.\nFormat: projects/{project_id}/branches/{branch_id}", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] }, "source_branch_lsn": { "description": "The Log Sequence Number (LSN) on the source branch from which this branch was created.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] }, "source_branch_time": { "description": "The point in time on the source branch from which this branch was created.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] }, "ttl": { @@ -36179,7 +39472,6 @@ }, "delete_time": { "description": "A timestamp indicating when the branch was deleted.\nEmpty if the branch is not deleted.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -36216,7 +39508,6 @@ }, "purge_time": { "description": "A timestamp indicating when the branch is scheduled to be purged.\nEmpty if the branch is not deleted, otherwise set to a timestamp in the future.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -36289,8 +39580,8 @@ "ref": "postgres.CatalogCatalogSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -36339,7 +39630,6 @@ "description": "The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.\nThis database must already exist, unless create_database_if_missing is set to true on creation.\n\nA database can only be registered with one UC catalog at a time.\nTo re-register a database with a different catalog, the existing catalog must be deleted first.\n\nA child branch inherits the fact of parent's registration. This means the same-named database\nin a child branch cannot be registered with a second catalog\nwhile the parent's registration exists. To allow registering the database of a child branch,\ndrop and recreate the database on the child branch.\nThis removes the fact of parent's registration from this branch only.\n\nDoing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered\nin the Catalog drops the fact of registration of the database. So the user should avoid doing so.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] } @@ -36372,6 +39662,117 @@ } }, "postgres.CatalogOperationMetadata": {}, + "postgres.CreateBranchRequest": { + "fields": { + "branch": { + "description": "The Branch to create.", + "ref": "postgres.Branch", + "launch_stage": "PUBLIC_BETA" + }, + "branch_id": { + "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `development` becomes `projects/my-app/branches/development`.", + "launch_stage": "PUBLIC_BETA" + }, + "replace_existing": { + "description": "If true, update the branch if it already exists instead of returning an error.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + } + } + }, + "postgres.CreateCatalogRequest": { + "fields": { + "catalog": { + "ref": "postgres.Catalog", + "launch_stage": "PUBLIC_BETA" + }, + "catalog_id": { + "description": "The ID in the Unity Catalog.\nIt becomes the full resource name, for example \"my_catalog\" becomes \"catalogs/my_catalog\".", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.CreateDatabaseRequest": { + "fields": { + "database": { + "description": "The desired specification of a Database.", + "ref": "postgres.Database", + "launch_stage": "PUBLIC_BETA" + }, + "database_id": { + "description": "The ID to use for the Database, which will become the final component of\nthe database's resource name.\nThis ID becomes the database name in postgres.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.CreateEndpointRequest": { + "fields": { + "endpoint": { + "description": "The Endpoint to create.", + "ref": "postgres.Endpoint", + "launch_stage": "PUBLIC_BETA" + }, + "endpoint_id": { + "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", + "launch_stage": "PUBLIC_BETA" + }, + "replace_existing": { + "description": "If true, update the endpoint if it already exists instead of returning an error.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "INPUT_ONLY", + "OPTIONAL" + ] + } + } + }, + "postgres.CreateProjectRequest": { + "fields": { + "project": { + "description": "The Project to create.", + "ref": "postgres.Project", + "launch_stage": "PUBLIC_BETA" + }, + "project_id": { + "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.CreateRoleRequest": { + "fields": { + "role": { + "description": "The desired specification of a Role.", + "ref": "postgres.Role", + "launch_stage": "PUBLIC_BETA" + }, + "role_id": { + "description": "The ID to use for the Role, which will become the final component of\nthe role's resource name.\nThis ID becomes the role in Postgres.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf role_id is not specified in the request, it is generated automatically.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.CreateSyncedTableRequest": { + "fields": { + "synced_table": { + "ref": "postgres.SyncedTable", + "launch_stage": "PUBLIC_BETA" + }, + "synced_table_id": { + "description": "The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.\nID is required and is the synced table name, containing (catalog, schema, table) tuple.\nElements of the tuple are the UC entity names.\n\nExample: \"{catalog}.{schema}.{table}\"\n\nsynced_table_id represents both of the following:\n\n1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.\n2. Postgres table named \"{table}\" in schema \"{schema}\" in the connected Postgres database", + "launch_stage": "PUBLIC_BETA" + } + } + }, "postgres.Database": { "description": "Database represents a Postgres database within a Branch.", "fields": { @@ -36398,8 +39799,8 @@ "ref": "postgres.DatabaseDatabaseSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -36493,6 +39894,43 @@ } } }, + "postgres.DeleteBranchRequest": { + "fields": { + "purge": { + "description": "If true, permanently delete the branch; if false, soft delete.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.DeleteCatalogRequest": {}, + "postgres.DeleteDatabaseRequest": {}, + "postgres.DeleteEndpointRequest": {}, + "postgres.DeleteProjectRequest": { + "fields": { + "purge": { + "description": "If true, permanently deletes the project (hard delete).\nIf false or unset, performs a soft delete.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.DeleteRoleRequest": { + "fields": { + "reassign_owned_to": { + "description": "Reassign objects. If this is set, all objects owned by the role are\nreassigned to the role specified in this parameter.\n\nNOTE: setting this requires spinning up a compute to succeed, since it involves running\nSQL queries.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.DeleteSyncedTableRequest": {}, "postgres.DeltaTableSyncInfo": { "fields": { "delta_commit_time": { @@ -36536,8 +39974,8 @@ "ref": "postgres.EndpointSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -36575,17 +40013,11 @@ }, "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.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "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.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -36600,17 +40032,11 @@ }, "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.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "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.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -36626,7 +40052,6 @@ }, "read_only_host": { "description": "An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,\nthis attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined\nif the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -36675,7 +40100,6 @@ "ref": "postgres.EndpointType", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -36997,13 +40421,18 @@ }, "endpoint": { "description": "The endpoint resource name for which this credential will be generated.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, + "postgres.GetBranchRequest": {}, + "postgres.GetCatalogRequest": {}, + "postgres.GetDatabaseRequest": {}, + "postgres.GetEndpointRequest": {}, + "postgres.GetOperationRequest": {}, + "postgres.GetProjectRequest": {}, + "postgres.GetRoleRequest": {}, + "postgres.GetSyncedTableRequest": {}, "postgres.InitialEndpointSpec": { "description": "Configuration for the initial Read/Write endpoint created during project creation.", "fields": { @@ -37017,6 +40446,31 @@ } } }, + "postgres.ListBranchesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned. Cannot be negative.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous response. If not provided, returns the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "show_deleted": { + "description": "Whether to include soft-deleted branches in the response.\nWhen true, deleted branches are included alongside active branches.\nPurged branches are never returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.ListBranchesResponse": { "fields": { "branches": { @@ -37029,6 +40483,24 @@ } } }, + "postgres.ListDatabasesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of Databases. Requests first page if absent.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.ListDatabasesResponse": { "fields": { "databases": { @@ -37041,6 +40513,24 @@ } } }, + "postgres.ListEndpointsRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned. Cannot be negative.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous response. If not provided, returns the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.ListEndpointsResponse": { "fields": { "endpoints": { @@ -37059,6 +40549,31 @@ } } }, + "postgres.ListProjectsRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned. Cannot be negative. The maximum value is 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous response. If not provided, returns the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "show_deleted": { + "description": "Whether to include soft-deleted projects in the response.\nWhen true, soft-deleted projects are included alongside active projects.\nHard-deleted and already-purged projects are never returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.ListProjectsResponse": { "fields": { "next_page_token": { @@ -37071,6 +40586,24 @@ } } }, + "postgres.ListRolesRequest": { + "fields": { + "page_size": { + "description": "Upper bound for items returned. Cannot be negative.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous response. If not provided, returns the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.ListRolesResponse": { "fields": { "next_page_token": { @@ -37155,8 +40688,8 @@ "ref": "postgres.InitialEndpointSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "name": { @@ -37175,8 +40708,8 @@ "ref": "postgres.ProjectSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -37311,8 +40844,8 @@ "description": "The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "IMMUTABLE" + "IMMUTABLE", + "OPTIONAL" ] } } @@ -37489,8 +41022,8 @@ "ref": "postgres.RoleRoleSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -37675,8 +41208,8 @@ "ref": "postgres.SyncedTableSyncedTableSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "OPTIONAL", - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] }, "status": { @@ -37930,7 +41463,6 @@ }, "project": { "description": "The full resource name of the project associated with the table.\n\nFormat: \"projects/{project_id}\".", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -37958,6 +41490,71 @@ "postgres.UndeleteProjectRequest": { "description": "Request to restore a soft-deleted project within its retention period." }, + "postgres.UpdateBranchRequest": { + "fields": { + "branch": { + "description": "The Branch to update.\n\nThe branch's `name` field is used to identify the branch to update.\nFormat: projects/{project_id}/branches/{branch_id}", + "ref": "postgres.Branch", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.UpdateDatabaseRequest": { + "fields": { + "database": { + "description": "The Database to update.\n\nThe database's `name` field is used to identify the database to update.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "ref": "postgres.Database", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.UpdateEndpointRequest": { + "fields": { + "endpoint": { + "description": "The Endpoint to update.\n\nThe endpoint's `name` field is used to identify the endpoint to update.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}", + "ref": "postgres.Endpoint", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.UpdateProjectRequest": { + "fields": { + "project": { + "description": "The Project to update.\n\nThe project's `name` field is used to identify the project to update.\nFormat: projects/{project_id}", + "ref": "postgres.Project", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The list of fields to update. If unspecified, all fields will be updated when possible.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "postgres.UpdateRoleRequest": { + "fields": { + "role": { + "description": "The Postgres Role to update.\n\nThe role's `name` field is used to identify the role to update.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}", + "ref": "postgres.Role", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The list of fields to update in Postgres Role.\nIf unspecified, all fields will be updated when possible.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "provisioning.AwsCredentials": { "fields": { "sts_role": { @@ -38120,7 +41717,6 @@ }, "azure_key_info": { "ref": "provisioning.CreateAzureKeyInfo", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "gcp_key_info": { @@ -38146,7 +41742,6 @@ }, "manual": { "description": "When true, Databricks will not use OAuth to grant the service account\naccess to the KMS key. The customer is responsible for granting access\nmanually.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -38170,7 +41765,7 @@ "launch_stage": "GA" }, "vpc_endpoints": { - "ref": "provisioning.NetworkVPCEndpoints", + "ref": "provisioning.NetworkVpcEndpoints", "launch_stage": "GA" }, "vpc_id": { @@ -38403,6 +41998,13 @@ } } }, + "provisioning.DeleteCredentialRequest": {}, + "provisioning.DeleteEncryptionKeyRequest": {}, + "provisioning.DeleteNetworkRequest": {}, + "provisioning.DeletePrivateAccesRequest": {}, + "provisioning.DeleteStorageRequest": {}, + "provisioning.DeleteVpcEndpointRequest": {}, + "provisioning.DeleteWorkspaceRequest": {}, "provisioning.EndpointUseCase": { "enum": [ "WORKSPACE_ACCESS", @@ -38459,7 +42061,6 @@ }, "manual": { "description": "When true, Databricks will not use OAuth to grant the service account\naccess to the KMS key. The customer is responsible for granting access\nmanually.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -38534,6 +42135,13 @@ } } }, + "provisioning.GetCredentialRequest": {}, + "provisioning.GetEncryptionKeyRequest": {}, + "provisioning.GetNetworkRequest": {}, + "provisioning.GetPrivateAccesRequest": {}, + "provisioning.GetStorageRequest": {}, + "provisioning.GetVpcEndpointRequest": {}, + "provisioning.GetWorkspaceRequest": {}, "provisioning.GkeConfig": { "description": "The configurations of the GKE cluster used by the GCP workspace.", "fields": { @@ -38577,6 +42185,13 @@ "STORAGE": "GA" } }, + "provisioning.ListCredentialsRequest": {}, + "provisioning.ListEncryptionKeysRequest": {}, + "provisioning.ListNetworksRequest": {}, + "provisioning.ListPrivateAccessRequest": {}, + "provisioning.ListStorageRequest": {}, + "provisioning.ListVpcEndpointsRequest": {}, + "provisioning.ListWorkspacesRequest": {}, "provisioning.Network": { "fields": { "account_id": { @@ -38612,7 +42227,7 @@ "launch_stage": "GA" }, "vpc_endpoints": { - "ref": "provisioning.NetworkVPCEndpoints", + "ref": "provisioning.NetworkVpcEndpoints", "launch_stage": "GA" }, "vpc_id": { @@ -38645,7 +42260,7 @@ } } }, - "provisioning.NetworkVPCEndpoints": { + "provisioning.NetworkVpcEndpoints": { "fields": { "dataplane_relay": { "description": "The VPC endpoint ID used by this network to access the Databricks secure cluster connectivity relay.", @@ -38737,6 +42352,15 @@ } } }, + "provisioning.ReplacePrivateAccessSettingsRequest": { + "fields": { + "customer_facing_private_access_settings": { + "description": "Properties of the new private access settings object.", + "ref": "provisioning.PrivateAccessSettings", + "launch_stage": "GA" + } + } + }, "provisioning.RootBucketInfo": { "fields": { "bucket_name": { @@ -38782,7 +42406,19 @@ } } }, - "provisioning.VPCEndpoint": { + "provisioning.UpdateWorkspaceRequest": { + "fields": { + "customer_facing_workspace": { + "ref": "provisioning.Workspace", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, + "provisioning.VpcEndpoint": { "description": "*", "fields": { "account_id": { @@ -38909,7 +42545,6 @@ "expected_workspace_status": { "description": "A client owned field used to indicate the workspace status that the client expects to be in.\nFor now this is only used to unblock Temporal workflow for GCP least privileged workspace.", "ref": "provisioning.WorkspaceStatus", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "gcp_managed_network_config": { @@ -39039,7 +42674,6 @@ "fields": { "excluded_table_full_names": { "description": "List of fully qualified table names to exclude from anomaly detection.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -39085,6 +42719,32 @@ "ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR": "PUBLIC_BETA" } }, + "qualitymonitorv2.CreateQualityMonitorRequest": { + "fields": { + "quality_monitor": { + "ref": "qualitymonitorv2.QualityMonitor", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "qualitymonitorv2.DeleteQualityMonitorRequest": {}, + "qualitymonitorv2.GetQualityMonitorRequest": {}, + "qualitymonitorv2.ListQualityMonitorRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "qualitymonitorv2.ListQualityMonitorResponse": { "fields": { "next_page_token": { @@ -39118,17 +42778,11 @@ }, "object_id": { "description": "The uuid of the request object. For example, schema id.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "object_type": { "description": "The type of the monitored object. Can be one of the following: schema.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "validity_check_configurations": { "description": "Validity check configurations for anomaly detection.", @@ -39164,6 +42818,14 @@ } } }, + "qualitymonitorv2.UpdateQualityMonitorRequest": { + "fields": { + "quality_monitor": { + "ref": "qualitymonitorv2.QualityMonitor", + "launch_stage": "PUBLIC_BETA" + } + } + }, "qualitymonitorv2.ValidityCheckConfiguration": { "fields": { "name": { @@ -39184,7 +42846,7 @@ } } }, - "serving.AI21LabsConfig": { + "serving.Ai21LabsConfig": { "fields": { "ai21labs_api_key": { "description": "The Databricks secret key reference for an AI21 Labs API key. If you\nprefer to paste your API key directly, see `ai21labs_api_key_plaintext`.\nYou must provide an API key using one of the following fields:\n`ai21labs_api_key` or `ai21labs_api_key_plaintext`.", @@ -39206,7 +42868,6 @@ "guardrails": { "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "ref": "serving.AiGatewayGuardrails", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "inference_table_config": { @@ -39500,6 +43161,7 @@ } } }, + "serving.BuildLogsRequest": {}, "serving.BuildLogsResponse": { "fields": { "logs": { @@ -39512,13 +43174,11 @@ "fields": { "content": { "description": "The content of the message.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "role": { "description": "The role of the message. One of [system, user, assistant].", "ref": "serving.ChatMessageRole", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -39690,6 +43350,7 @@ } } }, + "serving.DeleteServingEndpointRequest": {}, "serving.EmailNotifications": { "fields": { "on_update_failure": { @@ -39706,18 +43367,15 @@ "fields": { "embedding": { "description": "The embedding vector", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "index": { "description": "The index of the embedding in the response.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "object": { "description": "This will always be 'embedding'.", "ref": "serving.EmbeddingsV1ResponseEmbeddingElementObject", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -39881,6 +43539,14 @@ } } }, + "serving.ExportMetricsRequest": {}, + "serving.ExportMetricsResponse": { + "fields": { + "contents": { + "launch_stage": "GA" + } + } + }, "serving.ExternalFunctionRequest": { "description": "Simple Proto message for testing", "fields": { @@ -39911,7 +43577,6 @@ }, "sub_domain": { "description": "Optional subdomain to prepend to the connection URL's host. If provided, this will be\nadded as a prefix to the connection URL's host. For example, if the connection URL is\n`https://api.example.com/v1` and `sub_domain` is `\"custom\"`, the resulting URL will be\n`https://custom.api.example.com/v1`.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -39936,7 +43601,7 @@ "fields": { "ai21labs_config": { "description": "AI21Labs Config. Only required if the provider is 'ai21labs'.", - "ref": "serving.AI21LabsConfig", + "ref": "serving.Ai21LabsConfig", "launch_stage": "GA" }, "amazon_bedrock_config": { @@ -39966,7 +43631,7 @@ }, "google_cloud_vertex_ai_config": { "description": "Google Cloud Vertex AI Config. Only required if the provider is 'google-cloud-vertex-ai'.", - "ref": "serving.GoogleCloudVertexAIConfig", + "ref": "serving.GoogleCloudVertexAiConfig", "launch_stage": "GA" }, "name": { @@ -39975,12 +43640,12 @@ }, "openai_config": { "description": "OpenAI Config. Only required if the provider is 'openai'.", - "ref": "serving.OpenAIConfig", + "ref": "serving.OpenAiConfig", "launch_stage": "GA" }, "palm_config": { "description": "PaLM Config. Only required if the provider is 'palm'.", - "ref": "serving.PaLMConfig", + "ref": "serving.PaLmConfig", "launch_stage": "GA" }, "provider": { @@ -40022,17 +43687,14 @@ "fields": { "completion_tokens": { "description": "The number of tokens in the chat/completions response.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "prompt_tokens": { "description": "The number of tokens in the prompt.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "total_tokens": { "description": "The total number of tokens in the prompt and response.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -40062,6 +43724,15 @@ } } }, + "serving.GetOpenApiRequest": {}, + "serving.GetOpenApiResponse": { + "fields": { + "contents": { + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "serving.GetServingEndpointPermissionLevelsRequest": {}, "serving.GetServingEndpointPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -40070,7 +43741,9 @@ } } }, - "serving.GoogleCloudVertexAIConfig": { + "serving.GetServingEndpointPermissionsRequest": {}, + "serving.GetServingEndpointRequest": {}, + "serving.GoogleCloudVertexAiConfig": { "fields": { "private_key": { "description": "The Databricks secret key reference for a private key for the service\naccount which has access to the Google Cloud Vertex AI Service. See [Best\npractices for managing service account keys]. If you prefer to paste your\nAPI key directly, see `private_key_plaintext`. You must provide an API\nkey using one of the following fields: `private_key` or\n`private_key_plaintext`\n\n[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys", @@ -40090,6 +43763,13 @@ } } }, + "serving.HttpRequestResponse": { + "fields": { + "contents": { + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "serving.ListEndpointsResponse": { "fields": { "endpoints": { @@ -40098,6 +43778,8 @@ } } }, + "serving.ListServingEndpointsRequest": {}, + "serving.LogsRequest": {}, "serving.ModelDataPlaneInfo": { "description": "A representation of all DataPlaneInfo for operations that can be done on a model through Data Plane APIs.", "fields": { @@ -40108,7 +43790,7 @@ } } }, - "serving.OpenAIConfig": { + "serving.OpenAiConfig": { "description": "Configs needed to create an OpenAI model route.", "fields": { "microsoft_entra_client_id": { @@ -40157,7 +43839,7 @@ } } }, - "serving.PaLMConfig": { + "serving.PaLmConfig": { "fields": { "palm_api_key": { "description": "The Databricks secret key reference for a PaLM API key. If you prefer to\npaste your API key directly, see `palm_api_key_plaintext`. You must\nprovide an API key using one of the following fields: `palm_api_key` or\n`palm_api_key_plaintext`.", @@ -40239,7 +43921,6 @@ "guardrails": { "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "ref": "serving.AiGatewayGuardrails", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "inference_table_config": { @@ -40268,7 +43949,6 @@ "guardrails": { "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "ref": "serving.AiGatewayGuardrails", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "inference_table_config": { @@ -40291,7 +43971,6 @@ "fields": { "rate_limits": { "description": "The list of endpoint rate limits.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -40300,7 +43979,6 @@ "fields": { "rate_limits": { "description": "The list of endpoint rate limits.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -40322,12 +44000,10 @@ }, "extra_params": { "description": "The extra parameters field used ONLY for __completions, chat,__ and __embeddings external \u0026 foundation\nmodel__ serving endpoints. This is a map of strings and should only be used with other external/foundation\nmodel query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "input": { "description": "The input string (or array of strings) field used ONLY for __embeddings external \u0026 foundation model__\nserving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "inputs": { @@ -40340,37 +44016,30 @@ }, "max_tokens": { "description": "The max tokens field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is an integer and should only be used with other chat/completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "messages": { "description": "The messages field used ONLY for __chat external \u0026 foundation model__ serving endpoints.\nThis is an array of ChatMessage objects and should only be used with other chat query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "n": { "description": "The n (number of candidates) field used ONLY for __completions__ and __chat external \u0026 foundation model__\nserving endpoints. This is an integer between 1 and 5 with a default of 1 and should only be used with\nother chat/completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "prompt": { "description": "The prompt string (or array of strings) field used ONLY for __completions external \u0026 foundation model__\nserving endpoints and should only be used with other completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "stop": { "description": "The stop sequences field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a list of strings and should only be used with other chat/completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "stream": { "description": "The stream field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving endpoints.\nThis is a boolean defaulting to false and should only be used with other chat/completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "temperature": { "description": "The temperature field used ONLY for __completions__ and __chat external \u0026 foundation model__ serving\nendpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with other\nchat/completions query fields.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "usage_context": { @@ -40383,33 +44052,27 @@ "fields": { "choices": { "description": "The list of choices returned by the __chat or completions external/foundation model__ serving endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "created": { "description": "The timestamp in seconds when the query was created in Unix time returned by a __completions or chat external/foundation model__ serving endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "data": { "description": "The list of the embeddings returned by the __embeddings external/foundation model__ serving endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "id": { "description": "The ID of the query that may be returned by a __completions or chat external/foundation model__ serving endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "model": { "description": "The name of the __external/foundation model__ used for querying. This is the name of the model that was\nspecified in the endpoint config.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "object": { "description": "The type of object returned by the __external/foundation model__ serving endpoint, one of\n[text_completion, chat.completion, list (of embeddings)].", "ref": "serving.QueryEndpointResponseObject", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "outputs": { @@ -40423,7 +44086,6 @@ "usage": { "description": "The usage object that may be returned by the __external/foundation model__ serving endpoint. This\ncontains information about the number of tokens used in the prompt and response.", "ref": "serving.ExternalModelUsageElement", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -40496,7 +44158,6 @@ "fields": { "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "entity_name": { @@ -40517,7 +44178,6 @@ }, "instance_profile_arn": { "description": "ARN of the instance profile that the served entity uses to access AWS resources.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -40542,7 +44202,6 @@ }, "provisioned_model_units": { "description": "The number of model units provisioned.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { @@ -40564,7 +44223,6 @@ "fields": { "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "creation_timestamp": { @@ -40591,12 +44249,10 @@ }, "foundation_model": { "ref": "serving.FoundationModel", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "instance_profile_arn": { "description": "ARN of the instance profile that the served entity uses to access AWS resources.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -40621,7 +44277,6 @@ }, "provisioned_model_units": { "description": "The number of model units provisioned.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { @@ -40657,7 +44312,6 @@ }, "foundation_model": { "ref": "serving.FoundationModel", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { @@ -40669,7 +44323,6 @@ "fields": { "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "environment_vars": { @@ -40678,7 +44331,6 @@ }, "instance_profile_arn": { "description": "ARN of the instance profile that the served entity uses to access AWS resources.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -40709,7 +44361,6 @@ }, "provisioned_model_units": { "description": "The number of model units provisioned.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { @@ -40750,7 +44401,6 @@ "fields": { "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.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "creation_timestamp": { @@ -40765,7 +44415,6 @@ }, "instance_profile_arn": { "description": "ARN of the instance profile that the served entity uses to access AWS resources.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -40788,7 +44437,6 @@ }, "provisioned_model_units": { "description": "The number of model units provisioned.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { @@ -41170,28 +44818,23 @@ "fields": { "finishReason": { "description": "The finish reason returned by the endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "index": { "description": "The index of the choice in the __chat or completions__ response.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "logprobs": { "description": "The logprobs returned only by the __completions__ endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "message": { "description": "The message response from the __chat__ endpoint.", "ref": "serving.ChatMessage", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "text": { "description": "The text response from the __completions__ endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -41232,7 +44875,6 @@ "ingress": { "description": "The network policies applying for ingress traffic.", "ref": "settings.CustomerFacingIngressNetworkPolicy", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -41241,7 +44883,6 @@ "ingress_dry_run": { "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests.", "ref": "settings.CustomerFacingIngressNetworkPolicy", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -41591,7 +45232,7 @@ } } }, - "settings.CreateIPAccessList": { + "settings.CreateIpAccessList": { "description": "Details required to configure a block list or allow list.", "fields": { "ip_addresses": { @@ -41602,12 +45243,12 @@ "launch_stage": "GA" }, "list_type": { - "ref": "settings.list_type", + "ref": "settings.ListType", "launch_stage": "GA" } } }, - "settings.CreateIPAccessListResponse": { + "settings.CreateIpAccessListResponse": { "description": "An IP access list was successfully created.", "fields": { "ip_access_list": { @@ -41616,6 +45257,14 @@ } } }, + "settings.CreateNetworkConnectivityConfigRequest": { + "fields": { + "network_connectivity_config": { + "ref": "settings.CreateNetworkConnectivityConfiguration", + "launch_stage": "GA" + } + } + }, "settings.CreateNetworkConnectivityConfiguration": { "description": "Properties of the new network connectivity configuration.", "fields": { @@ -41629,6 +45278,15 @@ } } }, + "settings.CreateNetworkPolicyRequest": { + "fields": { + "network_policy": { + "description": "Network policy configuration details.", + "ref": "settings.AccountNetworkPolicy", + "launch_stage": "GA" + } + } + }, "settings.CreateNotificationDestinationRequest": { "fields": { "config": { @@ -41651,7 +45309,6 @@ }, "autoscope_enabled": { "description": "Whether to enable autoscoping for this token.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -41696,7 +45353,6 @@ }, "gcp_endpoint": { "ref": "settings.GcpEndpoint", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "group_id": { @@ -41709,16 +45365,22 @@ }, "resource_names": { "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } }, + "settings.CreatePrivateEndpointRuleRequest": { + "fields": { + "private_endpoint_rule": { + "ref": "settings.CreatePrivateEndpointRule", + "launch_stage": "GA" + } + } + }, "settings.CreateTokenRequest": { "fields": { "autoscope_enabled": { "description": "Whether to enable autoscoping for this token. When true, the token will\nautomatically collect inferred API path scopes as it is used.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -41782,7 +45444,6 @@ "fields": { "cross_workspace_access": { "ref": "settings.CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" @@ -41791,7 +45452,6 @@ "private_access": { "description": "The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access.", "ref": "settings.CustomerFacingIngressNetworkPolicyPrivateAccess", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" @@ -42038,14 +45698,12 @@ "settings.CustomerFacingIngressNetworkPolicyPrivateRequestOrigin": { "fields": { "all_private_access": { - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "all_registered_endpoints": { "launch_stage": "PRIVATE_PREVIEW" }, "azure_workspace_private_link": { - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "endpoints": { @@ -42127,18 +45785,15 @@ "fields": { "account_api": { "ref": "settings.CustomerFacingIngressNetworkPolicyAccountApiDestination", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "account_databricks_one": { "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW.", "ref": "settings.CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "account_ui": { "ref": "settings.CustomerFacingIngressNetworkPolicyAccountUiDestination", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "all_destinations": { @@ -42320,6 +45975,14 @@ } } }, + "settings.DeleteAccountIpAccessEnableRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "settings.DeleteAccountIpAccessEnableResponse": { "description": "The etag is returned.", "fields": { @@ -42329,6 +45992,15 @@ } } }, + "settings.DeleteAccountIpAccessListRequest": {}, + "settings.DeleteAibiDashboardEmbeddingAccessPolicySettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteAibiDashboardEmbeddingAccessPolicySettingResponse": { "description": "The etag is returned.", "fields": { @@ -42338,6 +46010,14 @@ } } }, + "settings.DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse": { "description": "The etag is returned.", "fields": { @@ -42347,6 +46027,14 @@ } } }, + "settings.DeleteDashboardEmailSubscriptionsRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteDashboardEmailSubscriptionsResponse": { "description": "The etag is returned.", "fields": { @@ -42356,6 +46044,14 @@ } } }, + "settings.DeleteDefaultNamespaceSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteDefaultNamespaceSettingResponse": { "description": "The etag is returned.", "fields": { @@ -42365,6 +46061,14 @@ } } }, + "settings.DeleteDefaultWarehouseIdRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "settings.DeleteDefaultWarehouseIdResponse": { "description": "The etag is returned.", "fields": { @@ -42374,6 +46078,14 @@ } } }, + "settings.DeleteDisableLegacyAccessRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, "settings.DeleteDisableLegacyAccessResponse": { "description": "The etag is returned.", "fields": { @@ -42383,6 +46095,14 @@ } } }, + "settings.DeleteDisableLegacyDbfsRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, "settings.DeleteDisableLegacyDbfsResponse": { "description": "The etag is returned.", "fields": { @@ -42392,6 +46112,14 @@ } } }, + "settings.DeleteDisableLegacyFeaturesRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, "settings.DeleteDisableLegacyFeaturesResponse": { "description": "The etag is returned.", "fields": { @@ -42401,6 +46129,15 @@ } } }, + "settings.DeleteIpAccessListRequest": {}, + "settings.DeleteLlmProxyPartnerPoweredWorkspaceRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "settings.DeleteLlmProxyPartnerPoweredWorkspaceResponse": { "description": "The etag is returned.", "fields": { @@ -42410,6 +46147,17 @@ } } }, + "settings.DeleteNetworkConnectivityConfigurationRequest": {}, + "settings.DeleteNetworkPolicyRequest": {}, + "settings.DeleteNotificationDestinationRequest": {}, + "settings.DeletePersonalComputeSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "settings.DeletePersonalComputeSettingResponse": { "description": "The etag is returned.", "fields": { @@ -42419,6 +46167,15 @@ } } }, + "settings.DeletePrivateEndpointRuleRequest": {}, + "settings.DeleteRestrictWorkspaceAdminsSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteRestrictWorkspaceAdminsSettingResponse": { "description": "The etag is returned.", "fields": { @@ -42428,6 +46185,14 @@ } } }, + "settings.DeleteSqlResultsDownloadRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settings.DeleteSqlResultsDownloadResponse": { "description": "The etag is returned.", "fields": { @@ -42437,6 +46202,7 @@ } } }, + "settings.DeleteTokenManagementRequest": {}, "settings.DestinationType": { "enum": [ "SLACK", @@ -42670,7 +46436,6 @@ }, "blocked_internet_destinations": { "description": "List of internet destinations that serverless workloads are blocked from accessing.\nThese destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN.\nCurrently supports DNS_NAME type only; IP_RANGE support is planned.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -43007,7 +46772,124 @@ } } }, - "settings.GetIPAccessListResponse": { + "settings.GetAccountIpAccessEnableRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetAccountIpAccessListRequest": {}, + "settings.GetAibiDashboardEmbeddingAccessPolicySettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetAibiDashboardEmbeddingApprovedDomainsSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetAutomaticClusterUpdateSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetComplianceSecurityProfileSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetCspEnablementAccountSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetDashboardEmailSubscriptionsRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetDefaultNamespaceSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetDefaultWarehouseIdRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetDisableLegacyAccessRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.GetDisableLegacyDbfsRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.GetDisableLegacyFeaturesRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "GA" + } + } + }, + "settings.GetEnableExportNotebookRequest": {}, + "settings.GetEnableNotebookTableClipboardRequest": {}, + "settings.GetEnableResultsDownloadingRequest": {}, + "settings.GetEnhancedSecurityMonitoringSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetEsmEnablementAccountSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetIpAccessListRequest": {}, + "settings.GetIpAccessListResponse": { "fields": { "ip_access_list": { "ref": "settings.IpAccessListInfo", @@ -43015,7 +46897,7 @@ } } }, - "settings.GetIPAccessListsResponse": { + "settings.GetIpAccessListsResponse": { "description": "IP access lists were successfully returned.", "fields": { "ip_access_lists": { @@ -43023,6 +46905,67 @@ } } }, + "settings.GetLlmProxyPartnerPoweredAccountRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetLlmProxyPartnerPoweredEnforceRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetLlmProxyPartnerPoweredWorkspaceRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetNetworkConnectivityConfigurationRequest": {}, + "settings.GetNetworkPolicyRequest": {}, + "settings.GetNotificationDestinationRequest": {}, + "settings.GetPersonalComputeSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, + "settings.GetPrivateEndpointRuleRequest": {}, + "settings.GetRestrictWorkspaceAdminsSettingRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetSqlResultsDownloadRequest": { + "fields": { + "etag": { + "description": "etag used for versioning. The response is at least as fresh as the eTag\nprovided. This is used for optimistic concurrency control as a way to\nhelp prevent simultaneous writes of a setting overwriting each other. It\nis strongly suggested that systems make use of the etag in the read -\u003e\ndelete pattern to perform setting deletions in order to avoid race\nconditions. That is, get an etag from a GET request, and pass it with the\nDELETE request to identify the rule set version you are deleting.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settings.GetStatusRequest": { + "fields": { + "keys": { + "launch_stage": "GA" + } + } + }, + "settings.GetTokenManagementRequest": {}, + "settings.GetTokenPermissionLevelsRequest": {}, "settings.GetTokenPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -43031,6 +46974,7 @@ } } }, + "settings.GetTokenPermissionsRequest": {}, "settings.GetTokenResponse": { "description": "Token with specified Token ID was successfully returned.", "fields": { @@ -43040,6 +46984,7 @@ } } }, + "settings.GetWorkspaceNetworkOptionRequest": {}, "settings.IpAccessListInfo": { "description": "Definition of an IP Access list", "fields": { @@ -43071,7 +47016,7 @@ "launch_stage": "GA" }, "list_type": { - "ref": "settings.list_type", + "ref": "settings.ListType", "launch_stage": "GA" }, "updated_at": { @@ -43084,7 +47029,7 @@ } } }, - "settings.ListIPAccessListResponse": { + "settings.ListIpAccessListResponse": { "description": "IP access lists were successfully returned.", "fields": { "ip_access_lists": { @@ -43092,6 +47037,15 @@ } } }, + "settings.ListIpAccessLists": {}, + "settings.ListNetworkConnectivityConfigurationsRequest": { + "fields": { + "page_token": { + "description": "Pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "settings.ListNetworkConnectivityConfigurationsResponse": { "description": "The network connectivity configuration list was successfully retrieved.", "fields": { @@ -43104,6 +47058,17 @@ } } }, + "settings.ListNetworkPoliciesRequest": { + "fields": { + "page_token": { + "description": "Pagination token to go to next page based on previous query.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "settings.ListNetworkPoliciesResponse": { "fields": { "items": { @@ -43116,6 +47081,16 @@ } } }, + "settings.ListNotificationDestinationsRequest": { + "fields": { + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "launch_stage": "GA" + } + } + }, "settings.ListNotificationDestinationsResponse": { "fields": { "next_page_token": { @@ -43144,6 +47119,14 @@ } } }, + "settings.ListPrivateEndpointRulesRequest": { + "fields": { + "page_token": { + "description": "Pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "settings.ListPrivateEndpointRulesResponse": { "description": "The private endpoint rule list was successfully retrieved.", "fields": { @@ -43164,6 +47147,19 @@ } } }, + "settings.ListTokenManagementRequest": { + "fields": { + "created_by_id": { + "description": "User ID of the user that created the token.", + "launch_stage": "GA" + }, + "created_by_username": { + "description": "Username of the user that created the token.", + "launch_stage": "GA" + } + } + }, + "settings.ListTokens": {}, "settings.ListTokensResponse": { "description": "Tokens were successfully returned.", "fields": { @@ -43173,6 +47169,21 @@ } } }, + "settings.ListType": { + "description": "Type of IP access list. Valid values are as follows and are case-sensitive:\n\n* `ALLOW`: An allow list. Include this IP or range.\n* `BLOCK`: A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list.", + "enum": [ + "ALLOW", + "BLOCK" + ], + "enum_launch_stages": { + "ALLOW": "GA", + "BLOCK": "GA" + }, + "enum_descriptions": { + "ALLOW": "An allow list. Include this IP or range.", + "BLOCK": "A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list." + } + }, "settings.LlmProxyPartnerPoweredAccount": { "fields": { "boolean_val": { @@ -43435,7 +47446,6 @@ }, "enabled": { "description": "Update this field to activate/deactivate this private endpoint to allow egress access from\nserverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "endpoint_name": { @@ -43451,7 +47461,6 @@ }, "gcp_endpoint": { "ref": "settings.GcpEndpoint", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "group_id": { @@ -43468,7 +47477,6 @@ }, "resource_names": { "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "rule_id": { @@ -43635,12 +47643,10 @@ "autoscope_state": { "description": "Output only. The autoscope state of this token.", "ref": "iam.AutoscopeState", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "backfill_scopes": { "description": "Output only. Scopes inferred from offline backfill processing.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -43657,7 +47663,6 @@ }, "inferred_scopes": { "description": "Output only. Inferred API path scopes collected for this token when autoscope is enabled.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "scopes": { @@ -43670,7 +47675,7 @@ } } }, - "settings.ReplaceIPAccessList": { + "settings.ReplaceIpAccessList": { "description": "Details required to replace an IP access list.", "fields": { "enabled": { @@ -43685,7 +47690,7 @@ "launch_stage": "GA" }, "list_type": { - "ref": "settings.list_type", + "ref": "settings.ListType", "launch_stage": "GA" } } @@ -43694,7 +47699,6 @@ "fields": { "disable_gov_tag_creation": { "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -43848,12 +47852,10 @@ "autoscope_state": { "description": "Output only. The autoscope state of this token.", "ref": "iam.AutoscopeState", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "backfill_scopes": { "description": "Output only. Scopes inferred from offline backfill processing.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "comment": { @@ -43878,7 +47880,6 @@ }, "inferred_scopes": { "description": "Output only. Inferred API path scopes collected for this token when autoscope is enabled.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "last_used_day": { @@ -44260,7 +48261,7 @@ } } }, - "settings.UpdateIPAccessList": { + "settings.UpdateIpAccessList": { "description": "Details required to update an IP access list.", "fields": { "enabled": { @@ -44275,7 +48276,7 @@ "launch_stage": "GA" }, "list_type": { - "ref": "settings.list_type", + "ref": "settings.ListType", "launch_stage": "GA" } } @@ -44331,6 +48332,27 @@ } } }, + "settings.UpdateNccPrivateEndpointRuleRequest": { + "fields": { + "private_endpoint_rule": { + "ref": "settings.UpdatePrivateEndpointRule", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.", + "launch_stage": "GA" + } + } + }, + "settings.UpdateNetworkPolicyRequest": { + "fields": { + "network_policy": { + "description": "Updated network policy configuration details.", + "ref": "settings.AccountNetworkPolicy", + "launch_stage": "GA" + } + } + }, "settings.UpdateNotificationDestinationRequest": { "fields": { "config": { @@ -44370,7 +48392,6 @@ }, "enabled": { "description": "Update this field to activate/deactivate this private endpoint to allow egress access from\nserverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "error_message": { @@ -44378,12 +48399,10 @@ }, "gcp_endpoint": { "ref": "settings.GcpEndpoint", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "resource_names": { "description": "Only used by private endpoints towards AWS S3 service.\n\nThe globally unique S3 bucket names that will be accessed via the VPC endpoint.\nThe bucket names must be in the same region as the NCC/endpoint service.\nWhen updating this field, we perform full update on this field. Please ensure a full list of desired\nresource_names is provided.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -44449,9 +48468,16 @@ } }, "settings.UpdateTokenResponse": {}, - "settings.WorkspaceConf": { - "launch_stage": "GA" + "settings.UpdateWorkspaceNetworkOptionRequest": { + "fields": { + "workspace_network_option": { + "description": "The network option details for the workspace.", + "ref": "settings.WorkspaceNetworkOption", + "launch_stage": "GA" + } + } }, + "settings.WorkspaceConf": {}, "settings.WorkspaceNetworkOption": { "fields": { "network_policy_id": { @@ -44470,21 +48496,6 @@ } } }, - "settings.list_type": { - "description": "Type of IP access list. Valid values are as follows and are case-sensitive:\n\n* `ALLOW`: An allow list. Include this IP or range.\n* `BLOCK`: A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list.", - "enum": [ - "ALLOW", - "BLOCK" - ], - "enum_launch_stages": { - "ALLOW": "GA", - "BLOCK": "GA" - }, - "enum_descriptions": { - "ALLOW": "An allow list. Include this IP or range.", - "BLOCK": "A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list." - } - }, "settingsv2.AibiDashboardEmbeddingAccessPolicy": { "fields": { "access_policy_type": { @@ -44718,6 +48729,9 @@ "DENY_ALL": "PRIVATE_PREVIEW" } }, + "settingsv2.GetPublicAccountSettingRequest": {}, + "settingsv2.GetPublicAccountUserPreferenceRequest": {}, + "settingsv2.GetPublicWorkspaceSettingRequest": {}, "settingsv2.IntegerMessage": { "fields": { "value": { @@ -44728,6 +48742,18 @@ } } }, + "settingsv2.ListAccountSettingsMetadataRequest": { + "fields": { + "page_size": { + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "description": "A page token, received from a previous `ListAccountSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountSettingsMetadataRequest` must match\nthe call that provided the page token.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settingsv2.ListAccountSettingsMetadataResponse": { "fields": { "next_page_token": { @@ -44740,6 +48766,24 @@ } } }, + "settingsv2.ListAccountUserPreferencesMetadataRequest": { + "fields": { + "page_size": { + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListAccountUserPreferencesMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListAccountUserPreferencesMetadataRequest` must match\nthe call that provided the page token.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "settingsv2.ListAccountUserPreferencesMetadataResponse": { "fields": { "next_page_token": { @@ -44752,6 +48796,18 @@ } } }, + "settingsv2.ListWorkspaceSettingsMetadataRequest": { + "fields": { + "page_size": { + "description": "The maximum number of settings to return. The service may return fewer than this value.\nIf unspecified, at most 200 settings will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_PREVIEW" + }, + "page_token": { + "description": "A page token, received from a previous `ListWorkspaceSettingsMetadataRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListWorkspaceSettingsMetadataRequest` must match\nthe call that provided the page token.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settingsv2.ListWorkspaceSettingsMetadataResponse": { "fields": { "next_page_token": { @@ -44774,6 +48830,30 @@ } } }, + "settingsv2.PatchPublicAccountSettingRequest": { + "fields": { + "setting": { + "ref": "settingsv2.Setting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "settingsv2.PatchPublicAccountUserPreferenceRequest": { + "fields": { + "setting": { + "ref": "settingsv2.UserPreference", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "settingsv2.PatchPublicWorkspaceSettingRequest": { + "fields": { + "setting": { + "ref": "settingsv2.Setting", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "settingsv2.PersonalComputeMessage": { "fields": { "value": { @@ -44817,7 +48897,6 @@ "fields": { "disable_gov_tag_creation": { "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -44863,7 +48942,6 @@ "allowed_apps_user_api_scopes": { "description": "Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.", "ref": "settingsv2.AllowedAppsUserApiScopesMessage", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -44888,7 +48966,6 @@ "collaboration_platform_connectivity": { "description": "Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.", "ref": "settingsv2.CollaborationPlatformConnectivityMessage", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" @@ -44913,7 +48990,6 @@ "effective_allowed_apps_user_api_scopes": { "description": "Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.", "ref": "settingsv2.AllowedAppsUserApiScopesMessage", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -44938,7 +49014,6 @@ "effective_collaboration_platform_connectivity": { "description": "Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.", "ref": "settingsv2.CollaborationPlatformConnectivityMessage", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -44955,7 +49030,6 @@ "effective_operational_email_custom_recipient": { "description": "Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.", "ref": "settingsv2.OperationalEmailCustomRecipientMessage", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -45000,7 +49074,6 @@ "operational_email_custom_recipient": { "description": "Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.", "ref": "settingsv2.OperationalEmailCustomRecipientMessage", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -45040,7 +49113,6 @@ }, "display_name": { "description": "Human-readable display name for the setting or feature preview.\nThis field may be unset if no display name is available.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "docs_link": { @@ -45054,7 +49126,6 @@ "preview_phase": { "description": "Preview phase for feature preview settings. This field is not set for non-preview settings.", "ref": "settingsv2.PreviewPhase", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "type": { @@ -45181,6 +49252,15 @@ "VARIANT": "GA" } }, + "sharing.CreateFederationPolicyRequest": { + "fields": { + "policy": { + "description": "Name of the policy. This is the name of the policy to be created.", + "ref": "sharing.FederationPolicy", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, "sharing.CreateProvider": { "fields": { "authentication_type": { @@ -45241,7 +49321,7 @@ }, "properties_kvpairs": { "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", - "ref": "sharing.SecurablePropertiesKVPairs", + "ref": "sharing.SecurablePropertiesKvPairs", "launch_stage": "GA" }, "sharing_code": { @@ -45266,6 +49346,32 @@ } } }, + "sharing.DeleteFederationPolicyRequest": {}, + "sharing.DeleteProviderRequest": {}, + "sharing.DeleteRecipientRequest": {}, + "sharing.DeleteShareRequest": {}, + "sharing.DeltaSharingDependency": { + "description": "Represents a UC dependency.", + "fields": { + "function": { + "ref": "sharing.DeltaSharingFunctionDependency", + "launch_stage": "GA" + }, + "table": { + "ref": "sharing.DeltaSharingTableDependency", + "launch_stage": "GA" + } + } + }, + "sharing.DeltaSharingDependencyList": { + "description": "Represents a list of dependencies.", + "fields": { + "dependencies": { + "description": "An array of Dependency.", + "launch_stage": "GA" + } + } + }, "sharing.DeltaSharingFunction": { "fields": { "aliases": { @@ -45283,7 +49389,7 @@ }, "dependency_list": { "description": "The dependency list of the function.", - "ref": "sharing.delta-sharing DependencyList", + "ref": "sharing.DeltaSharingDependencyList", "launch_stage": "GA" }, "full_data_type": { @@ -45338,6 +49444,28 @@ } } }, + "sharing.DeltaSharingFunctionDependency": { + "description": "A Function in UC as a dependency.", + "fields": { + "function_name": { + "launch_stage": "GA" + }, + "schema_name": { + "launch_stage": "GA" + } + } + }, + "sharing.DeltaSharingTableDependency": { + "description": "A Table in UC as a dependency.", + "fields": { + "schema_name": { + "launch_stage": "GA" + }, + "table_name": { + "launch_stage": "GA" + } + } + }, "sharing.FederationPolicy": { "fields": { "comment": { @@ -45351,16 +49479,16 @@ "description": "System-generated timestamp indicating when the policy was created.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "id": { "description": "Unique, immutable system-generated identifier for the federation policy.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ - "OUTPUT_ONLY", - "IMMUTABLE" + "IMMUTABLE", + "OUTPUT_ONLY" ] }, "name": { @@ -45473,7 +49601,11 @@ "PARAM": "GA" } }, + "sharing.GetActivationUrlInfoRequest": {}, "sharing.GetActivationUrlInfoResponse": {}, + "sharing.GetFederationPolicyRequest": {}, + "sharing.GetProviderRequest": {}, + "sharing.GetRecipientRequest": {}, "sharing.GetRecipientSharePermissionsResponse": { "fields": { "next_page_token": { @@ -45498,6 +49630,14 @@ } } }, + "sharing.GetShareRequest": { + "fields": { + "include_shared_data": { + "description": "Query for data to include in the share.", + "launch_stage": "GA" + } + } + }, "sharing.IpAccessList": { "fields": { "allowed_ip_addresses": { @@ -45506,6 +49646,22 @@ } } }, + "sharing.ListFederationPoliciesRequest": { + "fields": { + "max_results": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "sharing.ListFederationPoliciesResponse": { "fields": { "next_page_token": { @@ -45516,6 +49672,26 @@ } } }, + "sharing.ListProviderShareAssetsRequest": { + "fields": { + "function_max_results": { + "description": "Maximum number of functions to return.", + "launch_stage": "GA" + }, + "notebook_max_results": { + "description": "Maximum number of notebooks to return.", + "launch_stage": "GA" + }, + "table_max_results": { + "description": "Maximum number of tables to return.", + "launch_stage": "GA" + }, + "volume_max_results": { + "description": "Maximum number of volumes to return.", + "launch_stage": "GA" + } + } + }, "sharing.ListProviderShareAssetsResponse": { "description": "Response to ListProviderShareAssets, which contains the list of assets of a share.", "fields": { @@ -45554,6 +49730,22 @@ } } }, + "sharing.ListProvidersRequest": { + "fields": { + "data_provider_global_metastore_id": { + "description": "If not provided, all providers will be returned.\nIf no providers exist with this ID, no results will be returned.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of providers to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid providers are returned (not recommended).\n- Note: The number of returned providers might be less than the specified max_results size, even zero.\nThe only definitive indication that no further providers can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "sharing.ListProvidersResponse": { "fields": { "next_page_token": { @@ -45566,6 +49758,22 @@ } } }, + "sharing.ListRecipientsRequest": { + "fields": { + "data_recipient_global_metastore_id": { + "description": "If not provided, all recipients will be returned.\nIf no recipients exist with this ID, no results will be returned.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Maximum number of recipients to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid recipients are returned (not recommended).\n- Note: The number of returned recipients might be less than the specified max_results size, even zero.\nThe only definitive indication that no further recipients can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "sharing.ListRecipientsResponse": { "fields": { "next_page_token": { @@ -45578,6 +49786,18 @@ } } }, + "sharing.ListSharesRequest": { + "fields": { + "max_results": { + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "sharing.ListSharesResponse": { "fields": { "next_page_token": { @@ -45630,24 +49850,15 @@ }, "issuer": { "description": "The required token issuer, as specified in the 'iss' claim of federated tokens.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "subject": { "description": "The required token subject, as specified in the subject claim of federated tokens.\nThe subject claim identifies the identity of the user or machine accessing the resource.\nExamples for Entra ID (AAD):\n- U2M flow (group access): If the subject claim is `groups`, this must be the Object ID of the group in Entra ID.\n- U2M flow (user access): If the subject claim is `oid`, this must be the Object ID of the user in Entra ID.\n- M2M flow (OAuth App access): If the subject claim is `azp`, this must be the client ID of the OAuth app registered in Entra ID.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "subject_claim": { "description": "The claim that contains the subject of the token.\nDepending on the identity provider and the use case (U2M or M2M), this can vary:\n- For Entra ID (AAD):\n* U2M flow (group access): Use `groups`.\n* U2M flow (user access): Use `oid`.\n* M2M flow (OAuth App access): Use `azp`.\n- For other IdPs, refer to the specific IdP documentation.\n\nSupported `subject_claim` values are:\n- `oid`: Object ID of the user.\n- `azp`: Client ID of the OAuth app.\n- `groups`: Object ID of the group.\n- `sub`: Subject identifier for other use cases.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -45988,7 +50199,7 @@ }, "properties_kvpairs": { "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", - "ref": "sharing.SecurablePropertiesKVPairs", + "ref": "sharing.SecurablePropertiesKvPairs", "launch_stage": "GA" }, "region": { @@ -46106,6 +50317,7 @@ } } }, + "sharing.RetrieveTokenRequest": {}, "sharing.RetrieveTokenResponse": { "fields": { "bearerToken": { @@ -46146,7 +50358,7 @@ } } }, - "sharing.SecurablePropertiesKVPairs": { + "sharing.SecurablePropertiesKvPairs": { "description": "An object with __properties__ containing map of key-value properties attached to the securable.", "fields": { "properties": { @@ -46224,6 +50436,18 @@ } } }, + "sharing.SharePermissionsRequest": { + "fields": { + "max_results": { + "description": "Maximum number of permissions to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid permissions are returned (not recommended).\n- Note: The number of returned permissions might be less than the specified max_results size, even zero.\nThe only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "sharing.ShareToPrivilegeAssignment": { "fields": { "privilege_assignments": { @@ -46388,6 +50612,18 @@ "FUNCTION_STANDARD": "GA" } }, + "sharing.SharesListRequest": { + "fields": { + "max_results": { + "description": "Maximum number of shares to return.\n- when set to 0, the page length is set to a server configured value (recommended);\n- when set to a value greater than 0, the page length is the minimum of this value and a server configured value;\n- when set to a value less than 0, an invalid parameter error is returned;\n- If not set, all valid shares are returned (not recommended).\n- Note: The number of returned shares might be less than the specified max_results size, even zero.\nThe only definitive indication that no further shares can be fetched is when the next_page_token is unset from the response.", + "launch_stage": "GA" + }, + "page_token": { + "description": "Opaque pagination token to go to next page based on previous query.", + "launch_stage": "GA" + } + } + }, "sharing.Table": { "fields": { "comment": { @@ -46480,7 +50716,7 @@ }, "properties_kvpairs": { "description": "Recipient properties as map of string key-value pairs.\nWhen provided in update request, the specified properties will override the existing\nproperties. To add and remove properties, one would need to perform a read-modify-write.", - "ref": "sharing.SecurablePropertiesKVPairs", + "ref": "sharing.SecurablePropertiesKvPairs", "launch_stage": "GA" } } @@ -46561,50 +50797,6 @@ } } }, - "sharing.delta-sharing Dependency": { - "description": "Represents a UC dependency.", - "fields": { - "function": { - "ref": "sharing.delta-sharing FunctionDependency", - "launch_stage": "GA" - }, - "table": { - "ref": "sharing.delta-sharing TableDependency", - "launch_stage": "GA" - } - } - }, - "sharing.delta-sharing DependencyList": { - "description": "Represents a list of dependencies.", - "fields": { - "dependencies": { - "description": "An array of Dependency.", - "launch_stage": "GA" - } - } - }, - "sharing.delta-sharing FunctionDependency": { - "description": "A Function in UC as a dependency.", - "fields": { - "function_name": { - "launch_stage": "GA" - }, - "schema_name": { - "launch_stage": "GA" - } - } - }, - "sharing.delta-sharing TableDependency": { - "description": "A Table in UC as a dependency.", - "fields": { - "schema_name": { - "launch_stage": "GA" - }, - "table_name": { - "launch_stage": "GA" - } - } - }, "sql.AccessControl": { "fields": { "group_name": { @@ -46953,10 +51145,7 @@ }, "display_name": { "description": "The display name of the alert.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "effective_run_as": { "description": "The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults.", @@ -46968,10 +51157,7 @@ }, "evaluation": { "ref": "sql.AlertV2Evaluation", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "id": { "description": "UUID identifying the alert.", @@ -47004,10 +51190,7 @@ }, "query_text": { "description": "Text of the query to be run.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "run_as": { "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", @@ -47027,10 +51210,7 @@ }, "schedule": { "ref": "sql.CronSchedule", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "update_time": { "description": "The timestamp indicating when the alert was updated.", @@ -47041,10 +51221,7 @@ }, "warehouse_id": { "description": "ID of the SQL warehouse attached to the alert.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -47053,10 +51230,7 @@ "comparison_operator": { "description": "Operator used for comparison in alert evaluation.", "ref": "sql.ComparisonOperator", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "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.", @@ -47084,10 +51258,7 @@ "source": { "description": "Source column from result to use to evaluate alert", "ref": "sql.AlertV2OperandColumn", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" }, "state": { "description": "Latest state of alert evaluation.", @@ -47167,10 +51338,7 @@ ] }, "name": { - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -47244,6 +51412,7 @@ } } }, + "sql.CancelExecutionRequest": {}, "sql.Channel": { "description": "Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.", "fields": { @@ -47494,6 +51663,27 @@ } } }, + "sql.CreateAlertV2Request": { + "fields": { + "alert": { + "ref": "sql.AlertV2", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.CreateDefaultWarehouseOverrideRequest": { + "fields": { + "default_warehouse_override": { + "description": "Required. The default warehouse override to create.", + "ref": "sql.DefaultWarehouseOverride", + "launch_stage": "PUBLIC_BETA" + }, + "default_warehouse_override_id": { + "description": "Required. The ID to use for the override, which will become the final component\nof the override's resource name.\nCan be a numeric user ID or the literal string \"me\" for the current user.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "sql.CreateQueryRequest": { "fields": { "auto_resolve_display_name": { @@ -47729,17 +51919,11 @@ }, "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", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "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.", - "launch_stage": "PUBLIC_PREVIEW", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -48009,10 +52193,7 @@ "type": { "description": "The type of override behavior.", "ref": "sql.DefaultWarehouseOverrideType", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "warehouse_id": { "description": "The specific warehouse ID when type is CUSTOM.\nNot set for LAST_SELECTED type.", @@ -48034,7 +52215,15 @@ "LAST_SELECTED": "PUBLIC_BETA" } }, + "sql.DeleteAlertsLegacyRequest": {}, + "sql.DeleteDashboardRequest": {}, + "sql.DeleteDashboardWidgetRequest": {}, + "sql.DeleteDefaultWarehouseOverrideRequest": {}, + "sql.DeleteQueriesLegacyRequest": {}, + "sql.DeleteQueryVisualizationsLegacyRequest": {}, "sql.DeleteResponse": {}, + "sql.DeleteVisualizationRequest": {}, + "sql.DeleteWarehouseRequest": {}, "sql.DeleteWarehouseResponse": {}, "sql.Disposition": { "enum": [ @@ -48361,7 +52550,6 @@ }, "query_tags": { "description": "An array of query tags to annotate a SQL statement. A query tag\nconsists of a non-empty key and, optionally, a value. To represent a NULL\nvalue, either omit the `value` field or manually set it to `null` or white space.\nRefer to the SQL language reference for the format specification of query tags.\nThere's no significance to the order of tags. Only one value per key will be recorded.\nA sequence in excess of 20 query tags will be coerced to 20.\nExample:\n\n{\n...,\n\"query_tags\": [\n{ \"key\": \"team\", \"value\": \"eng\" },\n{ \"key\": \"some key only tag\" }\n]\n}", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "row_limit": { @@ -48417,7 +52605,6 @@ }, "http_headers": { "description": "HTTP headers that must be included with a GET request to the `external_link`.\nEach header is provided as a key-value pair.\nHeaders are typically used to pass a decryption key to the external service.\nThe values of these headers should be considered sensitive and the client should not expose\nthese values in a log.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "next_chunk_index": { @@ -48498,6 +52685,15 @@ "JSON_ARRAY": "GA" } }, + "sql.GetAlertRequest": {}, + "sql.GetAlertV2Request": {}, + "sql.GetAlertsLegacyRequest": {}, + "sql.GetConfigRequest": {}, + "sql.GetDashboardRequest": {}, + "sql.GetDbsqlPermissionRequest": {}, + "sql.GetDefaultWarehouseOverrideRequest": {}, + "sql.GetQueriesLegacyRequest": {}, + "sql.GetQueryRequest": {}, "sql.GetResponse": { "fields": { "access_control_list": { @@ -48514,6 +52710,9 @@ } } }, + "sql.GetStatementRequest": {}, + "sql.GetStatementResultChunkNRequest": {}, + "sql.GetWarehousePermissionLevelsRequest": {}, "sql.GetWarehousePermissionLevelsResponse": { "fields": { "permission_levels": { @@ -48522,6 +52721,8 @@ } } }, + "sql.GetWarehousePermissionsRequest": {}, + "sql.GetWarehouseRequest": {}, "sql.GetWarehouseResponse": { "fields": { "auto_stop_mins": { @@ -48633,6 +52834,7 @@ "TYPE_UNSPECIFIED": "GA" } }, + "sql.GetWorkspaceWarehouseConfigRequest": {}, "sql.GetWorkspaceWarehouseConfigResponse": { "fields": { "channel": { @@ -48906,6 +53108,16 @@ "TRASHED": "GA" } }, + "sql.ListAlertsRequest": { + "fields": { + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "launch_stage": "GA" + } + } + }, "sql.ListAlertsResponse": { "fields": { "next_page_token": { @@ -48979,6 +53191,22 @@ } } }, + "sql.ListAlertsV2Request": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "sql.ListAlertsV2Response": { "fields": { "alerts": { @@ -48989,6 +53217,45 @@ } } }, + "sql.ListDashboardsRequest": { + "fields": { + "order": { + "description": "Name of dashboard attribute to order by.", + "ref": "sql.ListOrder", + "launch_stage": "GA" + }, + "page": { + "description": "Page number to retrieve.", + "launch_stage": "GA" + }, + "page_size": { + "description": "Number of dashboards to return per page.", + "launch_stage": "GA" + }, + "q": { + "description": "Full text search term.", + "launch_stage": "GA" + } + } + }, + "sql.ListDefaultWarehouseOverridesRequest": { + "fields": { + "page_size": { + "description": "The maximum number of overrides to return. The service may return fewer than\nthis value.\nIf unspecified, at most 100 overrides will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListDefaultWarehouseOverrides` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to `ListDefaultWarehouseOverrides`\nmust match the call that provided the page token.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "sql.ListDefaultWarehouseOverridesResponse": { "description": "Response message for ListDefaultWarehouseOverrides.", "fields": { @@ -49012,6 +53279,36 @@ "name": "GA" } }, + "sql.ListQueriesLegacyRequest": { + "fields": { + "order": { + "description": "Name of query attribute to order by. Default sort order is ascending. Append a dash (`-`) to order descending instead.\n\n- `name`: The name of the query.\n\n- `created_at`: The timestamp the query was created.\n\n- `runtime`: The time it took to run this query. This is blank for parameterized queries. A blank value is treated as the highest value for sorting.\n\n- `executed_at`: The timestamp when the query was last run.\n\n- `created_by`: The user name of the user that created the query.", + "launch_stage": "GA" + }, + "page": { + "description": "Page number to retrieve.", + "launch_stage": "GA" + }, + "page_size": { + "description": "Number of queries to return per page.", + "launch_stage": "GA" + }, + "q": { + "description": "Full text search term", + "launch_stage": "GA" + } + } + }, + "sql.ListQueriesRequest": { + "fields": { + "page_size": { + "launch_stage": "GA" + }, + "page_token": { + "launch_stage": "GA" + } + } + }, "sql.ListQueriesResponse": { "fields": { "has_next_page": { @@ -49027,6 +53324,27 @@ } } }, + "sql.ListQueryHistoryRequest": { + "fields": { + "filter_by": { + "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", + "ref": "sql.QueryFilter", + "launch_stage": "GA" + }, + "include_metrics": { + "description": "Whether to include the query metrics with each query.\nOnly use this for a small subset of queries (max_results).\nDefaults to false.", + "launch_stage": "GA" + }, + "max_results": { + "description": "Limit the number of results returned in one page. Must be less than 1000 and the default is 100.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", + "launch_stage": "GA" + } + } + }, "sql.ListQueryObjectsResponse": { "fields": { "next_page_token": { @@ -49106,6 +53424,7 @@ } } }, + "sql.ListRequest": {}, "sql.ListResponse": { "fields": { "count": { @@ -49126,8 +53445,15 @@ } } }, - "sql.ListString": { - "launch_stage": "GA" + "sql.ListVisualizationsForQueryRequest": { + "fields": { + "page_size": { + "launch_stage": "PRIVATE_PREVIEW" + }, + "page_token": { + "launch_stage": "PRIVATE_PREVIEW" + } + } }, "sql.ListVisualizationsForQueryResponse": { "fields": { @@ -49139,6 +53465,23 @@ } } }, + "sql.ListWarehousesRequest": { + "fields": { + "page_size": { + "description": "The max number of warehouses to return.", + "launch_stage": "GA" + }, + "page_token": { + "description": "A page token, received from a previous `ListWarehouses` call.\nProvide this to retrieve the subsequent page; otherwise the first\nwill be retrieved.\n\nWhen paginating, all other parameters provided to `ListWarehouses` must match\nthe call that provided the page token.", + "launch_stage": "GA" + }, + "run_as_user_id": { + "description": "Deprecated: this field is ignored by the server.\nService Principal which will be used to fetch the list of endpoints.\nIf not specified, SQL Gateway will use the user from the session header.", + "deprecated": true, + "launch_stage": "GA" + } + } + }, "sql.ListWarehousesResponse": { "fields": { "next_page_token": { @@ -49546,7 +53889,6 @@ }, "query_tags": { "description": "A query execution can be optionally annotated with query tags", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "query_text": { @@ -49926,6 +54268,8 @@ } } }, + "sql.RestoreDashboardRequest": {}, + "sql.RestoreQueriesLegacyRequest": {}, "sql.RestoreResponse": {}, "sql.ResultData": { "description": "Contains the result data of a single chunk when using `INLINE` disposition. When using\n`EXTERNAL_LINKS` disposition, the array `external_links` is used instead to provide\nURLs to the result data\nin cloud storage. Exactly one of these alternatives is used. (While the `external_links`\narray prepares the API to return multiple links in a single response. Currently only a single\nlink is returned.)", @@ -50188,6 +54532,9 @@ "RELIABILITY_OPTIMIZED": "GA" } }, + "sql.StartRequest": { + "description": "Starts a SQL warehouse.\nThis API is idempotent." + }, "sql.StartWarehouseResponse": {}, "sql.State": { "description": "*\nState of a warehouse.", @@ -50292,6 +54639,9 @@ "HEALTHY": "GA" } }, + "sql.StopRequest": { + "description": "Stops a SQL warehouse.\nThis API is idempotent." + }, "sql.StopWarehouseResponse": {}, "sql.Success": { "fields": { @@ -50777,6 +55127,19 @@ } } }, + "sql.TrashAlertRequest": {}, + "sql.TrashAlertV2Request": { + "fields": { + "purge": { + "description": "Whether to permanently delete the alert. If not set, the alert will only be soft deleted.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "sql.TrashQueryRequest": {}, "sql.UpdateAlertRequest": { "fields": { "alert": { @@ -50830,6 +55193,38 @@ } } }, + "sql.UpdateAlertV2Request": { + "fields": { + "alert": { + "ref": "sql.AlertV2", + "launch_stage": "PUBLIC_PREVIEW" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_PREVIEW" + } + } + }, + "sql.UpdateDefaultWarehouseOverrideRequest": { + "fields": { + "allow_missing": { + "description": "If set to true, and the override is not found, a new override will be created.\nIn this situation, `update_mask` is ignored and all fields are applied.\nDefaults to false.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "default_warehouse_override": { + "description": "Required. The default warehouse override to update.\nThe name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}\nThe default_warehouse_override_id can be a numeric user ID or the literal string \"me\" for the current user.", + "ref": "sql.DefaultWarehouseOverride", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Required. Field mask specifying which fields to update.\nOnly the fields specified in the mask will be updated.\nUse \"*\" to update all fields.\nWhen allow_missing is true, this field is ignored and all fields are applied.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "sql.UpdateQueryRequest": { "fields": { "auto_resolve_display_name": { @@ -51203,25 +55598,48 @@ } } }, - "sql.cancelExecutionRequest": {}, - "sql.startRequest": { - "description": "Starts a SQL warehouse.\nThis API is idempotent." - }, - "sql.stopRequest": { - "description": "Stops a SQL warehouse.\nThis API is idempotent." - }, "supervisoragents.App": { "description": "Databricks app. Supported app: custom mcp, custom agent.", "fields": { "name": { "description": "App name", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.CreateExampleRequest": { + "fields": { + "example": { + "description": "The example to create under the parent Supervisor Agent.", + "ref": "supervisoragents.Example", + "launch_stage": "PUBLIC_BETA" } } }, + "supervisoragents.CreateSupervisorAgentRequest": { + "fields": { + "supervisor_agent": { + "description": "The Supervisor Agent to create.", + "ref": "supervisoragents.SupervisorAgent", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.CreateToolRequest": { + "fields": { + "tool": { + "ref": "supervisoragents.Tool", + "launch_stage": "PUBLIC_BETA" + }, + "tool_id": { + "description": "The ID to use for the tool, which will become the final component of\nthe tool's resource name.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.DeleteExampleRequest": {}, + "supervisoragents.DeleteSupervisorAgentRequest": {}, + "supervisoragents.DeleteToolRequest": {}, "supervisoragents.Example": { "description": "An example associated with a Supervisor Agent.\nContains a question and guidelines for how the agent should respond.", "fields": { @@ -51234,10 +55652,7 @@ }, "guidelines": { "description": "Guidelines for answering the question.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "name": { "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/examples/{example_id}", @@ -51245,10 +55660,7 @@ }, "question": { "description": "The example question.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -51257,13 +55669,12 @@ "id": { "description": "Deprecated: use space_id instead. Still REQUIRED for backward compatibility\nuntil a future API version removes it.", "deprecated": true, - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, + "supervisoragents.GetExampleRequest": {}, + "supervisoragents.GetSupervisorAgentPermissionLevelsRequest": {}, "supervisoragents.GetSupervisorAgentPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -51272,14 +55683,14 @@ } } }, + "supervisoragents.GetSupervisorAgentPermissionsRequest": {}, + "supervisoragents.GetSupervisorAgentRequest": {}, + "supervisoragents.GetToolRequest": {}, "supervisoragents.KnowledgeAssistant": { "fields": { "knowledge_assistant_id": { "description": "The ID of the knowledge assistant.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "serving_endpoint_name": { "description": "Deprecated: use knowledge_assistant_id instead.", @@ -51291,6 +55702,24 @@ } } }, + "supervisoragents.ListExamplesRequest": { + "fields": { + "page_size": { + "description": "The maximum number of examples to return.\nIf unspecified, at most 100 examples will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListExamples` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "supervisoragents.ListExamplesResponse": { "description": "A list of Supervisor Agent examples.", "fields": { @@ -51302,6 +55731,24 @@ } } }, + "supervisoragents.ListSupervisorAgentsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of supervisor agents to return.\nIf unspecified, at most 100 supervisor agents will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token, received from a previous `ListSupervisorAgents` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "supervisoragents.ListSupervisorAgentsResponse": { "fields": { "next_page_token": { @@ -51313,6 +55760,22 @@ } } }, + "supervisoragents.ListToolsRequest": { + "fields": { + "page_size": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "supervisoragents.ListToolsResponse": { "fields": { "next_page_token": { @@ -51348,10 +55811,7 @@ }, "display_name": { "description": "The display name of the Supervisor Agent, unique at workspace level.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "endpoint_name": { "description": "The name of the supervisor agent's serving endpoint.", @@ -51542,10 +56002,7 @@ }, "tool_type": { "description": "Tool type. Must be one of: \"genie_space\", \"knowledge_assistant\", \"uc_function\", \"uc_connection\", \"uc_mcp\", \"app\", \"volume\", \"dashboard\", \"serving_endpoint\", \"table\", \"vector_search_index\", \"catalog\", \"schema\", \"supervisor_agent\", \"web_search\", \"skill\". The legacy values \"lakeview_dashboard\" and \"uc_table\" are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" }, "uc_connection": { "ref": "supervisoragents.UcConnection", @@ -51574,10 +56031,7 @@ "description": "Databricks UC connection. Supported connection: external mcp server.", "fields": { "name": { - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" } } }, @@ -51585,10 +56039,45 @@ "fields": { "name": { "description": "Full uc function name", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.UpdateExampleRequest": { + "fields": { + "example": { + "ref": "supervisoragents.Example", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Comma-delimited list of fields to update on the example.\nAllowed values: `question`, `guidelines`.\nExamples:\n- `question`\n- `question,guidelines`", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.UpdateSupervisorAgentRequest": { + "fields": { + "supervisor_agent": { + "description": "The SupervisorAgent to update.", + "ref": "supervisoragents.SupervisorAgent", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Field mask for fields to be updated.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "supervisoragents.UpdateToolRequest": { + "fields": { + "tool": { + "description": "The Tool to update.", + "ref": "supervisoragents.Tool", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Field mask for fields to be updated.", + "launch_stage": "PUBLIC_BETA" } } }, @@ -51596,9 +56085,44 @@ "fields": { "name": { "description": "Full uc volume name", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "tags.CreateTagAssignmentRequest": { + "fields": { + "tag_assignment": { + "ref": "tags.TagAssignment", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "tags.CreateTagPolicyRequest": { + "fields": { + "tag_policy": { + "ref": "tags.TagPolicy", + "launch_stage": "GA" + } + } + }, + "tags.DeleteTagAssignmentRequest": {}, + "tags.DeleteTagPolicyRequest": {}, + "tags.GetTagAssignmentRequest": {}, + "tags.GetTagPolicyRequest": {}, + "tags.ListTagAssignmentsRequest": { + "fields": { + "page_size": { + "description": "Optional. Maximum number of tag assignments to return in a single page", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Pagination token to go to the next page of tag assignments. Requests first page if absent.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED" + "OPTIONAL" ] } } @@ -51614,6 +56138,24 @@ } } }, + "tags.ListTagPoliciesRequest": { + "fields": { + "page_size": { + "description": "The maximum number of results to return in this request. Fewer results may be returned than requested. If\nunspecified or set to 0, this defaults to 1000. The maximum value is 1000; values above 1000 will be coerced down\nto 1000.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "An optional page token received from a previous list tag policies call.", + "launch_stage": "GA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "tags.ListTagPoliciesResponse": { "fields": { "next_page_token": { @@ -51630,7 +56172,6 @@ "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -51638,7 +56179,6 @@ "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -51646,7 +56186,6 @@ "description": "The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -51683,7 +56222,6 @@ "tag_key": { "launch_stage": "GA", "behaviors": [ - "REQUIRED", "IMMUTABLE" ] }, @@ -51703,13 +56241,34 @@ } } }, + "tags.UpdateTagAssignmentRequest": { + "fields": { + "tag_assignment": { + "ref": "tags.TagAssignment", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "tags.UpdateTagPolicyRequest": { + "fields": { + "tag_policy": { + "ref": "tags.TagPolicy", + "launch_stage": "GA" + }, + "update_mask": { + "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "launch_stage": "GA" + } + } + }, "tags.Value": { "fields": { "name": { - "launch_stage": "GA", - "behaviors": [ - "REQUIRED" - ] + "launch_stage": "GA" } } }, @@ -51729,7 +56288,6 @@ "fields": { "budget_policy_id": { "description": "The budget policy id to be applied", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "endpoint_type": { @@ -51743,12 +56301,10 @@ }, "target_qps": { "description": "Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { "description": "The usage policy id to be applied once we've migrated to usage policies", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" } } @@ -51772,7 +56328,6 @@ "index_subtype": { "description": "The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", "ref": "vectorsearch.IndexSubtype", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "index_type": { @@ -51825,6 +56380,14 @@ "SUCCESS": "GA" } }, + "vectorsearch.DeleteDataVectorIndexRequest": { + "fields": { + "primary_keys": { + "description": "List of primary keys for the data to be deleted.", + "launch_stage": "GA" + } + } + }, "vectorsearch.DeleteDataVectorIndexResponse": { "fields": { "result": { @@ -51839,7 +56402,9 @@ } } }, + "vectorsearch.DeleteEndpointRequest": {}, "vectorsearch.DeleteEndpointResponse": {}, + "vectorsearch.DeleteIndexRequest": {}, "vectorsearch.DeleteIndexResponse": {}, "vectorsearch.DeltaSyncVectorIndexSpecRequest": { "fields": { @@ -51959,7 +56524,6 @@ "fields": { "budget_policy_id": { "description": "The user-selected budget policy id for the endpoint.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "creation_timestamp": { @@ -51972,12 +56536,10 @@ }, "custom_tags": { "description": "The custom tags assigned to the endpoint", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "effective_budget_policy_id": { "description": "The budget policy id applied to the endpoint", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "endpoint_status": { @@ -52013,7 +56575,6 @@ "scaling_info": { "description": "Scaling information for the endpoint", "ref": "vectorsearch.EndpointScalingInfo", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -52022,13 +56583,11 @@ "fields": { "requested_target_qps": { "description": "The requested QPS target for the endpoint. Best-effort; the system does not\nguarantee this QPS will be achieved.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "state": { "description": "The current state of the scaling change request.", "ref": "vectorsearch.ScalingChangeState", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" } } @@ -52077,6 +56636,16 @@ "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW" } }, + "vectorsearch.GetEndpointRequest": {}, + "vectorsearch.GetIndexRequest": { + "fields": { + "ensure_reranker_compatible": { + "description": "If true, the URL returned for the index is guaranteed to be compatible with the reranker.\nCurrently this means we return the CP URL regardless of how the index is being accessed.\nIf not set or set to false, the URL may still be compatible with the reranker depending on\nwhat URL we return.", + "launch_stage": "GA" + } + } + }, + "vectorsearch.GetVectorSearchEndpointPermissionLevelsRequest": {}, "vectorsearch.GetVectorSearchEndpointPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -52085,6 +56654,7 @@ } } }, + "vectorsearch.GetVectorSearchEndpointPermissionsRequest": {}, "vectorsearch.IndexSubtype": { "description": "The subtype of the AI Search index, determining the indexing and retrieval strategy.\n- `VECTOR`: Not supported. Use `HYBRID` instead.\n- `FULL_TEXT`: An index that uses full-text search without vector embeddings.\n- `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.", "enum": [ @@ -52115,8 +56685,25 @@ } } }, - "vectorsearch.ListString": { - "launch_stage": "GA" + "vectorsearch.ListEndpointsRequest": { + "fields": { + "page_token": { + "description": "Token for pagination", + "launch_stage": "GA" + } + } + }, + "vectorsearch.ListIndexesRequest": { + "fields": { + "endpoint_name": { + "description": "Name of the endpoint", + "launch_stage": "GA" + }, + "page_token": { + "description": "Token for pagination", + "launch_stage": "GA" + } + } }, "vectorsearch.ListValue": { "fields": { @@ -52221,7 +56808,6 @@ "index_subtype": { "description": "The subtype of the index.", "ref": "vectorsearch.IndexSubtype", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "index_type": { @@ -52249,7 +56835,6 @@ "vectorsearch.PatchEndpointBudgetPolicyResponse": { "fields": { "budget_policy_id": { - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "effective_budget_policy_id": { @@ -52262,7 +56847,6 @@ "fields": { "target_qps": { "description": "Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS\nwill be achieved.", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -52303,7 +56887,6 @@ }, "columns_to_rerank": { "description": "Column names used to retrieve data to send to the reranker.", - "preview": "PRIVATE", "launch_stage": "PRIVATE_PREVIEW" }, "filters_json": { @@ -52484,6 +57067,7 @@ } } }, + "vectorsearch.SyncIndexRequest": {}, "vectorsearch.SyncIndexResponse": {}, "vectorsearch.UpdateEndpointCustomTagsRequest": { "fields": { @@ -52593,7 +57177,6 @@ "index_subtype": { "description": "The subtype of the index.", "ref": "vectorsearch.IndexSubtype", - "preview": "PUBLIC", "launch_stage": "PUBLIC_BETA" }, "index_type": { @@ -52746,7 +57329,6 @@ } } }, - "vectorsearch.syncIndexRequest": {}, "workspace.AclItem": { "description": "An item representing an ACL rule applied to the given principal (user or group)\non the associated scope point.", "fields": { @@ -52803,12 +57385,10 @@ }, "is_default_for_provider": { "description": "if the credential is the default for the given provider", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "the name of the git credential, used for identification and ease of lookup", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "personal_access_token": { @@ -52841,12 +57421,10 @@ }, "is_default_for_provider": { "description": "if the credential is the default for the given provider", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "the name of the git credential, used for identification and ease of lookup", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -52947,12 +57525,10 @@ }, "is_default_for_provider": { "description": "if the credential is the default for the given provider", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "the name of the git credential, used for identification and ease of lookup", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } @@ -52981,7 +57557,16 @@ } } }, + "workspace.DeleteCredentialsRequest": { + "fields": { + "principal_id": { + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "launch_stage": "GA" + } + } + }, "workspace.DeleteCredentialsResponse": {}, + "workspace.DeleteRepoRequest": {}, "workspace.DeleteRepoResponse": {}, "workspace.DeleteResponse": {}, "workspace.DeleteScope": { @@ -53005,6 +57590,40 @@ } }, "workspace.DeleteSecretResponse": {}, + "workspace.ExportFormat": { + "description": "The format for workspace import and export.", + "enum": [ + "SOURCE", + "HTML", + "JUPYTER", + "DBC", + "R_MARKDOWN", + "AUTO", + "RAW" + ], + "enum_launch_stages": { + "AUTO": "GA", + "DBC": "GA", + "HTML": "GA", + "JUPYTER": "GA", + "RAW": "GA", + "R_MARKDOWN": "GA", + "SOURCE": "GA" + } + }, + "workspace.ExportRequest": { + "fields": { + "format": { + "description": "This specifies the format of the exported file. By default, this is `SOURCE`.\n\nThe value is case sensitive.\n\n- `SOURCE`: The notebook is exported as source code. Directory exports will not include non-notebook entries.\n- `HTML`: The notebook is exported as an HTML file.\n- `JUPYTER`: The notebook is exported as a Jupyter/IPython Notebook file.\n- `DBC`: The notebook is exported in Databricks archive format. Directory exports will not include non-notebook entries.\n- `R_MARKDOWN`: The notebook is exported to R Markdown format.\n- `AUTO`: The object or directory is exported depending on the objects type. Directory exports will include notebooks and workspace files.", + "ref": "workspace.ExportFormat", + "launch_stage": "GA" + }, + "path": { + "description": "The absolute path of the object or directory. Exporting a directory is only supported for the `DBC`, `SOURCE`, and `AUTO` format.", + "launch_stage": "GA" + } + } + }, "workspace.ExportResponse": { "description": "The request field `direct_download` determines whether a JSON response or binary contents are returned by this endpoint.", "fields": { @@ -53018,6 +57637,26 @@ } } }, + "workspace.GetAclRequest": { + "fields": { + "principal": { + "description": "The principal to fetch ACL information for.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope to fetch ACL information from.", + "launch_stage": "GA" + } + } + }, + "workspace.GetCredentialsRequest": { + "fields": { + "principal_id": { + "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "launch_stage": "GA" + } + } + }, "workspace.GetCredentialsResponse": { "fields": { "credential_id": { @@ -53038,16 +57677,15 @@ }, "is_default_for_provider": { "description": "if the credential is the default for the given provider", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "the name of the git credential, used for identification and ease of lookup", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" } } }, + "workspace.GetRepoPermissionLevelsRequest": {}, "workspace.GetRepoPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -53056,6 +57694,8 @@ } } }, + "workspace.GetRepoPermissionsRequest": {}, + "workspace.GetRepoRequest": {}, "workspace.GetRepoResponse": { "fields": { "branch": { @@ -53089,6 +57729,18 @@ } } }, + "workspace.GetSecretRequest": { + "fields": { + "key": { + "description": "Name of the secret to fetch value information.", + "launch_stage": "GA" + }, + "scope": { + "description": "The name of the scope that contains the secret.", + "launch_stage": "GA" + } + } + }, "workspace.GetSecretResponse": { "fields": { "key": { @@ -53101,6 +57753,15 @@ } } }, + "workspace.GetStatusRequest": { + "fields": { + "path": { + "description": "The absolute path of the notebook or directory.", + "launch_stage": "GA" + } + } + }, + "workspace.GetWorkspaceObjectPermissionLevelsRequest": {}, "workspace.GetWorkspaceObjectPermissionLevelsResponse": { "fields": { "permission_levels": { @@ -53109,6 +57770,7 @@ } } }, + "workspace.GetWorkspaceObjectPermissionsRequest": {}, "workspace.Import": { "fields": { "content": { @@ -53172,6 +57834,14 @@ "SQL": "GA" } }, + "workspace.ListAclsRequest": { + "fields": { + "scope": { + "description": "The name of the scope to fetch ACL information from.", + "launch_stage": "GA" + } + } + }, "workspace.ListAclsResponse": { "fields": { "items": { @@ -53180,6 +57850,14 @@ } } }, + "workspace.ListCredentialsRequest": { + "fields": { + "principal_id": { + "description": "The ID of the service principal whose credentials will be listed. Only service principal managers can perform this action.", + "launch_stage": "GA" + } + } + }, "workspace.ListCredentialsResponse": { "fields": { "credentials": { @@ -53188,6 +57866,18 @@ } } }, + "workspace.ListReposRequest": { + "fields": { + "next_page_token": { + "description": "Token used to get the next page of results. If not specified, returns the first page of\nresults as well as a next page token if there are more results.", + "launch_stage": "GA" + }, + "path_prefix": { + "description": "Filters repos that have paths starting with the given path prefix.\nIf not provided or when provided an effectively empty prefix (`/` or `/Workspace`)\nGit folders (repos) from `/Workspace/Repos` will be served.", + "launch_stage": "GA" + } + } + }, "workspace.ListReposResponse": { "fields": { "next_page_token": { @@ -53208,6 +57898,7 @@ } } }, + "workspace.ListScopesRequest": {}, "workspace.ListScopesResponse": { "fields": { "scopes": { @@ -53216,6 +57907,14 @@ } } }, + "workspace.ListSecretsRequest": { + "fields": { + "scope": { + "description": "The name of the scope to list secrets within.", + "launch_stage": "GA" + } + } + }, "workspace.ListSecretsResponse": { "fields": { "secrets": { @@ -53224,6 +57923,18 @@ } } }, + "workspace.ListWorkspaceRequest": { + "fields": { + "notebooks_modified_after": { + "description": "UTC timestamp in milliseconds", + "launch_stage": "GA" + }, + "path": { + "description": "The absolute path of the notebook or directory.", + "launch_stage": "GA" + } + } + }, "workspace.Mkdirs": { "fields": { "path": { @@ -53537,12 +58248,10 @@ }, "is_default_for_provider": { "description": "if the credential is the default for the given provider", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "name": { "description": "the name of the git credential, used for identification and ease of lookup", - "preview": "PUBLIC", "launch_stage": "PUBLIC_PREVIEW" }, "personal_access_token": { @@ -53671,27 +58380,6 @@ "launch_stage": "GA" } } - }, - "workspace.exportFormat": { - "description": "The format for workspace import and export.", - "enum": [ - "SOURCE", - "HTML", - "JUPYTER", - "DBC", - "R_MARKDOWN", - "AUTO", - "RAW" - ], - "enum_launch_stages": { - "AUTO": "GA", - "DBC": "GA", - "HTML": "GA", - "JUPYTER": "GA", - "RAW": "GA", - "R_MARKDOWN": "GA", - "SOURCE": "GA" - } } }, "commands": { diff --git a/Taskfile.yml b/Taskfile.yml index e2cf17df51d..9309ba577d6 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -753,11 +753,13 @@ tasks: - task: ws # Refreshes .codegen/cli.json from the OpenAPI spec at .codegen/_openapi_sha. - # This is the only step that needs a universe checkout: genkit's clijson - # producer maps the OpenAPI spec into the cli.json spec. Run it when the - # spec SHA is bumped; `task generate` then consumes the committed cli.json. - # SDK version bumps (go.mod/go.sum) are a manual `go get` step beforehand; - # TestConsistentDatabricksSdkVersion asserts the two stay in sync. + # cli.json is a genkit SDK target like any other (mode cli_v1 in .codegen.json): + # the cli_v1 producer is decoupled from the spec, so genkit is built from the + # universe checkout's HEAD (the current producer), while the spec itself is + # fetched by SHA. Run it when the spec SHA is bumped; `task generate` then + # consumes the committed cli.json. SDK version bumps (go.mod/go.sum) are a + # manual `go get` step beforehand; TestConsistentDatabricksSdkVersion asserts + # the two stay in sync. generate-cli-json: desc: Produce .codegen/cli.json from the OpenAPI spec via genkit (requires universe repo) sources: @@ -770,28 +772,23 @@ tasks: UNIVERSE_DIR: sh: echo "${UNIVERSE_DIR:-$HOME/universe}" cmds: + - echo "Building genkit..." + - cd {{.UNIVERSE_DIR}} && ./tools/bazel build //openapi/genkit + - echo "Generating cli.json..." + - '{{.UNIVERSE_DIR}}/bazel-bin/openapi/genkit/genkit_/genkit update-sdk --dir {{.ROOT_DIR}}' + - git checkout -- .gitattributes + - go test -timeout 240s -run TestConsistentDatabricksSdkVersion github.com/databricks/cli/internal/build + - rm .github/workflows/next-changelog.yml + - mv tagging.py internal/genkit/tagging.py + - mv tagging.py.lock internal/genkit/tagging.py.lock - | - if [ -z "$UNIVERSE_SKIP_CHECKOUT" ]; then - if ! git -C {{.UNIVERSE_DIR}} diff --quiet || ! git -C {{.UNIVERSE_DIR}} diff --cached --quiet; then - echo "Error: universe repo at {{.UNIVERSE_DIR}} has uncommitted changes; commit or stash them, or set UNIVERSE_SKIP_CHECKOUT=1 to skip checkout" - exit 1 - fi - echo "Checking out universe at SHA: $(cat .codegen/_openapi_sha)" - cd {{.UNIVERSE_DIR}} - if ! git cat-file -e $(cat {{.ROOT_DIR}}/.codegen/_openapi_sha) 2>/dev/null; then - git fetch --filter=blob:none origin master - fi - git checkout $(cat {{.ROOT_DIR}}/.codegen/_openapi_sha) + if [ "$(uname)" = "Darwin" ]; then + sed -i '' 's|tagging.py|internal/genkit/tagging.py|g' .github/workflows/tagging.yml else - echo "UNIVERSE_SKIP_CHECKOUT set; using current {{.UNIVERSE_DIR}} HEAD" + sed -i 's|tagging.py|internal/genkit/tagging.py|g' .github/workflows/tagging.yml fi - - echo "Building genkit cliv1 producer..." - - cd {{.UNIVERSE_DIR}} && ./tools/bazel build //openapi/genkit/codegen/cliv1/cmd - - echo "Downloading OpenAPI spec..." - - 'wget -O /tmp/cli-openapi.json "https://openapi.dev.databricks.com/$(cat .codegen/_openapi_sha)/specs/all-internal.json"' - - echo "Producing cli.json..." - - '{{.UNIVERSE_DIR}}/bazel-bin/openapi/genkit/codegen/cliv1/cmd/cmd_/cmd --spec /tmp/cli-openapi.json --out .codegen/cli.json --sha "$(cat .codegen/_openapi_sha)"' - - go test -timeout 240s -run TestConsistentDatabricksSdkVersion github.com/databricks/cli/internal/build + - "{{.GO_TOOL}} yamlfmt .github/workflows/tagging.yml" + - task: ws # Refreshes out.fields.txt, which records the field paths / types emitted by # `bundle debug refschema` (see cmd/bundle/debug/refschema.go). It reflects diff --git a/bundle/docsgen/output/resources.md b/bundle/docsgen/output/resources.md index 14e0a57f583..e4015eb6d92 100644 --- a/bundle/docsgen/output/resources.md +++ b/bundle/docsgen/output/resources.md @@ -1419,7 +1419,7 @@ clusters: - - `kind` - String - - + - The kind of compute described by this compute specification. Depending on `kind`, different validations and default values will be applied. 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) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. - - `lifecycle` - Map @@ -3678,7 +3678,7 @@ If new_cluster, a description of a cluster that is created for each task. - - `kind` - String - - + - The kind of compute described by this compute specification. Depending on `kind`, different validations and default values will be applied. 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) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. - - `node_type_id` - String @@ -5373,7 +5373,7 @@ If new_cluster, a description of a new cluster that is created for each run. - - `kind` - String - - + - The kind of compute described by this compute specification. Depending on `kind`, different validations and default values will be applied. 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) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. - - `node_type_id` - String diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index 8d6ac11a81b..dc2d93c357a 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -1711,6 +1711,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificatio "enabled": "description": |- Whether to enable data classification. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination: "email_addresses": "description": |- @@ -2589,6 +2591,21 @@ github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "description": |- destination needs to be provided, e.g. `{ "workspace": { "destination": "/cluster-init-scripts/setup-datadog.sh" } }` +github.com/databricks/databricks-sdk-go/service/compute.Kind: + "_": + "description": |- + The kind of compute described by this compute specification. + + Depending on `kind`, different validations and default values will be applied. + + 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) + + By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. + "enum": + - |- + CLASSIC_PREVIEW github.com/databricks/databricks-sdk-go/service/compute.Library: "cran": "description": |- @@ -3214,12 +3231,18 @@ github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig: "gpu_node_pool_id": "description": |- IDof the GPU pool to use. + "x-databricks-preview": |- + PRIVATE "gpu_type": "description": |- GPU type. + "x-databricks-preview": |- + PRIVATE "num_gpus": "description": |- Number of GPUs. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Condition: "_": "enum": @@ -3308,16 +3331,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-preview": |- + PRIVATE "dbt_cloud_job_id": "description": |- Id of the dbt Cloud job to be triggered + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask: "connection_resource_name": "description": |- The resource name of the UC connection that authenticates the dbt platform for this task + "x-databricks-preview": |- + PRIVATE "dbt_platform_job_id": "description": |- Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtTask: "catalog": "description": |- @@ -3382,30 +3413,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-preview": |- + PRIVATE + "compute": + "x-databricks-preview": |- + PRIVATE "dl_runtime_image": "description": |- Runtime image + "x-databricks-preview": |- + PRIVATE "mlflow_experiment_name": "description": |- Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. + "x-databricks-preview": |- + PRIVATE "source": "description": |- Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository 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-preview": |- + PRIVATE "training_script_path": "description": |- The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. + "x-databricks-preview": |- + PRIVATE "yaml_parameters": "description": |- Optional string containing model parameters passed to the training script in yaml format. If present, then the content in yaml_parameters_file_path will be ignored. + "x-databricks-preview": |- + PRIVATE "yaml_parameters_file_path": "description": |- Optional path to a YAML file containing model parameters passed to the training script. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.GitProvider: "_": "enum": @@ -3607,12 +3654,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-preview": |- + PRIVATE "import_from_git_branch": "description": |- Name of the branch which the job is imported from. + "x-databricks-preview": |- + PRIVATE "job_config_path": "description": |- Path of the job YAML file that contains the job specification. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: "_": "description": |- @@ -3680,22 +3733,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-preview": |- + PRIVATE "condition": "description": |- The condition based on which to trigger a job run. + "x-databricks-preview": |- + PRIVATE "min_time_between_triggers_seconds": "description": |- If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. + "x-databricks-preview": |- + PRIVATE "securable_name": "description": |- Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, "mycatalog.myschema" in the case of schema-level triggers) or empty in the case of metastore-level triggers. + "x-databricks-preview": |- + PRIVATE "wait_after_last_change_seconds": "description": |- If set, the trigger starts a run only after no model updates have occurred for the specified time 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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition: "_": "enum": @@ -3860,13 +3923,21 @@ github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask: "description": |- Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. + "x-databricks-preview": |- + PRIVATE "parameters": "description": |- An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter: - "name": {} - "value": {} + "name": + "x-databricks-preview": |- + PRIVATE + "value": + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask: "entry_point": "description": |- @@ -4610,42 +4681,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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "path_filter": "description": |- Include files with file names matching the pattern Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions: - "corrupt_record_column": {} + "corrupt_record_column": + "x-databricks-preview": |- + PRIVATE "file_filters": "description": |- Generic options + "x-databricks-preview": |- + PRIVATE "format": "description": |- required for TableSpec + "x-databricks-preview": |- + PRIVATE "format_options": "description": |- Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options - "ignore_corrupt_files": {} - "infer_column_types": {} + "x-databricks-preview": |- + PRIVATE + "ignore_corrupt_files": + "x-databricks-preview": |- + PRIVATE + "infer_column_types": + "x-databricks-preview": |- + PRIVATE "reader_case_sensitive": "description": |- Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior - "rescued_data_column": {} + "x-databricks-preview": |- + PRIVATE + "rescued_data_column": + "x-databricks-preview": |- + PRIVATE "schema_evolution_mode": "description": |- Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + "x-databricks-preview": |- + PRIVATE "schema_hints": "description": |- Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints - "single_variant_column": {} + "x-databricks-preview": |- + PRIVATE + "single_variant_column": + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat: "_": "enum": @@ -4699,6 +4798,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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: "_": "description": |- @@ -4709,22 +4810,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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions: - "entity_type": {} - "file_ingestion_options": {} + "entity_type": + "x-databricks-preview": |- + PRIVATE + "file_ingestion_options": + "x-databricks-preview": |- + PRIVATE "url": "description": |- Google Drive URL. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType: "_": "enum": @@ -4750,9 +4863,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli [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-preview": |- + PRIVATE "connection_name": "description": |- Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + "x-databricks-preview": |- + PRIVATE "connection_parameters": "description": |- Optional, Internal. Parameters required to establish an initial connection with the source. @@ -4761,14 +4878,20 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli "gateway_storage_catalog": "description": |- Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + "x-databricks-preview": |- + PRIVATE "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-preview": |- + PRIVATE "gateway_storage_schema": "description": |- Required, Immutable. The name of the schema for the gateway pipelines's storage location. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition: "connection_name": "description": |- @@ -4866,6 +4989,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin controlled by the `parameters` field. "deprecation_message": |- This field is deprecated + "x-databricks-preview": |- + PRIVATE "parameters": "description": |- Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), @@ -4875,16 +5000,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-preview": |- + PRIVATE "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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue: "key": "description": |- Key for the report parameter, can be a column name or other metadata + "x-databricks-preview": |- + PRIVATE "value": "description": |- Value for the report parameter. @@ -4892,6 +5023,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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: "_": "enum": @@ -4946,18 +5079,28 @@ github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions "as_variant": "description": |- Parse the entire value as a single Variant column. + "x-databricks-preview": |- + PRIVATE "schema": "description": |- Inline schema string for JSON parsing (Spark DDL format). + "x-databricks-preview": |- + PRIVATE "schema_evolution_mode": "description": |- (Optional) Schema evolution mode for schema inference. + "x-databricks-preview": |- + PRIVATE "schema_file_path": "description": |- Path to a schema file (.ddl). + "x-databricks-preview": |- + PRIVATE "schema_hints": "description": |- (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: "client_config": "description": |- @@ -4970,6 +5113,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: "description": |- (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. + "x-databricks-preview": |- + PRIVATE "max_offsets_per_trigger": "description": |- Internal option to control the maximum number of offsets to process per trigger. @@ -4979,18 +5124,26 @@ github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: "description": |- (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". + "x-databricks-preview": |- + PRIVATE "topic_pattern": "description": |- Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. + "x-databricks-preview": |- + PRIVATE "topics": "description": |- Topics to subscribe to. Only one of topics or topic_pattern must be specified. + "x-databricks-preview": |- + PRIVATE "value_transformer": "description": |- (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger: {} github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions: "_": @@ -5084,33 +5237,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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "folder_filter": "description": |- Deprecated. Use include_folders instead. "deprecation_message": |- This field is deprecated + "x-databricks-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "include_subjects": "description": |- (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with @@ -5118,22 +5283,30 @@ 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-preview": |- + PRIVATE "sender_filter": "description": |- Deprecated. Use include_senders instead. "deprecation_message": |- This field is deprecated + "x-databricks-preview": |- + PRIVATE "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-preview": |- + PRIVATE "subject_filter": "description": |- Deprecated. Use include_subjects instead. "deprecation_message": |- This field is deprecated + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern: "include": "description": |- @@ -5390,14 +5563,20 @@ github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow: "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-preview": |- + PRIVATE "start_hour": "description": |- An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. Continuous pipeline restart is triggered only within a five-hour window starting at this hour. + "x-databricks-preview": |- + PRIVATE "time_zone_id": "description": |- Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.RunAs: "_": "description": |- @@ -5434,12 +5613,18 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions: "description": |- (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. + "x-databricks-preview": |- + PRIVATE "file_ingestion_options": "description": |- (Optional) File ingestion options for processing files. + "x-databricks-preview": |- + PRIVATE "url": "description": |- Required. The SharePoint URL. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType: "_": "enum": @@ -5462,6 +5647,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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: "_": "description": |- @@ -5577,36 +5764,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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "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-preview": |- + PRIVATE "report_type": "description": |- (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. + "x-databricks-preview": |- + PRIVATE "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-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel: "_": "description": |- @@ -5644,7 +5845,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: "format": "description": |- Required: the wire format of the data. - "json_options": {} + "x-databricks-preview": |- + PRIVATE + "json_options": + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: "_": "enum": @@ -5660,6 +5865,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "description": |- (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. + "x-databricks-preview": |- + PRIVATE github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: "enable_readable_secondaries": "description": |- diff --git a/bundle/internal/schema/cli_json.go b/bundle/internal/schema/cli_json.go index c63a875f363..f44c5479f0d 100644 --- a/bundle/internal/schema/cli_json.go +++ b/bundle/internal/schema/cli_json.go @@ -11,7 +11,7 @@ type cliJSONField struct { Description string `json:"description,omitempty"` Enum []any `json:"enum,omitempty"` Deprecated bool `json:"deprecated,omitempty"` - Preview string `json:"preview,omitempty"` + LaunchStage string `json:"launch_stage,omitempty"` Ref string `json:"ref,omitempty"` Behaviors []string `json:"behaviors,omitempty"` } @@ -21,7 +21,7 @@ type cliJSONSchema struct { Description string `json:"description,omitempty"` Enum []any `json:"enum,omitempty"` Deprecated bool `json:"deprecated,omitempty"` - Preview string `json:"preview,omitempty"` + LaunchStage string `json:"launch_stage,omitempty"` Fields map[string]cliJSONField `json:"fields,omitempty"` } diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 3e0cbadd683..cae5e5ed776 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -108,6 +108,18 @@ func mapIncorrectTypNames(ref string) string { } } +// previewFromLaunchStage maps a launch stage to the preview marker the bundle +// uses to hide a field or type from completions. cli.json no longer carries a +// separate preview flag — launch_stage is the single source of truth — so a +// private-preview stage is the only one that should not be suggested. Every +// other stage (GA, public preview, ...) yields an empty marker. +func previewFromLaunchStage(launchStage string) string { + if launchStage == "PRIVATE_PREVIEW" { + return "PRIVATE" + } + return "" +} + func isOutputOnly(behaviors []string) *bool { if !slices.Contains(behaviors, "OUTPUT_ONLY") { return nil @@ -147,10 +159,7 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over basePath := getPath(typ) pkg := map[string]annotation.Descriptor{} annotations[basePath] = pkg - preview := ref.Preview - if preview == "PUBLIC" { - preview = "" - } + preview := previewFromLaunchStage(ref.LaunchStage) if ref.Description != "" || ref.Enum != nil || ref.Deprecated || preview != "" { pkg[RootTypeKey] = annotation.Descriptor{ Description: ref.Description, @@ -162,10 +171,7 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { - preview = refProp.Preview - if preview == "PUBLIC" { - preview = "" - } + preview = previewFromLaunchStage(refProp.LaunchStage) description := refProp.Description diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index f6e3c0bc044..c8b34e1ff9e 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -3999,7 +3999,9 @@ "properties": { "enabled": { "description": "Whether to enable data classification.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -5072,7 +5074,9 @@ "oneOf": [ { "type": "string", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "enum": [ + "CLASSIC_PREVIEW", "CLASSIC_PREVIEW" ] }, @@ -5905,15 +5909,21 @@ "properties": { "gpu_node_pool_id": { "description": "IDof the GPU pool to use.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "gpu_type": { "description": "GPU type.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "num_gpus": { "description": "Number of GPUs.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6084,11 +6094,15 @@ "properties": { "connection_resource_name": { "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "dbt_cloud_job_id": { "description": "Id of the dbt Cloud job to be triggered", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -6106,11 +6120,15 @@ "properties": { "connection_resource_name": { "description": "The resource name of the UC connection that authenticates the dbt platform for this task", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "dbt_platform_job_id": { "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -6247,34 +6265,50 @@ "properties": { "command": { "description": "Command launcher to run the actual script, e.g. bash, python etc.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "compute": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "dl_runtime_image": { "description": "Runtime image", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "mlflow_experiment_name": { "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "source": { "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "training_script_path": { "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "yaml_parameters": { "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "yaml_parameters_file_path": { "description": "Optional path to a YAML file containing model parameters passed to the training script.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6632,15 +6666,21 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "import_from_git_branch": { "description": "Name of the branch which the job is imported from.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "job_config_path": { "description": "Path of the job YAML file that contains the job specification.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6759,23 +6799,33 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "min_time_between_triggers_seconds": { "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "securable_name": { "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "wait_after_last_change_seconds": { "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -7095,11 +7145,15 @@ "properties": { "main": { "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "parameters": { "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -7116,10 +7170,14 @@ "type": "object", "properties": { "name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "value": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8402,15 +8460,21 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "modified_before": { "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "path_filter": { "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8427,43 +8491,65 @@ "type": "object", "properties": { "corrupt_record_column": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "file_filters": { "description": "Generic options", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "format": { "description": "required for TableSpec", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "format_options": { "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "ignore_corrupt_files": { - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "infer_column_types": { - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "reader_case_sensitive": { "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "rescued_data_column": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema_evolution_mode": { "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema_hints": { "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "single_variant_column": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8561,7 +8647,9 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8580,15 +8668,21 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "manager_account_id": { "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "sync_start_date": { "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -8608,14 +8702,20 @@ "type": "object", "properties": { "entity_type": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "file_ingestion_options": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "url": { "description": "Google Drive URL.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8676,12 +8776,16 @@ "connection_id": { "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", "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" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "connection_parameters": { "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", @@ -8691,15 +8795,21 @@ }, "gateway_storage_catalog": { "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "gateway_storage_name": { "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "gateway_storage_schema": { "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -8805,17 +8915,23 @@ "incremental": { "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", "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" + "$ref": "#/$defs/map/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "report_parameters": { "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", + "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true } }, @@ -8834,11 +8950,15 @@ "properties": { "key": { "description": "Key for the report parameter, can be a column name or other metadata", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "value": { "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8908,23 +9028,33 @@ "properties": { "as_variant": { "description": "Parse the entire value as a single Variant column.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema": { "description": "Inline schema string for JSON parsing (Spark DDL format).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema_evolution_mode": { "description": "(Optional) Schema evolution mode for schema inference.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema_file_path": { "description": "Path to a schema file (.ddl).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "schema_hints": { "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -8948,7 +9078,9 @@ }, "key_transformer": { "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "max_offsets_per_trigger": { "description": "Internal option to control the maximum number of offsets to process per trigger.", @@ -8958,19 +9090,27 @@ }, "starting_offset": { "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "topic_pattern": { "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "topics": { "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "value_transformer": { "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -9152,48 +9292,68 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "body_format": { "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "folder_filter": { "description": "Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "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" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "include_mailboxes": { "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "include_senders": { "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "include_subjects": { "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "sender_filter": { "description": "Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "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" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "subject_filter": { "description": "Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true } }, @@ -9591,15 +9751,21 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "start_hour": { "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "time_zone_id": { "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false, @@ -9686,15 +9852,21 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "file_ingestion_options": { "description": "(Optional) File ingestion options for processing files.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "url": { "description": "Required. The SharePoint URL.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -9730,7 +9902,9 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -9920,31 +10094,45 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "dimensions": { "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "lookback_window_days": { "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "metrics": { "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "query_lifetime": { "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "report_type": { "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "sync_start_date": { "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -10001,10 +10189,14 @@ "properties": { "format": { "description": "Required: the wire format of the data.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true }, "json_options": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false @@ -10038,7 +10230,9 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true } }, "additionalProperties": false diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 2e8db1c3836..7c5aa72fd20 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -3677,6 +3677,8 @@ "enabled": { "description": "Whether to enable data classification.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -4563,7 +4565,9 @@ }, "compute.Kind": { "type": "string", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "enum": [ + "CLASSIC_PREVIEW", "CLASSIC_PREVIEW" ] }, @@ -5159,16 +5163,22 @@ "gpu_node_pool_id": { "description": "IDof the GPU pool to use.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "gpu_type": { "description": "GPU type.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "num_gpus": { "description": "Number of GPUs.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" } }, @@ -5297,11 +5307,15 @@ "connection_resource_name": { "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.256.0" }, "dbt_cloud_job_id": { "description": "Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.256.0" } }, @@ -5313,11 +5327,15 @@ "connection_resource_name": { "description": "The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.257.0" }, "dbt_platform_job_id": { "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.257.0" } }, @@ -5429,40 +5447,56 @@ "command": { "description": "Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "compute": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "dl_runtime_image": { "description": "Runtime image", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "mlflow_experiment_name": { "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "source": { "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "training_script_path": { "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters": { "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters_file_path": { "description": "Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.243.0" } }, @@ -5738,16 +5772,22 @@ "dirty_state": { "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "import_from_git_branch": { "description": "Name of the branch which the job is imported from.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "job_config_path": { "description": "Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -5824,26 +5864,36 @@ "aliases": { "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "condition": { "description": "The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "min_time_between_triggers_seconds": { "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "securable_name": { "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "wait_after_last_change_seconds": { "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.279.0" } }, @@ -6101,11 +6151,15 @@ "main": { "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "parameters": { "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" } }, @@ -6116,10 +6170,14 @@ "properties": { "name": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" } }, @@ -7207,16 +7265,22 @@ "modified_after": { "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "modified_before": { "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "path_filter": { "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7227,52 +7291,74 @@ "properties": { "corrupt_record_column": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_filters": { "description": "Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format": { "description": "required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format_options": { "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "ignore_corrupt_files": { "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "infer_column_types": { "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "reader_case_sensitive": { "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "rescued_data_column": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_evolution_mode": { "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_hints": { "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "single_variant_column": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7335,6 +7421,8 @@ "manager_account_id": { "description": "(Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, @@ -7347,16 +7435,22 @@ "lookback_window_days": { "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "manager_account_id": { "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7370,15 +7464,21 @@ "properties": { "entity_type": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { "description": "Google Drive URL.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7419,13 +7519,17 @@ "connection_id": { "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", "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.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "connection_parameters": { @@ -7438,16 +7542,22 @@ "gateway_storage_catalog": { "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_name": { "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_schema": { "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -7543,19 +7653,25 @@ "incremental": { "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", "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}", "$ref": "#/$defs/map/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.271.0" }, "report_parameters": { "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", + "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.271.0", "deprecated": true } @@ -7568,11 +7684,15 @@ "key": { "description": "Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.271.0" }, "value": { "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.271.0" } }, @@ -7621,26 +7741,36 @@ "as_variant": { "description": "Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema": { "description": "Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_evolution_mode": { "description": "(Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_file_path": { "description": "Path to a schema file (.ddl).", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_hints": { "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" } }, @@ -7659,6 +7789,8 @@ "key_transformer": { "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "max_offsets_per_trigger": { @@ -7671,21 +7803,29 @@ "starting_offset": { "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topic_pattern": { "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topics": { "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value_transformer": { "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" } }, @@ -7819,56 +7959,76 @@ "attachment_mode": { "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "body_format": { "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "folder_filter": { "description": "Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "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.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_mailboxes": { "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_senders": { "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_subjects": { "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sender_filter": { "description": "Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "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.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "subject_filter": { "description": "Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.299.2", "deprecated": true } @@ -8209,16 +8369,22 @@ "days_of_week": { "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "start_hour": { "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "time_zone_id": { "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.234.0" } }, @@ -8291,16 +8457,22 @@ "entity_type": { "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { "description": "(Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { "description": "Required. The SharePoint URL.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -8322,6 +8494,8 @@ "enforce_schema": { "description": "(Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, @@ -8487,36 +8661,50 @@ "data_level": { "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "dimensions": { "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "lookback_window_days": { "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "metrics": { "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "query_lifetime": { "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "report_type": { "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -8551,10 +8739,14 @@ "format": { "description": "Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" }, "json_options": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.1.0" } }, @@ -8574,6 +8766,8 @@ "start_date": { "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, diff --git a/internal/cligen/cli_json_test.go b/internal/cligen/cli_json_test.go index c252be12b1e..1b48e79193c 100644 --- a/internal/cligen/cli_json_test.go +++ b/internal/cligen/cli_json_test.go @@ -18,7 +18,6 @@ const cliJSONPath = "../../.codegen/cli.json" // enough of it to assert structural invariants (keys + field refs). type fullDoc struct { Metadata struct { - OpenAPISha string `json:"openapi_sha"` GeneratorVersion string `json:"generator_version"` } `json:"metadata"` Schemas map[string]schemaDoc `json:"schemas"` @@ -53,8 +52,14 @@ func TestCliJSONIsInterpretable(t *testing.T) { if doc.Metadata.GeneratorVersion != "cliv1" { t.Errorf("metadata.generator_version = %q, want %q", doc.Metadata.GeneratorVersion, "cliv1") } - if !shaRE.MatchString(doc.Metadata.OpenAPISha) { - t.Errorf("metadata.openapi_sha = %q, want a 40-char sha", doc.Metadata.OpenAPISha) + // The spec SHA is not carried in cli.json metadata; genkit writes it to the + // sibling _openapi_sha file, the same convention every other SDK target uses. + shaBytes, err := os.ReadFile("../../.codegen/_openapi_sha") + if err != nil { + t.Fatalf("read _openapi_sha: %v", err) + } + if sha := strings.TrimSpace(string(shaBytes)); !shaRE.MatchString(sha) { + t.Errorf("_openapi_sha = %q, want a 40-char sha", sha) } // --- schemas block: non-empty, and every field ref points at a known schema --- diff --git a/python/databricks/bundles/jobs/_models/compute_config.py b/python/databricks/bundles/jobs/_models/compute_config.py index b1194a80cde..e688eb0cd34 100644 --- a/python/databricks/bundles/jobs/_models/compute_config.py +++ b/python/databricks/bundles/jobs/_models/compute_config.py @@ -17,16 +17,22 @@ class ComputeConfig: num_gpus: VariableOr[int] """ + :meta private: [EXPERIMENTAL] + Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + GPU type. """ @@ -43,16 +49,22 @@ class ComputeConfigDict(TypedDict, total=False): num_gpus: VariableOr[int] """ + :meta private: [EXPERIMENTAL] + Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + GPU type. """ diff --git a/python/databricks/bundles/jobs/_models/dbt_platform_task.py b/python/databricks/bundles/jobs/_models/dbt_platform_task.py index 92cf53ac861..82ebe71e220 100644 --- a/python/databricks/bundles/jobs/_models/dbt_platform_task.py +++ b/python/databricks/bundles/jobs/_models/dbt_platform_task.py @@ -17,11 +17,15 @@ class DbtPlatformTask: connection_resource_name: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ @@ -38,11 +42,15 @@ class DbtPlatformTaskDict(TypedDict, total=False): connection_resource_name: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ 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..9bc82df2e20 100644 --- a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py +++ b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py @@ -22,24 +22,35 @@ class GenAiComputeTask: dl_runtime_image: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Runtime image """ command: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfig] = None + """ + :meta private: [EXPERIMENTAL] + """ mlflow_experiment_name: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. """ source: VariableOrOptional[Source] = None """ + :meta private: [EXPERIMENTAL] + Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository 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. @@ -48,17 +59,23 @@ class GenAiComputeTask: training_script_path: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. """ yaml_parameters: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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 """ + :meta private: [EXPERIMENTAL] + Optional path to a YAML file containing model parameters passed to the training script. """ @@ -75,24 +92,35 @@ class GenAiComputeTaskDict(TypedDict, total=False): dl_runtime_image: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Runtime image """ command: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfigParam] + """ + :meta private: [EXPERIMENTAL] + """ mlflow_experiment_name: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. """ source: VariableOrOptional[SourceParam] """ + :meta private: [EXPERIMENTAL] + Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository 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. @@ -101,17 +129,23 @@ class GenAiComputeTaskDict(TypedDict, total=False): training_script_path: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. """ yaml_parameters: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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] """ + :meta private: [EXPERIMENTAL] + Optional path to a YAML file containing model parameters passed to the training script. """ diff --git a/python/databricks/bundles/jobs/_models/kind.py b/python/databricks/bundles/jobs/_models/kind.py index 33a487a90e7..b5408117ef6 100644 --- a/python/databricks/bundles/jobs/_models/kind.py +++ b/python/databricks/bundles/jobs/_models/kind.py @@ -3,6 +3,18 @@ class Kind(Enum): + """ + The kind of compute described by this compute specification. + + Depending on `kind`, different validations and default values will be applied. + + 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) + + By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. + """ + CLASSIC_PREVIEW = "CLASSIC_PREVIEW" diff --git a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py index 140e7e09ec9..a253b8d7dba 100644 --- a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py +++ b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py @@ -25,28 +25,38 @@ class ModelTriggerConfiguration: condition: VariableOr[ModelTriggerConfigurationCondition] """ + :meta private: [EXPERIMENTAL] + The condition based on which to trigger a job run. """ aliases: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] = None """ + :meta private: [EXPERIMENTAL] + If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. """ securable_name: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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 """ + :meta private: [EXPERIMENTAL] + 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,28 +75,38 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): condition: VariableOr[ModelTriggerConfigurationConditionParam] """ + :meta private: [EXPERIMENTAL] + The condition based on which to trigger a job run. """ aliases: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] """ + :meta private: [EXPERIMENTAL] + If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. """ securable_name: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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] """ + :meta private: [EXPERIMENTAL] + 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/python_operator_task.py b/python/databricks/bundles/jobs/_models/python_operator_task.py index fbce9e38cde..cf6f4760ba3 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task.py @@ -21,6 +21,8 @@ class PythonOperatorTask: main: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ @@ -29,6 +31,8 @@ class PythonOperatorTask: default_factory=list ) """ + :meta private: [EXPERIMENTAL] + An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ @@ -46,12 +50,16 @@ class PythonOperatorTaskDict(TypedDict, total=False): main: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ parameters: VariableOrList[PythonOperatorTaskParameterParam] """ + :meta private: [EXPERIMENTAL] + An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ diff --git a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py index 5fd3628748d..b1f252b3106 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py @@ -16,8 +16,14 @@ class PythonOperatorTaskParameter: """ name: VariableOrOptional[str] = None + """ + :meta private: [EXPERIMENTAL] + """ value: VariableOrOptional[str] = None + """ + :meta private: [EXPERIMENTAL] + """ @classmethod def from_dict(cls, value: "PythonOperatorTaskParameterDict") -> "Self": @@ -31,8 +37,14 @@ class PythonOperatorTaskParameterDict(TypedDict, total=False): """""" name: VariableOrOptional[str] + """ + :meta private: [EXPERIMENTAL] + """ value: VariableOrOptional[str] + """ + :meta private: [EXPERIMENTAL] + """ PythonOperatorTaskParameterParam = ( diff --git a/python/databricks/bundles/pipelines/__init__.py b/python/databricks/bundles/pipelines/__init__.py index c7dbd9b41e8..fb5a372a950 100644 --- a/python/databricks/bundles/pipelines/__init__.py +++ b/python/databricks/bundles/pipelines/__init__.py @@ -94,9 +94,6 @@ "IngestionPipelineDefinitionWorkdayReportParameters", "IngestionPipelineDefinitionWorkdayReportParametersDict", "IngestionPipelineDefinitionWorkdayReportParametersParam", - "IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", - "IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict", - "IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam", "InitScriptInfo", "InitScriptInfoDict", "InitScriptInfoParam", @@ -394,11 +391,6 @@ IngestionPipelineDefinitionWorkdayReportParametersDict, IngestionPipelineDefinitionWorkdayReportParametersParam, ) -from databricks.bundles.pipelines._models.ingestion_pipeline_definition_workday_report_parameters_query_key_value import ( - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue, - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict, - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam, -) from databricks.bundles.pipelines._models.init_script_info import ( InitScriptInfo, InitScriptInfoDict, diff --git a/python/databricks/bundles/pipelines/_models/file_filter.py b/python/databricks/bundles/pipelines/_models/file_filter.py index 497c43acd45..92283b649c8 100644 --- a/python/databricks/bundles/pipelines/_models/file_filter.py +++ b/python/databricks/bundles/pipelines/_models/file_filter.py @@ -17,6 +17,8 @@ class FileFilter: modified_after: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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 @@ -24,6 +26,8 @@ class FileFilter: modified_before: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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 @@ -31,6 +35,8 @@ class FileFilter: path_filter: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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,6 +54,8 @@ class FileFilterDict(TypedDict, total=False): modified_after: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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 @@ -55,6 +63,8 @@ class FileFilterDict(TypedDict, total=False): modified_before: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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 @@ -62,6 +72,8 @@ class FileFilterDict(TypedDict, total=False): path_filter: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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..1d6f18dfc5f 100644 --- a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py +++ b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py @@ -29,49 +29,76 @@ class FileIngestionOptions: """ corrupt_record_column: VariableOrOptional[str] = None + """ + :meta private: [EXPERIMENTAL] + """ file_filters: VariableOrList[FileFilter] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormat] = None """ + :meta private: [EXPERIMENTAL] + required for TableSpec """ format_options: VariableOrDict[str] = field(default_factory=dict) """ + :meta private: [EXPERIMENTAL] + Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] = None + """ + :meta private: [EXPERIMENTAL] + """ infer_column_types: VariableOrOptional[bool] = None + """ + :meta private: [EXPERIMENTAL] + """ reader_case_sensitive: VariableOrOptional[bool] = None """ + :meta private: [EXPERIMENTAL] + Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] = None + """ + :meta private: [EXPERIMENTAL] + """ schema_evolution_mode: VariableOrOptional[ FileIngestionOptionsSchemaEvolutionMode ] = None """ + :meta private: [EXPERIMENTAL] + Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints """ single_variant_column: VariableOrOptional[str] = None + """ + :meta private: [EXPERIMENTAL] + """ @classmethod def from_dict(cls, value: "FileIngestionOptionsDict") -> "Self": @@ -85,49 +112,76 @@ class FileIngestionOptionsDict(TypedDict, total=False): """""" corrupt_record_column: VariableOrOptional[str] + """ + :meta private: [EXPERIMENTAL] + """ file_filters: VariableOrList[FileFilterParam] """ + :meta private: [EXPERIMENTAL] + Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormatParam] """ + :meta private: [EXPERIMENTAL] + required for TableSpec """ format_options: VariableOrDict[str] """ + :meta private: [EXPERIMENTAL] + Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] + """ + :meta private: [EXPERIMENTAL] + """ infer_column_types: VariableOrOptional[bool] + """ + :meta private: [EXPERIMENTAL] + """ reader_case_sensitive: VariableOrOptional[bool] """ + :meta private: [EXPERIMENTAL] + Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] + """ + :meta private: [EXPERIMENTAL] + """ schema_evolution_mode: VariableOrOptional[ FileIngestionOptionsSchemaEvolutionModeParam ] """ + :meta private: [EXPERIMENTAL] + Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints """ single_variant_column: VariableOrOptional[str] + """ + :meta private: [EXPERIMENTAL] + """ FileIngestionOptionsParam = FileIngestionOptionsDict | FileIngestionOptions diff --git a/python/databricks/bundles/pipelines/_models/google_ads_config.py b/python/databricks/bundles/pipelines/_models/google_ads_config.py index f907fa9d622..debbe468b2b 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_config.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_config.py @@ -17,6 +17,8 @@ class GoogleAdsConfig: manager_account_id: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (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. @@ -37,6 +39,8 @@ class GoogleAdsConfigDict(TypedDict, total=False): manager_account_id: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (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. diff --git a/python/databricks/bundles/pipelines/_models/google_ads_options.py b/python/databricks/bundles/pipelines/_models/google_ads_options.py index faa76baae42..3cd04a5ef7f 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_options.py @@ -21,6 +21,8 @@ class GoogleAdsOptions: manager_account_id: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + (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. @@ -28,12 +30,16 @@ class GoogleAdsOptions: lookback_window_days: VariableOrOptional[int] = None """ + :meta private: [EXPERIMENTAL] + (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 """ + :meta private: [EXPERIMENTAL] + (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,6 +58,8 @@ class GoogleAdsOptionsDict(TypedDict, total=False): manager_account_id: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + (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. @@ -59,12 +67,16 @@ class GoogleAdsOptionsDict(TypedDict, total=False): lookback_window_days: VariableOrOptional[int] """ + :meta private: [EXPERIMENTAL] + (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] """ + :meta private: [EXPERIMENTAL] + (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..71b251e83e8 100644 --- a/python/databricks/bundles/pipelines/_models/google_drive_options.py +++ b/python/databricks/bundles/pipelines/_models/google_drive_options.py @@ -24,11 +24,19 @@ class GoogleDriveOptions: """ entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityType] = None + """ + :meta private: [EXPERIMENTAL] + """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None + """ + :meta private: [EXPERIMENTAL] + """ url: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Google Drive URL. """ @@ -44,11 +52,19 @@ class GoogleDriveOptionsDict(TypedDict, total=False): """""" entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityTypeParam] + """ + :meta private: [EXPERIMENTAL] + """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] + """ + :meta private: [EXPERIMENTAL] + """ url: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Google Drive URL. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_config.py b/python/databricks/bundles/pipelines/_models/ingestion_config.py index 988227c43e3..c452222df9c 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_config.py @@ -4,10 +4,7 @@ from databricks.bundles.core._transform import _transform from databricks.bundles.core._transform_to_json import _transform_to_json_value from databricks.bundles.core._variable import VariableOrOptional -from databricks.bundles.pipelines._models.report_spec import ( - ReportSpec, - ReportSpecParam, -) +from databricks.bundles.pipelines._models.report_spec import ReportSpec, ReportSpecParam from databricks.bundles.pipelines._models.schema_spec import SchemaSpec, SchemaSpecParam from databricks.bundles.pipelines._models.table_spec import TableSpec, TableSpecParam 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..79c26080742 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py @@ -21,24 +21,25 @@ class IngestionGatewayPipelineDefinition: connection_name: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + 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. - """ - connection_parameters: VariableOrOptional[ConnectionParameters] = None """ :meta private: [EXPERIMENTAL] @@ -48,6 +49,8 @@ class IngestionGatewayPipelineDefinition: gateway_storage_name: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + 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,24 +69,25 @@ class IngestionGatewayPipelineDefinitionDict(TypedDict, total=False): connection_name: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ + :meta private: [EXPERIMENTAL] + 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. - """ - connection_parameters: VariableOrOptional[ConnectionParametersParam] """ :meta private: [EXPERIMENTAL] @@ -93,6 +97,8 @@ class IngestionGatewayPipelineDefinitionDict(TypedDict, total=False): gateway_storage_name: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + 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_workday_report_parameters.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py index d48d68495df..56e1840c791 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 @@ -3,15 +3,7 @@ from databricks.bundles.core._transform import _transform from databricks.bundles.core._transform_to_json import _transform_to_json_value -from databricks.bundles.core._variable import ( - VariableOrDict, - VariableOrList, - VariableOrOptional, -) -from databricks.bundles.pipelines._models.ingestion_pipeline_definition_workday_report_parameters_query_key_value import ( - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue, - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam, -) +from databricks.bundles.core._variable import VariableOrDict if TYPE_CHECKING: from typing_extensions import Self @@ -23,15 +15,10 @@ class IngestionPipelineDefinitionWorkdayReportParameters: :meta private: [EXPERIMENTAL] """ - incremental: VariableOrOptional[bool] = None - """ - [DEPRECATED] (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) """ + :meta private: [EXPERIMENTAL] + 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: @@ -41,14 +28,6 @@ class IngestionPipelineDefinitionWorkdayReportParameters: } """ - report_parameters: VariableOrList[ - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue - ] = field(default_factory=list) - """ - [DEPRECATED] (Optional) Additional custom parameters for Workday Report - This field is deprecated and should not be used. Use `parameters` instead. - """ - @classmethod def from_dict( cls, value: "IngestionPipelineDefinitionWorkdayReportParametersDict" @@ -62,15 +41,10 @@ def as_dict(self) -> "IngestionPipelineDefinitionWorkdayReportParametersDict": class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=False): """""" - incremental: VariableOrOptional[bool] - """ - [DEPRECATED] (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] """ + :meta private: [EXPERIMENTAL] + 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: @@ -80,14 +54,6 @@ class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=Fa } """ - report_parameters: VariableOrList[ - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam - ] - """ - [DEPRECATED] (Optional) Additional custom parameters for Workday Report - This field is deprecated and should not be used. Use `parameters` instead. - """ - IngestionPipelineDefinitionWorkdayReportParametersParam = ( IngestionPipelineDefinitionWorkdayReportParametersDict 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 deleted file mode 100644 index 2a24858d66e..00000000000 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py +++ /dev/null @@ -1,70 +0,0 @@ -from dataclasses import dataclass -from typing import TYPE_CHECKING, TypedDict - -from databricks.bundles.core._transform import _transform -from databricks.bundles.core._transform_to_json import _transform_to_json_value -from databricks.bundles.core._variable import VariableOrOptional - -if TYPE_CHECKING: - from typing_extensions import Self - - -@dataclass(kw_only=True) -class IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue: - """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] - """ - - key: VariableOrOptional[str] = None - """ - Key for the report parameter, can be a column name or other metadata - """ - - value: VariableOrOptional[str] = None - """ - 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() - 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) days from current date - """ - - @classmethod - def from_dict( - cls, - value: "IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict", - ) -> "Self": - return _transform(cls, value) - - def as_dict( - self, - ) -> "IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict": - return _transform_to_json_value(self) # type:ignore - - -class IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict( - TypedDict, total=False -): - """""" - - key: VariableOrOptional[str] - """ - Key for the report parameter, can be a column name or other metadata - """ - - value: VariableOrOptional[str] - """ - 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() - 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) days from current date - """ - - -IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam = ( - IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict - | IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue -) diff --git a/python/databricks/bundles/pipelines/_models/json_transformer_options.py b/python/databricks/bundles/pipelines/_models/json_transformer_options.py index 26b310204b9..dc00e759691 100644 --- a/python/databricks/bundles/pipelines/_models/json_transformer_options.py +++ b/python/databricks/bundles/pipelines/_models/json_transformer_options.py @@ -21,11 +21,15 @@ class JsonTransformerOptions: as_variant: VariableOrOptional[bool] = None """ + :meta private: [EXPERIMENTAL] + Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Inline schema string for JSON parsing (Spark DDL format). """ @@ -33,16 +37,22 @@ class JsonTransformerOptions: FileIngestionOptionsSchemaEvolutionMode ] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ @@ -59,11 +69,15 @@ class JsonTransformerOptionsDict(TypedDict, total=False): as_variant: VariableOrOptional[bool] """ + :meta private: [EXPERIMENTAL] + Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Inline schema string for JSON parsing (Spark DDL format). """ @@ -71,16 +85,22 @@ class JsonTransformerOptionsDict(TypedDict, total=False): FileIngestionOptionsSchemaEvolutionModeParam ] """ + :meta private: [EXPERIMENTAL] + (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ diff --git a/python/databricks/bundles/pipelines/_models/kafka_options.py b/python/databricks/bundles/pipelines/_models/kafka_options.py index 0b83708ee3a..9a33e5e1e3d 100644 --- a/python/databricks/bundles/pipelines/_models/kafka_options.py +++ b/python/databricks/bundles/pipelines/_models/kafka_options.py @@ -34,6 +34,8 @@ class KafkaOptions: key_transformer: VariableOrOptional[Transformer] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -47,24 +49,32 @@ class KafkaOptions: starting_offset: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ topic_pattern: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ topics: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ value_transformer: VariableOrOptional[Transformer] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ @@ -91,6 +101,8 @@ class KafkaOptionsDict(TypedDict, total=False): key_transformer: VariableOrOptional[TransformerParam] """ + :meta private: [EXPERIMENTAL] + (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -104,24 +116,32 @@ class KafkaOptionsDict(TypedDict, total=False): starting_offset: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ topic_pattern: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ topics: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ value_transformer: VariableOrOptional[TransformerParam] """ + :meta private: [EXPERIMENTAL] + (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ diff --git a/python/databricks/bundles/pipelines/_models/outlook_options.py b/python/databricks/bundles/pipelines/_models/outlook_options.py index 62138c598f8..5d88963498b 100644 --- a/python/databricks/bundles/pipelines/_models/outlook_options.py +++ b/python/databricks/bundles/pipelines/_models/outlook_options.py @@ -27,24 +27,25 @@ class OutlookOptions: attachment_mode: VariableOrOptional[OutlookAttachmentMode] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ body_format: VariableOrOptional[OutlookBodyFormat] = None """ + :meta private: [EXPERIMENTAL] + (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. - """ - include_folders: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder @@ -53,6 +54,8 @@ class OutlookOptions: include_mailboxes: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (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. @@ -60,6 +63,8 @@ class OutlookOptions: include_senders: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (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. @@ -68,6 +73,8 @@ class OutlookOptions: include_subjects: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (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*" @@ -75,24 +82,16 @@ class OutlookOptions: Filter semantics: OR between different subjects. """ - sender_filter: VariableOrList[str] = field(default_factory=list) - """ - [DEPRECATED] Deprecated. Use include_senders instead. - """ - start_date: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (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. """ - subject_filter: VariableOrList[str] = field(default_factory=list) - """ - [DEPRECATED] Deprecated. Use include_subjects instead. - """ - @classmethod def from_dict(cls, value: "OutlookOptionsDict") -> "Self": return _transform(cls, value) @@ -106,24 +105,25 @@ class OutlookOptionsDict(TypedDict, total=False): attachment_mode: VariableOrOptional[OutlookAttachmentModeParam] """ + :meta private: [EXPERIMENTAL] + (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ body_format: VariableOrOptional[OutlookBodyFormatParam] """ + :meta private: [EXPERIMENTAL] + (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. - """ - include_folders: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder @@ -132,6 +132,8 @@ class OutlookOptionsDict(TypedDict, total=False): include_mailboxes: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (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. @@ -139,6 +141,8 @@ class OutlookOptionsDict(TypedDict, total=False): include_senders: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (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. @@ -147,6 +151,8 @@ class OutlookOptionsDict(TypedDict, total=False): include_subjects: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (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*" @@ -154,23 +160,15 @@ class OutlookOptionsDict(TypedDict, total=False): Filter semantics: OR between different subjects. """ - sender_filter: VariableOrList[str] - """ - [DEPRECATED] Deprecated. Use include_senders instead. - """ - start_date: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (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. """ - subject_filter: VariableOrList[str] - """ - [DEPRECATED] Deprecated. Use include_subjects instead. - """ - OutlookOptionsParam = OutlookOptionsDict | OutlookOptions diff --git a/python/databricks/bundles/pipelines/_models/restart_window.py b/python/databricks/bundles/pipelines/_models/restart_window.py index 2385a32c7ab..b148614499e 100644 --- a/python/databricks/bundles/pipelines/_models/restart_window.py +++ b/python/databricks/bundles/pipelines/_models/restart_window.py @@ -22,18 +22,24 @@ class RestartWindow: start_hour: VariableOr[int] """ + :meta private: [EXPERIMENTAL] + 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) """ + :meta private: [EXPERIMENTAL] + 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 """ + :meta private: [EXPERIMENTAL] + Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ @@ -51,18 +57,24 @@ class RestartWindowDict(TypedDict, total=False): start_hour: VariableOr[int] """ + :meta private: [EXPERIMENTAL] + 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] """ + :meta private: [EXPERIMENTAL] + 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] """ + :meta private: [EXPERIMENTAL] + Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ diff --git a/python/databricks/bundles/pipelines/_models/sharepoint_options.py b/python/databricks/bundles/pipelines/_models/sharepoint_options.py index 72fe41e11e1..8bf678ab886 100644 --- a/python/databricks/bundles/pipelines/_models/sharepoint_options.py +++ b/python/databricks/bundles/pipelines/_models/sharepoint_options.py @@ -25,17 +25,23 @@ class SharepointOptions: entity_type: VariableOrOptional[SharepointOptionsSharepointEntityType] = None """ + :meta private: [EXPERIMENTAL] + (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None """ + :meta private: [EXPERIMENTAL] + (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + Required. The SharePoint URL. """ @@ -52,17 +58,23 @@ class SharepointOptionsDict(TypedDict, total=False): entity_type: VariableOrOptional[SharepointOptionsSharepointEntityTypeParam] """ + :meta private: [EXPERIMENTAL] + (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] """ + :meta private: [EXPERIMENTAL] + (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + Required. The SharePoint URL. """ diff --git a/python/databricks/bundles/pipelines/_models/smartsheet_options.py b/python/databricks/bundles/pipelines/_models/smartsheet_options.py index 4f4426b74ed..061bf1e6000 100644 --- a/python/databricks/bundles/pipelines/_models/smartsheet_options.py +++ b/python/databricks/bundles/pipelines/_models/smartsheet_options.py @@ -19,6 +19,8 @@ class SmartsheetOptions: enforce_schema: VariableOrOptional[bool] = None """ + :meta private: [EXPERIMENTAL] + (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 @@ -39,6 +41,8 @@ class SmartsheetOptionsDict(TypedDict, total=False): enforce_schema: VariableOrOptional[bool] """ + :meta private: [EXPERIMENTAL] + (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 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..d37064947a1 100644 --- a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py @@ -27,12 +27,16 @@ class TikTokAdsOptions: data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevel] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ dimensions: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (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. @@ -40,6 +44,8 @@ class TikTokAdsOptions: lookback_window_days: VariableOrOptional[int] = None """ + :meta private: [EXPERIMENTAL] + (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. @@ -47,6 +53,8 @@ class TikTokAdsOptions: metrics: VariableOrList[str] = field(default_factory=list) """ + :meta private: [EXPERIMENTAL] + (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) @@ -54,6 +62,8 @@ class TikTokAdsOptions: query_lifetime: VariableOrOptional[bool] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. @@ -61,12 +71,16 @@ class TikTokAdsOptions: report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportType] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ sync_start_date: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (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 @@ -86,12 +100,16 @@ class TikTokAdsOptionsDict(TypedDict, total=False): data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevelParam] """ + :meta private: [EXPERIMENTAL] + (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ dimensions: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (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. @@ -99,6 +117,8 @@ class TikTokAdsOptionsDict(TypedDict, total=False): lookback_window_days: VariableOrOptional[int] """ + :meta private: [EXPERIMENTAL] + (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. @@ -106,6 +126,8 @@ class TikTokAdsOptionsDict(TypedDict, total=False): metrics: VariableOrList[str] """ + :meta private: [EXPERIMENTAL] + (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) @@ -113,6 +135,8 @@ class TikTokAdsOptionsDict(TypedDict, total=False): query_lifetime: VariableOrOptional[bool] """ + :meta private: [EXPERIMENTAL] + (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. @@ -120,12 +144,16 @@ class TikTokAdsOptionsDict(TypedDict, total=False): report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportTypeParam] """ + :meta private: [EXPERIMENTAL] + (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ sync_start_date: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (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 diff --git a/python/databricks/bundles/pipelines/_models/transformer.py b/python/databricks/bundles/pipelines/_models/transformer.py index b707307fbbc..53c2a05eeca 100644 --- a/python/databricks/bundles/pipelines/_models/transformer.py +++ b/python/databricks/bundles/pipelines/_models/transformer.py @@ -27,10 +27,15 @@ class Transformer: format: VariableOrOptional[TransformerFormat] = None """ + :meta private: [EXPERIMENTAL] + Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptions] = None + """ + :meta private: [EXPERIMENTAL] + """ @classmethod def from_dict(cls, value: "TransformerDict") -> "Self": @@ -45,10 +50,15 @@ class TransformerDict(TypedDict, total=False): format: VariableOrOptional[TransformerFormatParam] """ + :meta private: [EXPERIMENTAL] + Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptionsParam] + """ + :meta private: [EXPERIMENTAL] + """ TransformerParam = TransformerDict | Transformer diff --git a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py index a64ecf73f2f..2a4e85f02f4 100644 --- a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py +++ b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py @@ -19,6 +19,8 @@ class ZendeskSupportOptions: start_date: VariableOrOptional[str] = None """ + :meta private: [EXPERIMENTAL] + (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """ @@ -36,6 +38,8 @@ class ZendeskSupportOptionsDict(TypedDict, total=False): start_date: VariableOrOptional[str] """ + :meta private: [EXPERIMENTAL] + (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """ From bddbd3c79a89b3ef9b85250a9d4ecea508880f8d Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 22:06:16 +0200 Subject: [PATCH 07/11] bundle/internal/schema: drop dead mapIncorrectTypNames The cli_v1 producer emits go_v0 package.PascalName schema keys that match the Go SDK type names directly (e.g. serving.OpenAiConfig), so the Go-name-to-spec-name fixup is never reached. Regenerating the annotations, json schemas, and docs is byte-identical with it removed. Co-authored-by: Isaac --- bundle/internal/schema/parser.go | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index cae5e5ed776..6fe3e036205 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -75,13 +75,8 @@ func (p *annotationParser) findRef(typ reflect.Type) (cliJSONSchema, bool) { k := fmt.Sprintf("%s.%s", pkgName, ctyp.Name()) // Skip if the type is not in the spec. - _, ok := p.ref[k] - if !ok { - k = mapIncorrectTypNames(k) - _, ok = p.ref[k] - if !ok { - continue - } + if _, ok := p.ref[k]; !ok { + continue } // Return the first Go SDK type found in the spec. @@ -91,23 +86,6 @@ func (p *annotationParser) findRef(typ reflect.Type) (cliJSONSchema, bool) { return cliJSONSchema{}, false } -// Fix inconsistent type names between the Go SDK and the spec. -// E.g. "serving.PaLmConfig" in the Go SDK is "serving.PaLMConfig" in the spec. -func mapIncorrectTypNames(ref string) string { - switch ref { - case "serving.PaLmConfig": - return "serving.PaLMConfig" - case "serving.OpenAiConfig": - return "serving.OpenAIConfig" - case "serving.GoogleCloudVertexAiConfig": - return "serving.GoogleCloudVertexAIConfig" - case "serving.Ai21LabsConfig": - return "serving.AI21LabsConfig" - default: - return ref - } -} - // previewFromLaunchStage maps a launch stage to the preview marker the bundle // uses to hide a field or type from completions. cli.json no longer carries a // separate preview flag — launch_stage is the single source of truth — so a From ea21ed66903699cc9da14eb135ea4b01359a37a3 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Tue, 9 Jun 2026 22:14:33 +0200 Subject: [PATCH 08/11] Taskfile: minimize diff vs origin/main - drop the .codegen/cli.json entry from the test-task sources; cli.json changes are already covered by the dedicated cli.json/cligen tasks - restore the "Generating CLI code..." echo to match origin/main Co-authored-by: Isaac --- Taskfile.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index 9309ba577d6..b3f44aa0bd3 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -400,8 +400,6 @@ tasks: # internal/build reads these at test time. - NOTICE - .codegen/_openapi_sha - # internal/cligen TestCliJSONIsInterpretable reads the committed cli.json. - - .codegen/cli.json # bundle/internal/schema TestRequiredAnnotationsForNewFields reads these. - bundle/internal/schema/annotations*.yml generates: @@ -774,7 +772,7 @@ tasks: cmds: - echo "Building genkit..." - cd {{.UNIVERSE_DIR}} && ./tools/bazel build //openapi/genkit - - echo "Generating cli.json..." + - echo "Generating CLI code..." - '{{.UNIVERSE_DIR}}/bazel-bin/openapi/genkit/genkit_/genkit update-sdk --dir {{.ROOT_DIR}}' - git checkout -- .gitattributes - go test -timeout 240s -run TestConsistentDatabricksSdkVersion github.com/databricks/cli/internal/build From 6140ac37ae8cc5b328236e5f2c795a0ecc297acc Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Wed, 10 Jun 2026 08:53:43 +0200 Subject: [PATCH 09/11] Surface field launch stage in the bundle schema from cli.json Read launch_stage, enum_launch_stages and enum_descriptions from the checked-in .codegen/cli.json and surface them in the generated bundle schema, docs and Python models: - Prefix field descriptions with [Public Preview] / [Beta] / [Private Preview] so the stage shows in editor hover tooltips and the generated docstrings. - Emit the parallel enumDescriptions array so VSCode renders a per-value stage label and description in autocomplete dropdowns. - Carry the raw x-databricks-launch-stage alongside the existing x-databricks-preview, and hide PRIVATE_PREVIEW fields via doNotSuggest. PreviewTag lives in bundle/internal/annotation as the single source of truth shared by the schema and docs generators. The PUBLIC_BETA label is "[Beta]" to match Databricks public documentation. cli.json is filtered upstream at min-stage=PRIVATE_PREVIEW, so no DEVELOPMENT surface reaches the extractor and launch_stage is already clean (GA plus the three preview stages). The OpenAPI-spec-based DEVELOPMENT filtering and preview normalization the earlier version carried are no longer needed. assignAnnotation flags an open question (in a comment) on whether either x-databricks-preview or x-databricks-launch-stage is consumed downstream of the published schema, pending confirmation with the team. Regenerated jsonschema.json, jsonschema_for_docs.json, annotations_openapi.yml, the bundle docs and the Python (pydabs) models. Co-authored-by: Isaac --- bundle/docsgen/main.go | 14 + bundle/docsgen/output/reference.md | 2 +- bundle/docsgen/output/resources.md | 668 +++--- bundle/internal/annotation/descriptor.go | 21 +- bundle/internal/annotation/preview.go | 17 + bundle/internal/annotation/preview_test.go | 25 + bundle/internal/schema/annotations.go | 96 + .../internal/schema/annotations_openapi.yml | 1364 ++++++++++++- bundle/internal/schema/annotations_test.go | 120 ++ bundle/internal/schema/cli_json.go | 16 +- bundle/internal/schema/parser.go | 53 +- bundle/internal/schema/parser_test.go | 67 + bundle/schema/jsonschema.json | 1802 ++++++++++++----- bundle/schema/jsonschema_for_docs.json | 1368 ++++++++++--- libs/jsonschema/extension.go | 11 + .../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 | 32 +- 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/pipeline_params.py | 16 +- .../bundles/jobs/_models/pipeline_task.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 +- .../jobs/_models/python_operator_task.py | 8 +- .../_models/python_operator_task_parameter.py | 8 + .../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 | 44 +- .../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 | 12 +- .../pipelines/_models/ingestion_config.py | 12 +- .../ingestion_gateway_pipeline_definition.py | 20 +- .../_models/ingestion_pipeline_definition.py | 40 +- ...fic_config_query_based_connector_config.py | 12 +- ...ne_definition_workday_report_parameters.py | 4 +- .../_models/jira_connector_options.py | 4 +- .../_models/json_transformer_options.py | 20 +- .../pipelines/_models/kafka_options.py | 28 +- .../_models/meta_marketing_options.py | 32 +- .../_models/operation_time_window.py | 12 +- .../pipelines/_models/outlook_options.py | 28 +- .../bundles/pipelines/_models/path_pattern.py | 4 +- .../bundles/pipelines/_models/pipeline.py | 34 +- .../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 +- .../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 +- .../bundles/pipelines/_models/transformer.py | 8 +- .../_models/zendesk_support_options.py | 4 +- 79 files changed, 4959 insertions(+), 1603 deletions(-) create mode 100644 bundle/internal/annotation/preview.go create mode 100644 bundle/internal/annotation/preview_test.go create mode 100644 bundle/internal/schema/parser_test.go diff --git a/bundle/docsgen/main.go b/bundle/docsgen/main.go index c06811ebbdd..44cf5cc2ec7 100644 --- a/bundle/docsgen/main.go +++ b/bundle/docsgen/main.go @@ -143,9 +143,23 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.DoNotSuggest = true s.Preview = a.Preview } + if a.LaunchStage != "" { + s.LaunchStage = a.LaunchStage + if a.LaunchStage == "PRIVATE_PREVIEW" { + s.DoNotSuggest = true + } + } if a.OutputOnly != nil && *a.OutputOnly { s.DoNotSuggest = true } + + if tag := annotation.PreviewTag(a.LaunchStage); tag != "" { + if s.Description != "" { + s.Description = tag + " " + s.Description + } else { + s.Description = tag + } + } } func fillTemplateVariables(s string) string { diff --git a/bundle/docsgen/output/reference.md b/bundle/docsgen/output/reference.md index 812ad3e4fdb..00a55c6d491 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-09 + date: 2026-06-10 --- diff --git a/bundle/docsgen/output/resources.md b/bundle/docsgen/output/resources.md index e4015eb6d92..d106fb7ff7e 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-09 + date: 2026-06-10 --- @@ -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_size` - String @@ -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] ::: @@ -1099,7 +1099,7 @@ Resources for the app. **`Type: Sequence`** - +[Public Preview] @@ -2407,15 +2407,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 @@ -2423,7 +2423,7 @@ database_catalogs: - - `name` - String - - The name of the catalog in UC. + - [Public Preview] The name of the catalog in UC. ::: @@ -2470,19 +2470,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). + - [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 @@ -2490,15 +2490,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 @@ -2506,15 +2506,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. + - [Beta] The desired usage policy to associate with the instance. ::: @@ -2523,7 +2523,7 @@ database_instances: **`Type: Sequence`** -Custom tags associated with the instance. This field is only included on create and update responses. +[Beta] Custom tags associated with the instance. This field is only included on create and update responses. @@ -2535,11 +2535,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. ::: @@ -2569,7 +2569,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. @@ -2584,15 +2584,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. ::: @@ -3142,7 +3142,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 @@ -3346,7 +3346,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 @@ -3415,7 +3415,7 @@ In this minimal environment spec, only pip and java dependencies are supported. - - `java_dependencies` - Sequence - - + - [Public Preview] ::: @@ -4594,7 +4594,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 Preview] 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 @@ -4602,7 +4602,7 @@ Read endpoints return only 100 tasks. If more than 100 tasks are available, you - - `compute` - Map - - Task level compute configuration. See [\_](#jobsnametaskscompute). + - [Beta] Task level compute configuration. See [\_](#jobsnametaskscompute). - - `condition_task` - Map @@ -4686,7 +4686,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 @@ -4739,7 +4739,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 Preview] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. @@ -4752,19 +4752,19 @@ when the `alert_task` field is present. - - `alert_id` - String - - The alert_id is the canonical identifier of the alert. + - [Public Preview] 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 Preview] 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 Preview] 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 Preview] The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. ::: @@ -4773,7 +4773,7 @@ when the `alert_task` field is present. **`Type: Sequence`** -The subscribers receive alert evaluation result notifications after the alert task is completed. +[Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. @@ -4786,11 +4786,11 @@ The number of subscriptions is limited to 100. - - `destination_id` - String - - + - [Public Preview] - - `user_name` - String - - A valid workspace email address. + - [Public Preview] A valid workspace email address. ::: @@ -4833,7 +4833,7 @@ when the `clean_rooms_notebook_task` field is present. **`Type: Map`** -Task level compute configuration. +[Beta] Task level compute configuration. @@ -4845,7 +4845,7 @@ Task level compute configuration. - - `hardware_accelerator` - String - - Hardware accelerator configuration for Serverless GPU workloads. + - [Beta] Hardware accelerator configuration for Serverless GPU workloads. ::: @@ -5066,7 +5066,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 @@ -6172,11 +6172,11 @@ The task triggers a pipeline update when the `pipeline_task` field is present. O - - `full_refresh_selection` - Sequence - - A list of tables to update with fullRefresh. + - [Beta] A list of tables to update with fullRefresh. - - `parameters` - Map - - Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. + - [Beta] Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. - - `pipeline_id` - String @@ -6184,15 +6184,15 @@ The task triggers a pipeline update when the `pipeline_task` field is present. O - - `refresh_flow_selection` - Sequence - - Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + - [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. - - `refresh_selection` - Sequence - - A list of tables to update without fullRefresh. + - [Beta] A list of tables to update without fullRefresh. - - `reset_checkpoint_selection` - Sequence - - A list of streaming flows to reset checkpoints without clearing data. + - [Beta] A list of streaming flows to reset checkpoints without clearing data. ::: @@ -6201,7 +6201,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. @@ -6213,23 +6213,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 ::: @@ -6238,7 +6238,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 @@ -6250,23 +6250,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 ::: @@ -6275,7 +6275,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 @@ -6287,19 +6287,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 ::: @@ -6386,19 +6386,19 @@ Controls whether the pipeline should perform a full refresh - - `full_refresh_selection` - Sequence - - A list of tables to update with fullRefresh. + - [Beta] A list of tables to update with fullRefresh. - - `refresh_flow_selection` - Sequence - - Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + - [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. - - `refresh_selection` - Sequence - - A list of tables to update without fullRefresh. + - [Beta] A list of tables to update without fullRefresh. - - `reset_checkpoint_selection` - Sequence - - A list of streaming flows to reset checkpoints without clearing data. + - [Beta] A list of streaming flows to reset checkpoints without clearing data. ::: @@ -6692,7 +6692,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 @@ -6768,7 +6768,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. @@ -6957,7 +6957,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 @@ -7033,7 +7033,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. @@ -7184,7 +7184,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 @@ -7227,7 +7227,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. @@ -7239,11 +7239,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). ::: @@ -7252,7 +7252,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. @@ -7268,11 +7268,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 @@ -7285,7 +7285,7 @@ Configuration for input guardrail filters. **`Type: Map`** -Configuration for guardrail PII filter. +[Public Preview] Configuration for guardrail PII filter. @@ -7297,7 +7297,7 @@ Configuration for guardrail PII filter. - - `behavior` - String - - Configuration for input guardrail filters. + - [Public Preview] Configuration for input guardrail filters. ::: @@ -7306,7 +7306,7 @@ Configuration for guardrail PII filter. **`Type: Map`** -Configuration for output guardrail filters. +[Public Preview] Configuration for output guardrail filters. @@ -7322,11 +7322,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 @@ -7339,7 +7339,7 @@ Configuration for output guardrail filters. **`Type: Map`** -Configuration for guardrail PII filter. +[Public Preview] Configuration for guardrail PII filter. @@ -7351,7 +7351,7 @@ Configuration for guardrail PII filter. - - `behavior` - String - - Configuration for input guardrail filters. + - [Public Preview] Configuration for input guardrail filters. ::: @@ -7498,7 +7498,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 @@ -7518,7 +7518,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 @@ -7542,7 +7542,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 @@ -7997,7 +7997,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 @@ -8005,7 +8005,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 @@ -8037,7 +8037,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 @@ -8354,7 +8354,7 @@ pipelines: - - `budget_policy_id` - String - - Budget policy of this pipeline. + - [Public Preview] Budget policy of this pipeline. - - `catalog` - String @@ -8394,7 +8394,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 @@ -8410,7 +8410,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 @@ -8430,7 +8430,7 @@ pipelines: - - `parameters` - Map - - + - [Beta] - - `permissions` - Sequence @@ -8442,7 +8442,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 @@ -9139,7 +9139,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. @@ -9151,7 +9151,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), ::: @@ -9214,7 +9214,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. @@ -9226,39 +9226,39 @@ 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. - - `connector_type` - String - - (Optional) Connector Type for sources. Ex: CDC, Query Based. + - [Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based. - - `data_staging_options` - Map - - (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. See [\_](#pipelinesnameingestion_definitiondata_staging_options). + - [Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. See [\_](#pipelinesnameingestion_definitiondata_staging_options). - - `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). ::: @@ -9267,7 +9267,7 @@ The configuration for a managed ingestion pipeline. These settings cannot be use **`Type: Map`** -(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline +[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. @@ -9282,15 +9282,15 @@ top level pipeline definition. - - `catalog_name` - String - - (Required, Immutable) The name of the catalog for the connector's staging storage location. + - [Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location. - - `schema_name` - String - - (Required, Immutable) The name of the schema for the connector's staging storage location. + - [Beta] (Required, Immutable) The name of the schema for the connector's staging storage location. - - `volume_name` - String - - (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 : __databricks_ingestion_gateway_staging_data-$pipelineId + - [Beta] (Optional) The Unity Catalog-compatible name for the storage location. This is the volume to use for the data that is extracted by the connector. Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : __databricks_ingestion_gateway_staging_data-$pipelineId ::: @@ -9299,7 +9299,7 @@ top level pipeline definition. **`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. @@ -9311,15 +9311,15 @@ top level pipeline definition. - - `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. ::: @@ -9328,7 +9328,7 @@ top level pipeline definition. **`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. @@ -9336,7 +9336,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. @@ -9348,15 +9348,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). ::: @@ -9365,7 +9365,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. @@ -9377,23 +9377,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). ::: @@ -9402,7 +9402,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. @@ -9414,35 +9414,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. ::: @@ -9451,7 +9451,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, @@ -9473,11 +9473,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. ::: @@ -9486,7 +9486,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. @@ -9498,15 +9498,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. + - [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. ::: @@ -9515,7 +9515,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. @@ -9527,27 +9527,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). ::: @@ -9556,7 +9556,7 @@ Select all tables from a specific source schema. **`Type: Map`** -(Optional) Source Specific Connector Options +[Public Preview] (Optional) Source Specific Connector Options @@ -9568,15 +9568,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). + - [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). + - [Beta] Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsmeta_ads_options). ::: @@ -9585,7 +9585,7 @@ Select all tables from a specific source schema. **`Type: Map`** -Confluence specific options for ingestion +[Public Preview] Confluence specific options for ingestion @@ -9597,7 +9597,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 ::: @@ -9606,7 +9606,7 @@ Confluence specific options for ingestion **`Type: Map`** -Jira specific options for ingestion +[Beta] Jira specific options for ingestion @@ -9618,7 +9618,7 @@ Jira specific options for ingestion - - `include_jira_spaces` - Sequence - - (Optional) Projects to filter Jira data on + - [Beta] (Optional) Projects to filter Jira data on ::: @@ -9627,7 +9627,7 @@ Jira specific options for ingestion **`Type: Map`** -Meta Marketing (Meta Ads) specific options for ingestion +[Beta] Meta Marketing (Meta Ads) specific options for ingestion @@ -9639,35 +9639,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") + - [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 + - [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) + - [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) - - `breakdowns` - Sequence - - (Optional) Breakdowns to configure for data aggregation + - [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. + - [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) + - [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 + - [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) + - [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) ::: @@ -9676,7 +9676,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. @@ -9688,35 +9688,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. ::: @@ -9725,7 +9725,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, @@ -9747,11 +9747,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. ::: @@ -9760,7 +9760,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. @@ -9772,15 +9772,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. + - [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. ::: @@ -9789,7 +9789,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. @@ -9801,35 +9801,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). ::: @@ -9838,7 +9838,7 @@ Select a specific source table. **`Type: Map`** -(Optional) Source Specific Connector Options +[Public Preview] (Optional) Source Specific Connector Options @@ -9850,15 +9850,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). + - [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). + - [Beta] Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsmeta_ads_options). ::: @@ -9867,7 +9867,7 @@ Select a specific source table. **`Type: Map`** -Confluence specific options for ingestion +[Public Preview] Confluence specific options for ingestion @@ -9879,7 +9879,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 ::: @@ -9888,7 +9888,7 @@ Confluence specific options for ingestion **`Type: Map`** -Jira specific options for ingestion +[Beta] Jira specific options for ingestion @@ -9900,7 +9900,7 @@ Jira specific options for ingestion - - `include_jira_spaces` - Sequence - - (Optional) Projects to filter Jira data on + - [Beta] (Optional) Projects to filter Jira data on ::: @@ -9909,7 +9909,7 @@ Jira specific options for ingestion **`Type: Map`** -Meta Marketing (Meta Ads) specific options for ingestion +[Beta] Meta Marketing (Meta Ads) specific options for ingestion @@ -9921,35 +9921,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") + - [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 + - [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) + - [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) - - `breakdowns` - Sequence - - (Optional) Breakdowns to configure for data aggregation + - [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. + - [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) + - [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 + - [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) + - [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) ::: @@ -9958,7 +9958,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. @@ -9970,35 +9970,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. ::: @@ -10007,7 +10007,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, @@ -10029,11 +10029,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. ::: @@ -10042,7 +10042,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. @@ -10054,15 +10054,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. + - [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. ::: @@ -10071,7 +10071,7 @@ Configurations that are only applicable for query-based ingestion connectors. **`Type: Sequence`** -Top-level source configurations +[Public Preview] Top-level source configurations @@ -10083,7 +10083,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). ::: @@ -10092,7 +10092,7 @@ Top-level source configurations **`Type: Map`** -Catalog-level source configuration parameters +[Public Preview] Catalog-level source configuration parameters @@ -10104,11 +10104,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 ::: @@ -10117,7 +10117,7 @@ Catalog-level source configuration parameters **`Type: Map`** -Postgres-specific catalog-level configuration parameters +[Public Preview] Postgres-specific catalog-level configuration parameters @@ -10129,7 +10129,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). ::: @@ -10138,7 +10138,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 @@ -10150,11 +10150,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 ::: @@ -10163,7 +10163,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. @@ -10175,35 +10175,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. ::: @@ -10212,7 +10212,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, @@ -10234,11 +10234,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. ::: @@ -10247,7 +10247,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. @@ -10259,15 +10259,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. + - [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. ::: @@ -10292,7 +10292,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 @@ -10330,7 +10330,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`. @@ -10344,7 +10344,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 ::: @@ -10712,15 +10712,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. + - [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. + - [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. + - [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. ::: @@ -10762,7 +10762,7 @@ A collection of settings for a compute endpoint. - - `pg_settings` - Map - - A raw representation of Postgres settings. + - [Beta] A raw representation of Postgres settings. ::: @@ -10853,11 +10853,11 @@ postgres_projects: - - `key` - String - - The key of the custom tag. + - [Beta] The key of the custom tag. - - `value` - String - - The value of the custom tag. + - [Beta] The value of the custom tag. ::: @@ -10878,23 +10878,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. + - [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. + - [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. + - [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. + - [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. + - [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. ::: @@ -11056,15 +11056,15 @@ postgres_synced_tables: - - `budget_policy_id` - String - - Budget policy to set on the newly created pipeline. + - [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. + - [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. + - [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. ::: @@ -12083,7 +12083,7 @@ synced_database_tables: - - `database_instance_name` - String - - + - [Public Preview] - - `lifecycle` - Map @@ -12091,15 +12091,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). ::: @@ -12129,7 +12129,7 @@ synced_database_tables: **`Type: Map`** -Specification of a synced database table. +[Public Preview] @@ -12141,31 +12141,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. ::: @@ -12174,7 +12174,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 @@ -12191,15 +12191,15 @@ only requires read permissions. - - `budget_policy_id` - String - - Budget policy to set on the newly created pipeline. + - [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. ::: @@ -12225,7 +12225,7 @@ vector_search_endpoints: - - `budget_policy_id` - String - - + - [Public Preview] - - `endpoint_type` - String @@ -12245,7 +12245,7 @@ vector_search_endpoints: - - `target_qps` - Integer - - + - [Public Preview] ::: @@ -12341,7 +12341,7 @@ vector_search_indexes: - - `index_subtype` - String - - The subtype of the AI Search index, determining the indexing and retrieval strategy. - `VECTOR`: Not supported. Use `HYBRID` instead. - `FULL_TEXT`: An index that uses full-text search without vector embeddings. - `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search. + - [Beta] - - `index_type` - String diff --git a/bundle/internal/annotation/descriptor.go b/bundle/internal/annotation/descriptor.go index 797746b0df8..be452a748b5 100644 --- a/bundle/internal/annotation/descriptor.go +++ b/bundle/internal/annotation/descriptor.go @@ -1,15 +1,18 @@ package annotation type Descriptor struct { - Description string `json:"description,omitempty"` - MarkdownDescription string `json:"markdown_description,omitempty"` - Title string `json:"title,omitempty"` - Default any `json:"default,omitempty"` - Enum []any `json:"enum,omitempty"` - MarkdownExamples string `json:"markdown_examples,omitempty"` - DeprecationMessage string `json:"deprecation_message,omitempty"` - Preview string `json:"x-databricks-preview,omitempty"` - OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` + Description string `json:"description,omitempty"` + MarkdownDescription string `json:"markdown_description,omitempty"` + Title string `json:"title,omitempty"` + Default any `json:"default,omitempty"` + Enum []any `json:"enum,omitempty"` + MarkdownExamples string `json:"markdown_examples,omitempty"` + DeprecationMessage string `json:"deprecation_message,omitempty"` + Preview string `json:"x-databricks-preview,omitempty"` + LaunchStage string `json:"x-databricks-launch-stage,omitempty"` + EnumLaunchStages map[string]string `json:"x-databricks-enum-launch-stages,omitempty"` + EnumDescriptions map[string]string `json:"x-databricks-enum-descriptions,omitempty"` + OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` } const Placeholder = "PLACEHOLDER" diff --git a/bundle/internal/annotation/preview.go b/bundle/internal/annotation/preview.go new file mode 100644 index 00000000000..5b06d4bf9d0 --- /dev/null +++ b/bundle/internal/annotation/preview.go @@ -0,0 +1,17 @@ +package annotation + +// PreviewTag returns the human-readable launch-stage prefix to prepend to a +// field's description. It is the single source of truth shared by the schema +// and docs generators. cli.json is filtered at min-stage=PRIVATE_PREVIEW +// upstream, so DEVELOPMENT never reaches here and GA yields no tag. +func PreviewTag(launchStage string) string { + switch launchStage { + case "PRIVATE_PREVIEW": + return "[Private Preview]" + case "PUBLIC_BETA": + return "[Beta]" + case "PUBLIC_PREVIEW": + return "[Public Preview]" + } + return "" +} diff --git a/bundle/internal/annotation/preview_test.go b/bundle/internal/annotation/preview_test.go new file mode 100644 index 00000000000..b6f5977cb4a --- /dev/null +++ b/bundle/internal/annotation/preview_test.go @@ -0,0 +1,25 @@ +package annotation_test + +import ( + "testing" + + "github.com/databricks/cli/bundle/internal/annotation" + "github.com/stretchr/testify/assert" +) + +func TestPreviewTag(t *testing.T) { + tests := []struct { + launchStage string + want string + }{ + {"PUBLIC_PREVIEW", "[Public Preview]"}, + {"PUBLIC_BETA", "[Beta]"}, + {"PRIVATE_PREVIEW", "[Private Preview]"}, + {"GA", ""}, + {"", ""}, + {"SOMETHING_ELSE", ""}, + } + for _, tc := range tests { + assert.Equal(t, tc.want, annotation.PreviewTag(tc.launchStage)) + } +} diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 2889fffe81c..3950c7897cd 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -139,6 +139,25 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.Preview = a.Preview } + // Surface the launch stage as the raw x-databricks-launch-stage field (and, + // below, as a human-readable prefix on the description). cli.json makes + // launch_stage the single source of truth: x-databricks-preview above is + // derivable from it (PRIVATE iff PRIVATE_PREVIEW) and is kept only for + // backwards compatibility, so PRIVATE_PREVIEW must hide the field here too. + // + // OPEN QUESTION (confirm with the team before finalizing this PR): is + // either x-databricks-preview or x-databricks-launch-stage consumed by + // anything downstream of the published schema? If x-databricks-preview is + // unused we can stop emitting it; if the raw x-databricks-launch-stage isn't + // wanted in the published schema, drop s.LaunchStage and keep only the + // description prefix below. + if a.LaunchStage != "" { + s.LaunchStage = a.LaunchStage + if a.LaunchStage == "PRIVATE_PREVIEW" { + s.DoNotSuggest = true + } + } + if a.OutputOnly != nil && *a.OutputOnly { s.FieldBehaviors = []string{"OUTPUT_ONLY"} } @@ -146,6 +165,83 @@ 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 + // consumers reading x-databricks-launch-stage. + if tag := annotation.PreviewTag(a.LaunchStage); tag != "" { + s.Description = prefixWithPreviewTag(s.Description, tag) + } +} + +// buildEnumDescriptions produces the parallel enumDescriptions array VSCode +// renders next to each enum value. Each entry combines the 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. The enum slice is the same +// one assigned to s.Enum, so the arrays stay index-aligned. +func buildEnumDescriptions(enum []any, launchStages, descriptions map[string]string) []string { + if len(enum) == 0 || (len(launchStages) == 0 && len(descriptions) == 0) { + return nil + } + result := make([]string, len(enum)) + hasContent := false + for i, v := range enum { + key, ok := v.(string) + if !ok { + continue + } + result[i] = 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 "" +} + +// prefixWithPreviewTag prepends the launch-stage tag to a description while +// guarding against double-tagging — if the description already starts with +// the tag, it is returned unchanged. +func prefixWithPreviewTag(description, tag string) string { + if description == "" { + return tag + } + if strings.HasPrefix(description, tag) { + return description + } + return tag + " " + description } func saveYamlWithStyle(outputPath string, annotations annotation.File) error { diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index dc2d93c357a..1c301cdc92f 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -5,15 +5,23 @@ github.com/databricks/cli/bundle/config/resources.Alert: The timestamp indicating when the alert was created. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_description": "description": |- Custom description for the alert. support mustache template. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_summary": "description": |- Custom summary for the alert. support mustache template. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "display_name": "description": |- The display name of the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_run_as": "description": |- The actual identity that will be used to execute the alert. @@ -21,28 +29,42 @@ github.com/databricks/cli/bundle/config/resources.Alert: permissions and defaults. "x-databricks-field-behaviors_output_only": |- true - "evaluation": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "evaluation": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "id": "description": |- UUID identifying the alert. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "lifecycle_state": "description": |- Indicates whether the query is trashed. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "owner_user_name": "description": |- The owner's username. This field is set to "Unavailable" if the user has been deleted. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "parent_path": "description": |- The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "query_text": "description": |- Text of the query to be run. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as": "description": |- Specifies the identity that will be used to run the alert. @@ -50,6 +72,8 @@ github.com/databricks/cli/bundle/config/resources.Alert: - For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email. - For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role. If not specified, the alert will run as the request user. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as_user_name": "description": |- The run as username or application ID of service principal. @@ -57,15 +81,23 @@ github.com/databricks/cli/bundle/config/resources.Alert: Deprecated: Use `run_as` field instead. This field will be removed in a future release. "deprecation_message": |- This field is deprecated - "schedule": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "schedule": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "update_time": "description": |- The timestamp indicating when the alert was updated. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- ID of the SQL warehouse attached to the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.App: "active_deployment": "description": |- @@ -76,15 +108,21 @@ github.com/databricks/cli/bundle/config/resources.App: "app_status": "x-databricks-field-behaviors_output_only": |- true - "budget_policy_id": {} + "budget_policy_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "compute_max_instances": "description": |- Maximum number of app instances. Must be set together with `compute_min_instances`. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "compute_min_instances": "description": |- Minimum number of app instances. Must be set together with `compute_max_instances`. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "compute_size": {} @@ -113,14 +151,20 @@ github.com/databricks/cli/bundle/config/resources.App: "effective_budget_policy_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_usage_policy_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_user_api_scopes": "description": |- The effective api scopes granted to the user access token. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "git_repository": "description": |- Git repository configuration for app deployments. When specified, deployments can @@ -137,9 +181,13 @@ github.com/databricks/cli/bundle/config/resources.App: "oauth2_app_client_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "oauth2_app_integration_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pending_deployment": "description": |- The pending deployment of the app. A deployment is considered pending when it is being prepared @@ -161,9 +209,13 @@ github.com/databricks/cli/bundle/config/resources.App: "space": "description": |- Name of the space this app belongs to. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE - "telemetry_export_destinations": {} + "telemetry_export_destinations": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "thumbnail_url": "description": |- The URL of the thumbnail image for the app. @@ -184,8 +236,12 @@ github.com/databricks/cli/bundle/config/resources.App: The URL of the app once it is deployed. "x-databricks-field-behaviors_output_only": |- true - "usage_policy_id": {} - "user_api_scopes": {} + "usage_policy_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "user_api_scopes": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.Catalog: "comment": "description": |- @@ -413,19 +469,29 @@ github.com/databricks/cli/bundle/config/resources.Cluster: "description": |- Cluster Attributes showing for clusters workload types. github.com/databricks/cli/bundle/config/resources.DatabaseCatalog: - "create_database_if_not_exists": {} + "create_database_if_not_exists": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_instance_name": "description": |- The name of the DatabaseInstance housing the database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_name": "description": |- The name of the database (in a instance) associated with the catalog. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The name of the catalog in UC. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.DatabaseInstance: "_": "description": |- @@ -433,25 +499,35 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: "capacity": "description": |- The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "child_instance_refs": "description": |- The refs of the child instances. This is only available if the instance is parent instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "creation_time": "description": |- The timestamp when the instance was created. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "creator": "description": |- The email of the creator of the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_tags": "description": |- Custom tags associated with the instance. This field is only included on create and update responses. + "x-databricks-launch-stage": |- + PUBLIC_BETA "effective_capacity": "description": |- Deprecated. The sku of the instance; this field will always match the value of capacity. @@ -461,6 +537,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: This field is deprecated "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_custom_tags": "description": |- The recorded custom tags associated with the instance. @@ -468,6 +546,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_BETA "effective_enable_pg_native_login": "description": |- Whether the instance has PG native password login enabled. @@ -475,6 +555,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_enable_readable_secondaries": "description": |- Whether secondaries serving read-only traffic are enabled. Defaults to false. @@ -482,6 +564,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_node_count": "description": |- The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to @@ -490,6 +574,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_retention_window_in_days": "description": |- The retention window for the instance. This is the time window in days @@ -498,6 +584,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_stopped": "description": |- Whether the instance is stopped. @@ -505,6 +593,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_usage_policy_id": "description": |- The policy that is applied to the instance. @@ -512,62 +602,90 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_BETA "enable_pg_native_login": "description": |- Whether to enable PG native password login on the instance. Defaults to false. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "enable_readable_secondaries": "description": |- Whether to enable secondaries to serve read-only traffic. Defaults to false. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The name of the instance. This is the unique identifier for the instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "node_count": "description": |- The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries. This field is input only, see effective_node_count for the output. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "parent_instance_ref": "description": |- The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pg_version": "description": |- The version of Postgres running on the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "read_only_dns": "description": |- The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "read_write_dns": "description": |- The DNS endpoint to connect to the instance for read+write access. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "retention_window_in_days": "description": |- The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "state": "description": |- The current state of the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "stopped": "description": |- Whether to stop the instance. An input only param, see effective_stopped for the output. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "description": |- An immutable UUID identifier for the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "usage_policy_id": "description": |- The desired usage policy to associate with the instance. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/cli/bundle/config/resources.ExternalLocation: "comment": "description": |- @@ -619,6 +737,8 @@ github.com/databricks/cli/bundle/config/resources.Job: The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "continuous": "description": |- An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used. @@ -714,6 +834,8 @@ github.com/databricks/cli/bundle/config/resources.Job: The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the usage policy used by this workload. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "webhook_notifications": @@ -779,6 +901,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "budget_policy_id": "description": |- Budget policy of this pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "catalog": "description": |- A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. @@ -807,6 +931,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "environment": "description": |- Environment specification for this pipeline used to install dependencies. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "event_log": "description": |- Event log configuration for this pipeline @@ -816,6 +942,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "gateway_definition": "description": |- The definition of a gateway pipeline to support change data capture. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "id": @@ -824,6 +952,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "ingestion_definition": "description": |- The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "libraries": "description": |- Libraries or code needed by this deployment. @@ -837,12 +967,16 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "description": |- Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + "x-databricks-launch-stage": |- + PUBLIC_BETA "photon": "description": |- Whether Photon is enabled for this pipeline. "restart_window": "description": |- Restart window of this pipeline. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "root_path": @@ -850,6 +984,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as": "description": |- Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline. @@ -882,6 +1018,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "usage_policy_id": "description": |- Usage policy of this pipeline. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/cli/bundle/config/resources.QualityMonitor: @@ -900,6 +1038,8 @@ github.com/databricks/cli/bundle/config/resources.QualityMonitor: "data_classification_config": "description": |- [Create:OPT Update:OPT] Data classification related config. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "inference_log": {} @@ -1096,12 +1236,16 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: Synced Table data synchronization status "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_instance_name": "description": |- Name of the target database instance. This is required when creating synced database tables in standard catalogs. This is optional when creating synced database tables in registered catalogs. If this field is specified when creating synced database tables in registered catalogs, the database instance name MUST match that of the registered catalog (or the request will be rejected). + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_database_instance_name": "description": |- The name of the database instance that this table is registered to. This field is always returned, and for @@ -1110,6 +1254,8 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_logical_database_name": "description": |- The name of the logical database that this table is registered to. @@ -1117,6 +1263,8 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "logical_database_name": "description": |- Target Postgres database object (logical database) name for this table. @@ -1129,12 +1277,18 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: When creating a synced table in a standard catalog, this field is required. In this scenario, specifying this field will allow targeting an arbitrary postgres database. Note that this has implications for the `create_database_objects_is_missing` field in `spec`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- Full three-part (catalog, schema, table) name of the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "spec": "description": |- Specification of a synced database table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "unity_catalog_provisioning_state": "description": |- The provisioning state of the synced table entity in Unity Catalog. This is distinct from the @@ -1142,10 +1296,14 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: may be in "PROVISIONING" as it runs asynchronously). "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: "budget_policy_id": "description": |- The budget policy id to be applied + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "endpoint_type": "description": |- Type of endpoint @@ -1157,9 +1315,13 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is calculated at index creation/sync time based on this value. Best-effort target; the system does not guarantee this QPS will be achieved. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "usage_policy_id": "description": |- The usage policy id to be applied once we've migrated to usage policies + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/cli/bundle/config/resources.VectorSearchIndex: @@ -1175,6 +1337,8 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchIndex: "index_subtype": "description": |- The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported. + "x-databricks-launch-stage": |- + PUBLIC_BETA "index_type": "description": |- There are 2 types of AI Search indexes: @@ -1527,6 +1691,8 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeStatus: to handle requests. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "message": @@ -1711,6 +1877,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificatio "enabled": "description": |- Whether to enable data classification. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination: @@ -1796,6 +1964,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications: "on_new_classification_tag_detected": "description": |- Destinations to send notifications on new classification tag detected. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot: @@ -2362,6 +2532,11 @@ github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType: CONFIDENTIAL_COMPUTE_TYPE_NONE - |- SEV_SNP + "x-databricks-enum-launch-stages": + "CONFIDENTIAL_COMPUTE_TYPE_NONE": |- + PRIVATE_PREVIEW + "SEV_SNP": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode: "_": "description": |- @@ -2405,6 +2580,25 @@ github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode: DATA_SECURITY_MODE_DEDICATED - |- DATA_SECURITY_MODE_AUTO + "x-databricks-enum-descriptions": + "DATA_SECURITY_MODE_AUTO": |- + will choose the most appropriate access mode depending on your compute configuration. + "DATA_SECURITY_MODE_DEDICATED": |- + A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + "DATA_SECURITY_MODE_STANDARD": |- + A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + "LEGACY_PASSTHROUGH": |- + This mode is for users migrating from legacy Passthrough on high concurrency clusters. + "LEGACY_SINGLE_USER": |- + This mode is for users migrating from legacy Passthrough on standard clusters. + "LEGACY_SINGLE_USER_STANDARD": |- + This mode provides a way that doesn’t have UC nor passthrough enabled. + "LEGACY_TABLE_ACL": |- + This mode is for users migrating from legacy Table ACL clusters. + "SINGLE_USER": |- + Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. + "USER_ISOLATION": |- + Legacy alias for `DATA_SECURITY_MODE_STANDARD`. github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo: "_": "description": |- @@ -2470,6 +2664,8 @@ github.com/databricks/databricks-sdk-go/service/compute.Environment: "java_dependencies": "description": |- List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: "_": "description": |- @@ -2486,6 +2682,8 @@ github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "first_on_demand": @@ -2554,6 +2752,11 @@ github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType: GPU_1xA10 - |- GPU_8xH100 + "x-databricks-enum-launch-stages": + "GPU_1xA10": |- + PUBLIC_BETA + "GPU_8xH100": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "_": "description": |- @@ -2763,9 +2966,13 @@ github.com/databricks/databricks-sdk-go/service/database.CustomTag: "key": "description": |- The key of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "value": "description": |- The value of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: "_": "description": |- @@ -2786,6 +2993,8 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_lsn": "description": |- For a parent ref instance, this is the LSN on the parent instance from which the @@ -2796,20 +3005,28 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "lsn": "description": |- User-specified WAL LSN of the ref database instance. Input: For specifying the WAL LSN to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- Name of the ref database instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "description": |- Id of the ref database instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: "_": "enum": @@ -2825,6 +3042,19 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: UPDATING - |- FAILING_OVER + "x-databricks-enum-launch-stages": + "AVAILABLE": |- + PUBLIC_PREVIEW + "DELETING": |- + PUBLIC_PREVIEW + "FAILING_OVER": |- + PUBLIC_PREVIEW + "STARTING": |- + PUBLIC_PREVIEW + "STOPPED": |- + PUBLIC_PREVIEW + "UPDATING": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DeltaTableSyncInfo: "delta_commit_timestamp": "description": |- @@ -2832,11 +3062,15 @@ github.com/databricks/databricks-sdk-go/service/database.DeltaTableSyncInfo: Note: This is the Delta commit time, not the time the data was written to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "delta_commit_version": "description": |- The Delta Lake commit version that was last successfully synced. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec: "_": "description": |- @@ -2845,18 +3079,24 @@ github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec: "budget_policy_id": "description": |- Budget policy to set on the newly created pipeline. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_catalog": "description": |- This field needs to be specified if the destination catalog is a managed postgres catalog. UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_schema": "description": |- This field needs to be specified if the destination catalog is a managed postgres catalog. UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.ProvisioningInfoState: "_": "enum": @@ -2872,6 +3112,19 @@ github.com/databricks/databricks-sdk-go/service/database.ProvisioningInfoState: UPDATING - |- DEGRADED + "x-databricks-enum-launch-stages": + "ACTIVE": |- + PUBLIC_PREVIEW + "DEGRADED": |- + PUBLIC_PREVIEW + "DELETING": |- + PUBLIC_PREVIEW + "FAILED": |- + PUBLIC_PREVIEW + "PROVISIONING": |- + PUBLIC_PREVIEW + "UPDATING": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.ProvisioningPhase: "_": "enum": @@ -2881,6 +3134,13 @@ github.com/databricks/databricks-sdk-go/service/database.ProvisioningPhase: PROVISIONING_PHASE_INDEX_SCAN - |- PROVISIONING_PHASE_INDEX_SORT + "x-databricks-enum-launch-stages": + "PROVISIONING_PHASE_INDEX_SCAN": |- + PUBLIC_PREVIEW + "PROVISIONING_PHASE_INDEX_SORT": |- + PUBLIC_PREVIEW + "PROVISIONING_PHASE_MAIN": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus: "_": "description": |- @@ -2891,17 +3151,23 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUp Progress of the initial data synchronization. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_processed_commit_version": "description": |- The last source table Delta version that was successfully synced to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus: "_": "description": |- @@ -2915,12 +3181,16 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus synced and available for serving. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. Only populated if the table is still synced and available for serving. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTablePipelineProgress: "_": "description": |- @@ -2930,42 +3200,58 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTablePipelineProg The estimated time remaining to complete this update in seconds. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "latest_version_currently_processing": "description": |- The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "provisioning_phase": "description": |- The current phase of the data synchronization pipeline. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_progress_completion": "description": |- The completion ratio of this update. This is a number between 0 and 1. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "synced_row_count": "description": |- The number of rows that have been synced in this update. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "total_row_count": "description": |- The total number of rows that need to be synced in this update. This number may be an estimate. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTablePosition: "delta_table_sync_info": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_end_timestamp": "description": |- The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_start_timestamp": "description": |- The starting timestamp of the most recent successful synchronization from the source table @@ -2974,6 +3260,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTablePosition: E.g., for a batch, this is the time when the sync operation started. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus: "_": "description": |- @@ -2985,6 +3273,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioning PROVISIONING_INITIAL_SNAPSHOT state. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy: "_": "enum": @@ -2994,6 +3284,13 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPo TRIGGERED - |- SNAPSHOT + "x-databricks-enum-launch-stages": + "CONTINUOUS": |- + PUBLIC_PREVIEW + "SNAPSHOT": |- + PUBLIC_PREVIEW + "TRIGGERED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: "_": "description": |- @@ -3002,6 +3299,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: "description": |- If true, the synced table's logical database and schema resources in PG will be created if they do not already exist. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "existing_pipeline_id": "description": |- At most one of existing_pipeline_id and new_pipeline_spec should be defined. @@ -3009,6 +3308,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: If existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline referenced. This avoids creating a new pipeline and allows sharing existing compute. In this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "new_pipeline_spec": "description": |- At most one of existing_pipeline_id and new_pipeline_spec should be defined. @@ -3017,18 +3318,28 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: to store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta tables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table only requires read permissions. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "primary_key_columns": "description": |- Primary Key columns to be used for data insert/update in the destination. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scheduling_policy": "description": |- Scheduling policy of the underlying pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_table_full_name": "description": |- Three-part (catalog, schema, table) name of the source Delta table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timeseries_key": "description": |- Time series key to deduplicate (tie-break) rows with the same primary key. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableState: "_": "description": |- @@ -3056,6 +3367,29 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableState: SYNCED_TABLE_ONLINE_PIPELINE_FAILED - |- SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES + "x-databricks-enum-launch-stages": + "SYNCED_TABLED_OFFLINE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_OFFLINE_FAILED": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_PIPELINE_FAILED": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: "_": "description": |- @@ -3064,15 +3398,21 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: "description": |- Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE or the SYNCED_UPDATING_PIPELINE_RESOURCES state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "detailed_state": "description": |- The state of the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "failed_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the SYNCED_PIPELINE_FAILED state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_sync": "description": |- Summary of the last successful synchronization from source to destination. @@ -3087,25 +3427,35 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: without having to traverse detailed_status. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "message": "description": |- A text description of the current state of the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pipeline_id": "description": |- ID of the associated pipeline. The pipeline ID may have been provided by the client (in the case of bin packing), or generated by the server (when creating a new pipeline). "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "provisioning_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "triggered_update_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE or the SYNCED_NO_PENDING_UPDATE state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus: "_": "description": |- @@ -3116,17 +3466,23 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpd The last source table Delta version that was successfully synced to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "triggered_update_progress": "description": |- Progress of the active data synchronization pipeline. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: "_": "description": |- @@ -3172,32 +3528,49 @@ github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: CAN_MONITOR_ONLY - |- CAN_CREATE_APP + "x-databricks-enum-launch-stages": + "CAN_CREATE_APP": |- + PRIVATE_PREVIEW + "CAN_MONITOR_ONLY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AlertTask: "alert_id": "description": |- The alert_id is the canonical identifier of the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "subscribers": "description": |- The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- The warehouse_id identifies the warehouse settings used by the alert task. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workspace_path": "description": |- The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber: "_": "description": |- Represents a subscriber that will receive alert notifications. A subscriber can be either a user (via email) or a notification destination (via destination_id). - "destination_id": {} + "destination_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "user_name": "description": |- A valid workspace email address. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: "_": "enum": @@ -3205,6 +3578,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: OAUTH - |- PAT + "x-databricks-enum-launch-stages": + "OAUTH": |- + PUBLIC_PREVIEW + "PAT": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask: "_": "description": |- @@ -3227,20 +3605,28 @@ github.com/databricks/databricks-sdk-go/service/jobs.Compute: "hardware_accelerator": "description": |- Hardware accelerator configuration for Serverless GPU workloads. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig: "gpu_node_pool_id": "description": |- IDof the GPU pool to use. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "gpu_type": "description": |- GPU type. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "num_gpus": "description": |- Number of GPUs. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Condition: @@ -3315,6 +3701,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask: - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) - For multi-select filters, provide a JSON array of values (e.g. `"[\"value1\",\"value2\"]"`) - For range and date range filters, provide a JSON object with `start` and `end` (e.g. `"{\"start\":\"1\",\"end\":\"10\"}"`) + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "subscription": @@ -3331,22 +3719,30 @@ github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask: "connection_resource_name": "description": |- The resource name of the UC connection that authenticates the dbt Cloud for this task + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dbt_cloud_job_id": "description": |- Id of the dbt Cloud job to be triggered + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask: "connection_resource_name": "description": |- The resource name of the UC connection that authenticates the dbt platform for this task + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dbt_platform_job_id": "description": |- Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtTask: @@ -3413,20 +3809,28 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: "command": "description": |- Command launcher to run the actual script, e.g. bash, python etc. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "compute": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dl_runtime_image": "description": |- Runtime image + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "mlflow_experiment_name": "description": |- Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "source": @@ -3435,22 +3839,30 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `GIT`: Script is located in cloud Git provider. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "training_script_path": "description": |- The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "yaml_parameters": "description": |- Optional string containing model parameters passed to the training script in yaml format. If present, then the content in yaml_parameters_file_path will be ignored. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "yaml_parameters_file_path": "description": |- Optional path to a YAML file containing model parameters passed to the training script. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.GitProvider: @@ -3510,6 +3922,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.GitSource: The source of the job specification in the remote repository when the job is source controlled. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sparse_checkout": {} @@ -3527,6 +3941,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: ID of the deployment that manages this job. Only set when `kind` is `BUNDLE`. Used to look up deployment metadata from the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "kind": @@ -3543,6 +3959,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: ID of the version of the deployment that produced this job. Only set when `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment in the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind: @@ -3555,6 +3973,14 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind: BUNDLE - |- SYSTEM_MANAGED + "x-databricks-enum-descriptions": + "BUNDLE": |- + The job is managed by Databricks Asset Bundle. + "SYSTEM_MANAGED": |- + The job is managed by and is read-only. + "x-databricks-enum-launch-stages": + "SYSTEM_MANAGED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.JobEditMode: "_": "description": |- @@ -3567,6 +3993,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobEditMode: UI_LOCKED - |- EDITABLE + "x-databricks-enum-descriptions": + "EDITABLE": |- + The job is in an editable state and can be modified. + "UI_LOCKED": |- + The job is in a locked UI state and cannot be modified. github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications: "no_alert_for_skipped_runs": "description": |- @@ -3588,6 +4019,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications: A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent. @@ -3635,6 +4068,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs: "group_name": "description": |- Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "service_principal_name": @@ -3654,16 +4089,22 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobSource: Possible values are: * `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced. * `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "import_from_git_branch": "description": |- Name of the branch which the job is imported from. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "job_config_path": "description": |- Path of the job YAML file that contains the job specification. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: @@ -3680,6 +4121,16 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: NOT_SYNCED - |- DISCONNECTED + "x-databricks-enum-descriptions": + "DISCONNECTED": |- + The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced. + "NOT_SYNCED": |- + The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced. + "x-databricks-enum-launch-stages": + "DISCONNECTED": |- + PRIVATE_PREVIEW + "NOT_SYNCED": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric: "_": "description": |- @@ -3701,6 +4152,17 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric: STREAMING_BACKLOG_SECONDS - |- STREAMING_BACKLOG_FILES + "x-databricks-enum-descriptions": + "RUN_DURATION_SECONDS": |- + Expected total time for a run in seconds. + "STREAMING_BACKLOG_BYTES": |- + An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_FILES": |- + An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_RECORDS": |- + An estimate of the maximum offset lag across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_SECONDS": |- + An estimate of the maximum consumer delay across all streams. This metric is in Public Preview. github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator: "_": "description": |- @@ -3733,23 +4195,31 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: "aliases": "description": |- Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "condition": "description": |- The condition based on which to trigger a job run. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "min_time_between_triggers_seconds": "description": |- If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "securable_name": "description": |- Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, "mycatalog.myschema" in the case of schema-level triggers) or empty in the case of metastore-level triggers. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "wait_after_last_change_seconds": @@ -3757,6 +4227,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The minimum allowed value is 60 seconds. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition: @@ -3768,6 +4240,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCo MODEL_VERSION_READY - |- MODEL_ALIAS_SET + "x-databricks-enum-launch-stages": + "MODEL_ALIAS_SET": |- + PRIVATE_PREVIEW + "MODEL_CREATED": |- + PRIVATE_PREVIEW + "MODEL_VERSION_READY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask: "base_parameters": "description": |- @@ -3839,16 +4318,24 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams: "full_refresh_selection": "description": |- A list of tables to update with fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_flow_selection": "description": |- Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_selection": "description": |- A list of tables to update without fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "reset_checkpoint_selection": "description": |- A list of streaming flows to reset checkpoints without clearing data. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "full_refresh": "description": |- @@ -3856,10 +4343,14 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "full_refresh_selection": "description": |- A list of tables to update with fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "parameters": "description": |- Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. + "x-databricks-launch-stage": |- + PUBLIC_BETA "pipeline_id": "description": |- The full name of the pipeline task to execute. @@ -3867,75 +4358,117 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "description": |- Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_selection": "description": |- A list of tables to update without fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "reset_checkpoint_selection": "description": |- A list of streaming flows to reset checkpoints without clearing data. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel: "authentication_method": "description": |- How the published Power BI model authenticates to Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "model_name": "description": |- The name of the Power BI model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "overwrite_existing": "description": |- Whether to overwrite existing Power BI models + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_mode": "description": |- The default storage mode of the Power BI model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workspace_name": "description": |- The name of the Power BI workspace of the model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable: "catalog": "description": |- The catalog name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The table name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "schema": "description": |- The schema name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_mode": "description": |- The Power BI storage mode of the table + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask: "connection_resource_name": "description": |- The resource name of the UC connection to authenticate from Databricks to Power BI + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "power_bi_model": "description": |- The semantic model to update + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "refresh_after_update": "description": |- Whether the model should be refreshed after the update + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "tables": "description": |- The tables to be exported to Power BI + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- The SQL warehouse ID to use as the Power BI data source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask: "main": "description": |- Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "parameters": "description": |- An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter: "name": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "value": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask: @@ -3980,6 +4513,19 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunIf: ALL_FAILED - |- AT_LEAST_ONE_FAILED + "x-databricks-enum-descriptions": + "ALL_DONE": |- + All dependencies have been completed + "ALL_FAILED": |- + ALl dependencies have failed + "ALL_SUCCESS": |- + All dependencies have executed and succeeded + "AT_LEAST_ONE_FAILED": |- + At least one dependency failed + "AT_LEAST_ONE_SUCCESS": |- + At least one dependency has succeeded + "NONE_FAILED": |- + None of the dependencies have failed and at least one was executed github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: "dbt_commands": "description": |- @@ -3988,6 +4534,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "jar_params": @@ -4001,6 +4549,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "job_id": @@ -4023,6 +4573,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: The JSON representation of this field (for example `{"notebook_params":{"name":"john doe","age":"35"}}`) cannot exceed 10,000 bytes. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "pipeline_params": @@ -4031,6 +4583,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: "python_named_params": "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "python_params": @@ -4048,6 +4602,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "spark_submit_params": @@ -4065,6 +4621,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sql_params": @@ -4074,6 +4632,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Source: @@ -4090,6 +4650,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.Source: WORKSPACE - |- GIT + "x-databricks-enum-descriptions": + "GIT": |- + SQL file is located in cloud Git provider. + "WORKSPACE": |- + SQL file is located in workspace. github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask: "jar_uri": "description": |- @@ -4214,6 +4779,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.StorageMode: IMPORT - |- DUAL + "x-databricks-enum-launch-stages": + "DIRECT_QUERY": |- + PUBLIC_PREVIEW + "DUAL": |- + PUBLIC_PREVIEW + "IMPORT": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.Subscription: "custom_subject": "description": |- @@ -4253,6 +4825,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "description": |- The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "clean_rooms_notebook_task": "description": |- The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook @@ -4260,6 +4834,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "compute": "description": |- Task level compute configuration. + "x-databricks-launch-stage": |- + PUBLIC_BETA "condition_task": "description": |- The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present. @@ -4272,9 +4848,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dbt_platform_task": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dbt_task": @@ -4309,6 +4889,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "description": |- The task executes a nested task for every input provided when the `for_each_task` field is present. "gen_ai_compute_task": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "health": @@ -4342,9 +4924,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "power_bi_task": "description": |- The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "python_operator_task": "description": |- The task runs a Python operator task. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "python_wheel_task": @@ -4420,6 +5006,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications: A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent. @@ -4450,6 +5038,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings: "description": |- File arrival trigger settings. "model": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "pause_status": @@ -4477,6 +5067,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications: Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property. @@ -4533,11 +5125,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy: "enabled": "description": |- (Required, Mutable) Whether to enable auto full refresh or not. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "min_interval_hours": "description": |- (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions: "_": "description": |- @@ -4545,6 +5141,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOpt "include_confluence_spaces": "description": |- (Optional) Spaces to filter Confluence data on + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters: "source_catalog": "description": |- @@ -4552,6 +5150,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters: This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. For Oracle databases, this maps to a service name. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: @@ -4561,7 +5161,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: "confluence_options": "description": |- Confluence specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "gdrive_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "google_ads_options": @@ -4569,38 +5173,56 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "jira_options": "description": |- Jira specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_BETA "kafka_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "meta_ads_options": "description": |- Meta Marketing (Meta Ads) specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_BETA "outlook_options": "description": |- Outlook specific options for ingestion + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sharepoint_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "smartsheet_options": "description": |- Smartsheet specific options for ingestion + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "tiktok_ads_options": "description": |- TikTok Ads specific options for ingestion + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "zendesk_support_options": "description": |- Zendesk Support specific options for ingestion + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType: @@ -4614,6 +5236,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType: CDC - |- QUERY_BASED + "x-databricks-enum-launch-stages": + "CDC": |- + PUBLIC_BETA + "QUERY_BASED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger: "quartz_cron_schedule": {} "timezone_id": {} @@ -4624,9 +5251,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions: "catalog_name": "description": |- (Required, Immutable) The name of the catalog for the connector's staging storage location. + "x-databricks-launch-stage": |- + PUBLIC_BETA "schema_name": "description": |- (Required, Immutable) The name of the schema for the connector's staging storage location. + "x-databricks-launch-stage": |- + PUBLIC_BETA "volume_name": "description": |- (Optional) The Unity Catalog-compatible name for the storage location. @@ -4634,6 +5265,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions: Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : __databricks_ingestion_gateway_staging_data-$pipelineId + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek: "_": "description": |- @@ -4654,6 +5287,21 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek: SATURDAY - |- SUNDAY + "x-databricks-enum-launch-stages": + "FRIDAY": |- + PUBLIC_PREVIEW + "MONDAY": |- + PUBLIC_PREVIEW + "SATURDAY": |- + PUBLIC_PREVIEW + "SUNDAY": |- + PUBLIC_PREVIEW + "THURSDAY": |- + PUBLIC_PREVIEW + "TUESDAY": |- + PUBLIC_PREVIEW + "WEDNESDAY": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind: "_": "description": |- @@ -4681,6 +5329,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "modified_before": @@ -4688,61 +5338,87 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "path_filter": "description": |- Include files with file names matching the pattern Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions: "corrupt_record_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "file_filters": "description": |- Generic options + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "format": "description": |- required for TableSpec + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "format_options": "description": |- Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "ignore_corrupt_files": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "infer_column_types": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "reader_case_sensitive": "description": |- Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "rescued_data_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema_evolution_mode": "description": |- Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema_hints": "description": |- Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "single_variant_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat: @@ -4764,6 +5440,23 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFi AVRO - |- ORC + "x-databricks-enum-launch-stages": + "AVRO": |- + PRIVATE_PREVIEW + "BINARYFILE": |- + PRIVATE_PREVIEW + "CSV": |- + PRIVATE_PREVIEW + "EXCEL": |- + PRIVATE_PREVIEW + "JSON": |- + PRIVATE_PREVIEW + "ORC": |- + PRIVATE_PREVIEW + "PARQUET": |- + PRIVATE_PREVIEW + "XML": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode: "_": "description": |- @@ -4779,6 +5472,17 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSc FAIL_ON_NEW_COLUMNS - |- NONE + "x-databricks-enum-launch-stages": + "ADD_NEW_COLUMNS": |- + PRIVATE_PREVIEW + "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING": |- + PRIVATE_PREVIEW + "FAIL_ON_NEW_COLUMNS": |- + PRIVATE_PREVIEW + "NONE": |- + PRIVATE_PREVIEW + "RESCUE": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary: "path": "description": |- @@ -4798,6 +5502,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig: of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), the object-level value takes precedence over this top-level config. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: @@ -4810,6 +5516,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: "description": |- (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "manager_account_id": @@ -4817,6 +5525,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sync_start_date": @@ -4824,18 +5534,26 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 2 years of historical data. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions: "entity_type": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "file_ingestion_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "url": "description": |- Google Drive URL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType: @@ -4847,37 +5565,58 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoog FILE_METADATA - |- PERMISSION + "x-databricks-enum-launch-stages": + "FILE": |- + PRIVATE_PREVIEW + "FILE_METADATA": |- + PRIVATE_PREVIEW + "PERMISSION": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig: "report": "description": |- Select a specific source report. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "schema": "description": |- Select all tables from a specific source schema. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table": "description": |- Select a specific source table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition: "connection_id": "description": |- [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "connection_name": "description": |- Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "connection_parameters": "description": |- Optional, Internal. Parameters required to establish an initial connection with the source. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "gateway_storage_catalog": "description": |- Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "gateway_storage_name": @@ -4885,11 +5624,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "gateway_storage_schema": "description": |- Required, Immutable. The name of the schema for the gateway pipelines's storage location. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition: @@ -4903,43 +5646,61 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin pipeline. Under certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed Ingestion Pipeline with Gateway pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "connector_type": "description": |- (Optional) Connector Type for sources. Ex: CDC, Query Based. + "x-databricks-launch-stage": |- + PUBLIC_BETA "data_staging_options": "description": |- (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. + "x-databricks-launch-stage": |- + PUBLIC_BETA "full_refresh_window": "description": |- (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "ingest_from_uc_foreign_catalog": "description": |- Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "ingestion_gateway_id": "description": |- Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "netsuite_jar_path": "description": |- Netsuite only configuration. When the field is set for a netsuite connector, the jar stored in the field will be validated and added to the classpath of pipeline's cluster. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "objects": "description": |- Required. Settings specifying tables to replicate and the destination for the replicated tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_configurations": "description": |- Top-level source configurations + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_type": "description": |- The type of the foreign source. @@ -4947,9 +5708,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is output only and will be ignored if provided. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW ? github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig : "_": "description": |- @@ -4962,6 +5727,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "deletion_condition": "description": |- Specifies a SQL WHERE condition that specifies that the source row has been deleted. @@ -4971,6 +5738,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin one for soft-deletes and the other for hard-deletes. See also the hard_deletion_sync_min_interval_in_seconds field for handling of "hard deletes" where the source rows are physically removed from the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "hard_deletion_sync_min_interval_in_seconds": "description": |- Specifies the minimum interval (in seconds) between snapshots on primary keys @@ -4981,6 +5750,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin frequency instead of happening more often. If not set, hard deletion synchronization via snapshots is disabled. This field is mutable and can be updated without triggering a full snapshot. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters: "incremental": "description": |- @@ -4989,6 +5760,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin controlled by the `parameters` field. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "parameters": @@ -5000,6 +5773,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin "start_date": "{ coalesce(current_offset(), date(\"2025-02-01\")) }", "end_date": "{ current_date() - INTERVAL 1 DAY }" } + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "report_parameters": @@ -5008,12 +5783,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is deprecated and should not be used. Use `parameters` instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue: "key": "description": |- Key for the report parameter, can be a column name or other metadata + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "value": @@ -5023,6 +5802,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() is null, then the passed date, else current_offset() 2. current_date() 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) days from current date + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: @@ -5068,6 +5849,47 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: ZENDESK - |- FOREIGN_CATALOG + "x-databricks-enum-launch-stages": + "BIGQUERY": |- + PUBLIC_PREVIEW + "CONFLUENCE": |- + PUBLIC_PREVIEW + "DYNAMICS365": |- + PUBLIC_PREVIEW + "FOREIGN_CATALOG": |- + PRIVATE_PREVIEW + "GA4_RAW_DATA": |- + PUBLIC_PREVIEW + "GOOGLE_DRIVE": |- + PRIVATE_PREVIEW + "JIRA": |- + PUBLIC_BETA + "MANAGED_POSTGRESQL": |- + PUBLIC_PREVIEW + "META_MARKETING": |- + PUBLIC_BETA + "MYSQL": |- + PUBLIC_PREVIEW + "NETSUITE": |- + PUBLIC_PREVIEW + "ORACLE": |- + PUBLIC_PREVIEW + "POSTGRESQL": |- + PUBLIC_PREVIEW + "SALESFORCE": |- + PUBLIC_PREVIEW + "SERVICENOW": |- + PUBLIC_PREVIEW + "SHAREPOINT": |- + PUBLIC_PREVIEW + "SQLSERVER": |- + PUBLIC_PREVIEW + "TERADATA": |- + PUBLIC_PREVIEW + "WORKDAY_RAAS": |- + PUBLIC_PREVIEW + "ZENDESK": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions: "_": "description": |- @@ -5075,30 +5897,42 @@ github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions: "include_jira_spaces": "description": |- (Optional) Projects to filter Jira data on + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions: "as_variant": "description": |- Parse the entire value as a single Variant column. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema": "description": |- Inline schema string for JSON parsing (Spark DDL format). + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema_evolution_mode": "description": |- (Optional) Schema evolution mode for schema inference. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema_file_path": "description": |- Path to a schema file (.ddl). + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "schema_hints": "description": |- (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: @@ -5107,41 +5941,55 @@ github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "key_transformer": "description": |- (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "max_offsets_per_trigger": "description": |- Internal option to control the maximum number of offsets to process per trigger. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "starting_offset": "description": |- (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "topic_pattern": "description": |- Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "topics": "description": |- Topics to subscribe to. Only one of topics or topic_pattern must be specified. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "value_transformer": "description": |- (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger: {} @@ -5152,29 +6000,45 @@ github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions: "action_attribution_windows": "description": |- (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + "x-databricks-launch-stage": |- + PUBLIC_BETA "action_breakdowns": "description": |- (Optional) Action breakdowns to configure for data aggregation + "x-databricks-launch-stage": |- + PUBLIC_BETA "action_report_time": "description": |- (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + "x-databricks-launch-stage": |- + PUBLIC_BETA "breakdowns": "description": |- (Optional) Breakdowns to configure for data aggregation + "x-databricks-launch-stage": |- + PUBLIC_BETA "custom_insights_lookback_window": "description": |- (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. + "x-databricks-launch-stage": |- + PUBLIC_BETA "level": "description": |- (Optional) Granularity of data to pull (account, ad, adset, campaign) + "x-databricks-launch-stage": |- + PUBLIC_BETA "start_date": "description": |- (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested + "x-databricks-launch-stage": |- + PUBLIC_BETA "time_increment": "description": |- (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary: "path": "description": |- @@ -5200,13 +6064,19 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow: "description": |- Days of week in which the window is allowed to happen If not specified all days of the week will be used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "start_hour": "description": |- An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "time_zone_id": "description": |- Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode: "_": "description": |- @@ -5220,6 +6090,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode: INLINE_ONLY - |- NONE + "x-databricks-enum-launch-stages": + "ALL": |- + PRIVATE_PREVIEW + "INLINE_ONLY": |- + PRIVATE_PREVIEW + "NONE": |- + PRIVATE_PREVIEW + "NON_INLINE_ONLY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat: "_": "description": |- @@ -5229,6 +6108,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat: TEXT_HTML - |- TEXT_PLAIN + "x-databricks-enum-launch-stages": + "TEXT_HTML": |- + PRIVATE_PREVIEW + "TEXT_PLAIN": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: "_": "description": |- @@ -5237,6 +6121,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: "description": |- (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "body_format": @@ -5244,6 +6130,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "folder_filter": @@ -5251,6 +6139,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_folders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_folders": @@ -5259,6 +6149,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_mailboxes": @@ -5266,6 +6158,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_senders": @@ -5274,6 +6168,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_subjects": @@ -5283,6 +6179,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. Filter semantics: OR between different subjects. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sender_filter": @@ -5290,6 +6188,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_senders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "start_date": @@ -5298,6 +6198,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "subject_filter": @@ -5305,12 +6207,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_subjects instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern: "include": "description": |- The source code to include for pipelines + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster: "apply_policy_default_values": "description": |- @@ -5443,6 +6349,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: ID of the deployment that manages this pipeline. Only set when `kind` is `BUNDLE`. Used to look up deployment metadata from the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "kind": @@ -5456,6 +6364,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: ID of the version of the deployment that produced this pipeline. Only set when `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment in the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: @@ -5467,14 +6377,20 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "jar": "description": |- URI of the jar to be installed. Currently only DBFS is supported. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "maven": "description": |- Specification of a maven library to be installed. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "notebook": @@ -5511,6 +6427,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment: List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "environment_version": "description": |- The environment version of the serverless Python environment used to execute @@ -5523,6 +6441,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment: https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ The value should be a string representing the environment version number, for example: `"4"`. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig: @@ -5532,6 +6452,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig: "slot_config": "description": |- Optional. The Postgres slot configuration to use for logical replication + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: "_": "description": |- @@ -5539,42 +6461,62 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: "publication_name": "description": |- The name of the publication to use for the Postgres source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "slot_name": "description": |- The name of the logical replication slot to use for the Postgres source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec: "destination_catalog": "description": |- Required. Destination catalog to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_table": "description": |- Required. Destination table name. The pipeline fails if a table with that name already exists. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_url": "description": |- Required. Report URL in the source system. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow: "days_of_week": "description": |- Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). If not specified all days of the week will be used. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "start_hour": "description": |- An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. Continuous pipeline restart is triggered only within a five-hour window starting at this hour. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "time_zone_id": "description": |- Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.RunAs: @@ -5593,36 +6535,54 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec: "connector_options": "description": |- (Optional) Source Specific Connector Options + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_catalog": "description": |- Required. Destination catalog to store tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- The source catalog name. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_schema": "description": |- Required. Schema name in the source database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions: "entity_type": "description": |- (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "file_ingestion_options": "description": |- (Optional) File ingestion options for processing files. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "url": "description": |- Required. The SharePoint URL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType: @@ -5636,6 +6596,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsShare PERMISSION - |- LIST + "x-databricks-enum-launch-stages": + "FILE": |- + PRIVATE_PREVIEW + "FILE_METADATA": |- + PRIVATE_PREVIEW + "LIST": |- + PRIVATE_PREVIEW + "PERMISSION": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: "_": "description": |- @@ -5647,6 +6616,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. If not specified, defaults to true. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: @@ -5656,41 +6627,65 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: "postgres": "description": |- Postgres-specific catalog-level configuration parameters + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- Source catalog name + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig: "catalog": "description": |- Catalog-level source configuration parameters + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "google_ads_config": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec: "connector_options": "description": |- (Optional) Source Specific Connector Options + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_catalog": "description": |- Required. Destination catalog to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_table": "description": |- Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- Source catalog name. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_schema": "description": |- Schema name in the source database. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_table": "description": |- Required. Table name in the source database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: "auto_full_refresh_policy": "description": |- @@ -5705,12 +6700,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: } } If unspecified, auto full refresh is disabled. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "exclude_columns": "description": |- A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "include_columns": "description": |- A list of column names to be included for the ingestion. @@ -5718,31 +6717,47 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. This field in mutually exclusive with `exclude_columns`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "primary_keys": "description": |- The primary key of the table used to apply changes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "query_based_connector_config": "description": |- Configurations that are only applicable for query-based ingestion connectors. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "row_filter": "description": |- (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "salesforce_include_formula_fields": "description": |- If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "scd_type": "description": |- The SCD type to use to ingest the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sequence_by": "description": |- The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workday_report_parameters": "description": |- (Optional) Additional custom parameters for Workday Report + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType: @@ -5756,6 +6771,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScd SCD_TYPE_2 - |- APPEND_ONLY + "x-databricks-enum-launch-stages": + "APPEND_ONLY": |- + PUBLIC_PREVIEW + "SCD_TYPE_1": |- + PUBLIC_PREVIEW + "SCD_TYPE_2": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: "_": "description": |- @@ -5764,6 +6786,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: "description": |- (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dimensions": @@ -5771,6 +6795,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "lookback_window_days": @@ -5778,6 +6804,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "metrics": @@ -5785,6 +6813,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "query_lifetime": @@ -5792,12 +6822,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "report_type": "description": |- (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sync_start_date": @@ -5806,6 +6840,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports and 30 days for hourly reports. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel: @@ -5821,6 +6857,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTok AUCTION_ADGROUP - |- AUCTION_AD + "x-databricks-enum-launch-stages": + "AUCTION_AD": |- + PRIVATE_PREVIEW + "AUCTION_ADGROUP": |- + PRIVATE_PREVIEW + "AUCTION_ADVERTISER": |- + PRIVATE_PREVIEW + "AUCTION_CAMPAIGN": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType: "_": "description": |- @@ -5838,6 +6883,19 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTok BUSINESS_CENTER - |- GMV_MAX + "x-databricks-enum-launch-stages": + "AUDIENCE": |- + PRIVATE_PREVIEW + "BASIC": |- + PRIVATE_PREVIEW + "BUSINESS_CENTER": |- + PRIVATE_PREVIEW + "DSA": |- + PRIVATE_PREVIEW + "GMV_MAX": |- + PRIVATE_PREVIEW + "PLAYABLE_AD": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: "_": "description": |- @@ -5845,9 +6903,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: "format": "description": |- Required: the wire format of the data. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "json_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: @@ -5857,6 +6919,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: STRING - |- JSON + "x-databricks-enum-launch-stages": + "JSON": |- + PRIVATE_PREVIEW + "STRING": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "_": "description": |- @@ -5865,6 +6932,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "description": |- (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: @@ -5872,15 +6941,21 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: "description": |- Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1. + "x-databricks-launch-stage": |- + PUBLIC_BETA "max": "description": |- The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec. + "x-databricks-launch-stage": |- + PUBLIC_BETA "min": "description": |- The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings: "_": "description": |- @@ -5888,6 +6963,8 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings: "pg_settings": "description": |- A raw representation of Postgres settings. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.EndpointType: "_": "description": |- @@ -5897,25 +6974,40 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointType: ENDPOINT_TYPE_READ_WRITE - |- ENDPOINT_TYPE_READ_ONLY + "x-databricks-enum-launch-stages": + "ENDPOINT_TYPE_READ_ONLY": |- + PUBLIC_BETA + "ENDPOINT_TYPE_READ_WRITE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec: "budget_policy_id": "description": |- Budget policy to set on the newly created pipeline. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_catalog": "description": |- UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_schema": "description": |- UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag: "key": "description": |- The key of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_BETA "value": "description": |- The value of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings: "_": "description": |- @@ -5923,22 +7015,32 @@ github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointS "autoscaling_limit_max_cu": "description": |- The maximum number of Compute Units. Minimum value is 0.5. + "x-databricks-launch-stage": |- + PUBLIC_BETA "autoscaling_limit_min_cu": "description": |- The minimum number of Compute Units. Minimum value is 0.5. + "x-databricks-launch-stage": |- + PUBLIC_BETA "no_suspension": "description": |- When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask. + "x-databricks-launch-stage": |- + PUBLIC_BETA "pg_settings": "description": |- A raw representation of Postgres settings. + "x-databricks-launch-stage": |- + PUBLIC_BETA "suspend_timeout_duration": "description": |- Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy: "_": "description": |- @@ -5950,6 +7052,13 @@ github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableS TRIGGERED - |- SNAPSHOT + "x-databricks-enum-launch-stages": + "CONTINUOUS": |- + PUBLIC_BETA + "SNAPSHOT": |- + PUBLIC_BETA + "TRIGGERED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig: "ai21labs_api_key": "description": |- @@ -5971,6 +7080,8 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig: "guardrails": "description": |- Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "inference_table_config": "description": |- Configuration for payload logging using inference tables. @@ -5989,22 +7100,32 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParame AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pii": "description": |- Configuration for guardrail PII filter. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "safety": "description": |- Indicates whether the safety filter is enabled. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "valid_topics": "description": |- The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior: "behavior": "description": |- Configuration for input guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior: "_": "enum": @@ -6014,13 +7135,24 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBeh BLOCK - |- MASK + "x-databricks-enum-launch-stages": + "BLOCK": |- + PUBLIC_PREVIEW + "MASK": |- + PUBLIC_PREVIEW + "NONE": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails: "input": "description": |- Configuration for input guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "output": "description": |- Configuration for output guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig: "catalog_name": "description": |- @@ -6065,11 +7197,23 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey: user_group - |- service_principal + "x-databricks-enum-launch-stages": + "endpoint": |- + PUBLIC_PREVIEW + "service_principal": |- + PUBLIC_PREVIEW + "user": |- + PUBLIC_PREVIEW + "user_group": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod: "_": "enum": - |- minute + "x-databricks-enum-launch-stages": + "minute": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig: "enabled": "description": |- @@ -6129,6 +7273,15 @@ github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedro ai21labs - |- amazon + "x-databricks-enum-launch-stages": + "ai21labs": |- + PUBLIC_PREVIEW + "amazon": |- + PUBLIC_PREVIEW + "anthropic": |- + PUBLIC_PREVIEW + "cohere": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig: "anthropic_api_key": "description": |- @@ -6323,6 +7476,25 @@ github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider: palm - |- custom + "x-databricks-enum-launch-stages": + "ai21labs": |- + PUBLIC_PREVIEW + "amazon-bedrock": |- + PUBLIC_PREVIEW + "anthropic": |- + PUBLIC_PREVIEW + "cohere": |- + PUBLIC_PREVIEW + "custom": |- + PUBLIC_PREVIEW + "databricks-model-serving": |- + PUBLIC_PREVIEW + "google-cloud-vertex-ai": |- + PUBLIC_PREVIEW + "openai": |- + PUBLIC_PREVIEW + "palm": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.FallbackConfig: "enabled": "description": |- @@ -6458,11 +7630,19 @@ github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey: user - |- endpoint + "x-databricks-enum-launch-stages": + "endpoint": |- + PUBLIC_PREVIEW + "user": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod: "_": "enum": - |- minute + "x-databricks-enum-launch-stages": + "minute": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.Route: "served_entity_name": {} "served_model_name": @@ -6477,6 +7657,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically scale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint maintains fixed capacity at provisioned_model_units. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "entity_name": "description": |- The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of **catalog_name.schema_name.model_name**. @@ -6490,6 +7672,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: "instance_profile_arn": "description": |- ARN of the instance profile that the served entity uses to access AWS resources. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -6508,6 +7692,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: "provisioned_model_units": "description": |- The number of model units provisioned. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. @@ -6523,12 +7709,16 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically scale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint maintains fixed capacity at provisioned_model_units. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "environment_vars": "description": |- An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{"OPENAI_API_KEY": "{{secrets/my_scope/my_key}}", "DATABRICKS_TOKEN": "{{secrets/my_scope2/my_key2}}"}` "instance_profile_arn": "description": |- ARN of the instance profile that the served entity uses to access AWS resources. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -6549,6 +7739,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: "provisioned_model_units": "description": |- The number of model units provisioned. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. @@ -6575,6 +7767,9 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkload MULTIGPU_MEDIUM - |- GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel: "_": "description": |- @@ -6603,6 +7798,9 @@ github.com/databricks/databricks-sdk-go/service/serving.ServingModelWorkloadType MULTIGPU_MEDIUM - |- GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig: "routes": "description": |- @@ -6626,6 +7824,23 @@ github.com/databricks/databricks-sdk-go/service/sql.Aggregation: MAX - |- STDDEV + "x-databricks-enum-launch-stages": + "AVG": |- + PUBLIC_PREVIEW + "COUNT": |- + PUBLIC_PREVIEW + "COUNT_DISTINCT": |- + PUBLIC_PREVIEW + "MAX": |- + PUBLIC_PREVIEW + "MEDIAN": |- + PUBLIC_PREVIEW + "MIN": |- + PUBLIC_PREVIEW + "STDDEV": |- + PUBLIC_PREVIEW + "SUM": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState: "_": "description": |- @@ -6643,6 +7858,15 @@ github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState: OK - |- ERROR + "x-databricks-enum-launch-stages": + "ERROR": |- + PUBLIC_PREVIEW + "OK": |- + PUBLIC_PREVIEW + "TRIGGERED": |- + PUBLIC_PREVIEW + "UNKNOWN": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertLifecycleState: "_": "enum": @@ -6650,65 +7874,114 @@ github.com/databricks/databricks-sdk-go/service/sql.AlertLifecycleState: ACTIVE - |- DELETED + "x-databricks-enum-launch-stages": + "ACTIVE": |- + PUBLIC_PREVIEW + "DELETED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation: "comparison_operator": "description": |- Operator used for comparison in alert evaluation. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "empty_result_state": "description": |- Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_evaluated_at": "description": |- Timestamp of the last evaluation. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "notification": "description": |- User or Notification Destination to notify when alert is triggered. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source": "description": |- Source column from result to use to evaluate alert + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "state": "description": |- Latest state of alert evaluation. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "threshold": "description": |- Threshold to user for alert evaluation, can be a column or a value. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification: "notify_on_ok": "description": |- Whether to notify alert subscribers when alert returns back to normal. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "retrigger_seconds": "description": |- Number of seconds an alert waits after being triggered before it is allowed to send another notification. If set to 0 or omitted, the alert will not send any further notifications after the first trigger Setting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes. - "subscriptions": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "subscriptions": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand: - "column": {} - "value": {} + "column": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn: "aggregation": "description": |- If not set, the behavior is equivalent to using `First row` in the UI. - "display": {} - "name": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "display": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "name": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue: - "bool_value": {} - "double_value": {} - "string_value": {} + "bool_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "double_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "string_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs: "service_principal_name": "description": |- Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "user_name": "description": |- The email of an active workspace user. Can only set this field to their own email. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription: - "destination_id": {} - "user_email": {} + "destination_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "user_email": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.Channel: "_": "description": |- @@ -6745,6 +8018,23 @@ github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator: IS_NULL - |- IS_NOT_NULL + "x-databricks-enum-launch-stages": + "EQUAL": |- + PUBLIC_PREVIEW + "GREATER_THAN": |- + PUBLIC_PREVIEW + "GREATER_THAN_OR_EQUAL": |- + PUBLIC_PREVIEW + "IS_NOT_NULL": |- + PUBLIC_PREVIEW + "IS_NULL": |- + PUBLIC_PREVIEW + "LESS_THAN": |- + PUBLIC_PREVIEW + "LESS_THAN_OR_EQUAL": |- + PUBLIC_PREVIEW + "NOT_EQUAL": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType: "_": "enum": @@ -6758,15 +8048,21 @@ github.com/databricks/databricks-sdk-go/service/sql.CronSchedule: "pause_status": "description": |- Indicate whether this schedule is paused or not. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "quartz_cron_schedule": "description": |- A cron expression using quartz syntax that specifies the schedule for this pipeline. Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timezone_id": "description": |- A Java timezone id. The schedule will be resolved using this timezone. This will be combined with the quartz_cron_schedule to determine the schedule. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair: "key": {} "value": {} @@ -6779,6 +8075,11 @@ github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus: UNPAUSED - |- PAUSED + "x-databricks-enum-launch-stages": + "PAUSED": |- + PUBLIC_PREVIEW + "UNPAUSED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy: "_": "description": |- @@ -6889,6 +8190,9 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType: STORAGE_OPTIMIZED - |- STANDARD + "x-databricks-enum-launch-stages": + "STORAGE_OPTIMIZED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype: "_": "description": |- @@ -6903,6 +8207,20 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype: FULL_TEXT - |- HYBRID + "x-databricks-enum-descriptions": + "FULL_TEXT": |- + An index that uses full-text search without vector embeddings. + "HYBRID": |- + An index that uses vector embeddings for similarity search and hybrid search. + "VECTOR": |- + Not supported. Use `HYBRID` instead. + "x-databricks-enum-launch-stages": + "FULL_TEXT": |- + PUBLIC_BETA + "HYBRID": |- + PUBLIC_BETA + "VECTOR": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType: "_": "description": |- @@ -6914,6 +8232,11 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType: TRIGGERED - |- CONTINUOUS + "x-databricks-enum-descriptions": + "CONTINUOUS": |- + If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh. + "TRIGGERED": |- + If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started. github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType: "_": "description": |- @@ -6925,6 +8248,11 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType: DELTA_SYNC - |- DIRECT_ACCESS + "x-databricks-enum-descriptions": + "DELTA_SYNC": |- + An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. + "DIRECT_ACCESS": |- + An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates. github.com/databricks/databricks-sdk-go/service/workspace.AzureKeyVaultSecretScopeMetadata: "_": "description": |- diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index 0e159335967..a55ffae4d1b 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,119 @@ func TestConvertLinksToAbsoluteUrl(t *testing.T) { } } } + +func TestAssignAnnotationLaunchStage(t *testing.T) { + t.Run("public preview prefixes description and stays suggestible", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Target QPS for the endpoint.", + LaunchStage: "PUBLIC_PREVIEW", + }) + assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) + assert.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) + assert.False(t, s.DoNotSuggest) + }) + + t.Run("public beta prefixes description", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "A field.", + LaunchStage: "PUBLIC_BETA", + }) + assert.Equal(t, "[Beta] A field.", s.Description) + }) + + t.Run("private preview also hides from autocomplete", func(t *testing.T) { + s := &jsonschema.Schema{} + 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("per-enum-value launch stages do not leak into description", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Type of endpoint.", + Enum: []any{"STORAGE_OPTIMIZED", "STANDARD"}, + EnumLaunchStages: map[string]string{ + "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", + }, + }) + assert.Equal(t, "Type of endpoint.", s.Description) + assert.Equal(t, []string{"[PuPr]", ""}, s.EnumDescriptions) + }) +} + +func TestPrefixWithPreviewTagNoDoubleTag(t *testing.T) { + t.Run("empty description becomes the tag", func(t *testing.T) { + assert.Equal(t, "[Public Preview]", prefixWithPreviewTag("", "[Public Preview]")) + }) + + t.Run("normal description is prefixed once", func(t *testing.T) { + assert.Equal(t, "[Public Preview] A field.", prefixWithPreviewTag("A field.", "[Public Preview]")) + }) + + t.Run("description already starting with the tag is left alone", func(t *testing.T) { + got := prefixWithPreviewTag("[Public Preview] Already tagged.", "[Public Preview]") + assert.Equal(t, "[Public Preview] Already tagged.", got) + }) + + t.Run("different tag still prepends even if description has another tag", func(t *testing.T) { + got := prefixWithPreviewTag("[Private Preview] foo", "[Public Preview]") + assert.Equal(t, "[Public Preview] [Private Preview] foo", got) + }) +} + +func TestBuildEnumDescriptions(t *testing.T) { + enum := []any{"STORAGE_OPTIMIZED", "STANDARD"} + + t.Run("combines launch stage and description per value", func(t *testing.T) { + got := buildEnumDescriptions(enum, + map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, + map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }, + ) + assert.Equal(t, []string{ + "[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) + }) +} diff --git a/bundle/internal/schema/cli_json.go b/bundle/internal/schema/cli_json.go index f44c5479f0d..1dd6bdf6b22 100644 --- a/bundle/internal/schema/cli_json.go +++ b/bundle/internal/schema/cli_json.go @@ -17,12 +17,18 @@ type cliJSONField struct { } // cliJSONSchema is the shape of a single schema in .codegen/cli.json. +// +// EnumLaunchStages and EnumDescriptions only ever appear on enum schemas (a +// field that uses an enum carries a `ref` to one), so they are not part of +// cliJSONField. type cliJSONSchema struct { - Description string `json:"description,omitempty"` - Enum []any `json:"enum,omitempty"` - Deprecated bool `json:"deprecated,omitempty"` - LaunchStage string `json:"launch_stage,omitempty"` - Fields map[string]cliJSONField `json:"fields,omitempty"` + Description string `json:"description,omitempty"` + Enum []any `json:"enum,omitempty"` + Deprecated bool `json:"deprecated,omitempty"` + LaunchStage string `json:"launch_stage,omitempty"` + EnumLaunchStages map[string]string `json:"enum_launch_stages,omitempty"` + EnumDescriptions map[string]string `json:"enum_descriptions,omitempty"` + Fields map[string]cliJSONField `json:"fields,omitempty"` } // cliJSONSpec is the top-level shape of .codegen/cli.json that we care about. diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 6fe3e036205..12c3c1294d4 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -98,6 +98,49 @@ func previewFromLaunchStage(launchStage string) string { return "" } +// normalizeLaunchStage drops the GA stage so it isn't persisted in the +// annotation file. GA is the implicit default for any field that isn't in a +// preview, so storing it would add a stage to thousands of entries for no +// benefit. cli.json is already filtered at min-stage=PRIVATE_PREVIEW upstream, +// so the only other values are the preview stages, which we keep verbatim. +func normalizeLaunchStage(launchStage string) string { + if launchStage == "GA" { + return "" + } + return launchStage +} + +// notableEnumLaunchStages keeps only the enum values whose launch stage is +// worth surfacing (i.e. not GA), so the annotation file isn't polluted with a +// stage for every value of a GA enum. Returns nil when nothing remains. +func notableEnumLaunchStages(stages map[string]string) map[string]string { + result := map[string]string{} + for value, stage := range stages { + if ls := normalizeLaunchStage(stage); ls != "" { + result[value] = ls + } + } + if len(result) == 0 { + return nil + } + return result +} + +// nonEmptyEnumDescriptions drops blank per-value descriptions so the annotation +// file stays clean. Returns nil when nothing remains. +func nonEmptyEnumDescriptions(descriptions map[string]string) map[string]string { + result := map[string]string{} + for value, desc := range descriptions { + if desc != "" { + result[value] = desc + } + } + if len(result) == 0 { + return nil + } + return result +} + func isOutputOnly(behaviors []string) *bool { if !slices.Contains(behaviors, "OUTPUT_ONLY") { return nil @@ -138,18 +181,25 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over pkg := map[string]annotation.Descriptor{} annotations[basePath] = pkg preview := previewFromLaunchStage(ref.LaunchStage) - if ref.Description != "" || ref.Enum != nil || ref.Deprecated || preview != "" { + launchStage := normalizeLaunchStage(ref.LaunchStage) + enumLaunchStages := notableEnumLaunchStages(ref.EnumLaunchStages) + enumDescriptions := nonEmptyEnumDescriptions(ref.EnumDescriptions) + if ref.Description != "" || ref.Enum != nil || ref.Deprecated || preview != "" || launchStage != "" || enumLaunchStages != nil || enumDescriptions != nil { pkg[RootTypeKey] = annotation.Descriptor{ Description: ref.Description, Enum: ref.Enum, DeprecationMessage: deprecationMessageFor(ref.Deprecated), Preview: preview, + LaunchStage: launchStage, + EnumLaunchStages: enumLaunchStages, + EnumDescriptions: enumDescriptions, } } for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { preview = previewFromLaunchStage(refProp.LaunchStage) + launchStage = normalizeLaunchStage(refProp.LaunchStage) description := refProp.Description @@ -166,6 +216,7 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over Description: description, Enum: refProp.Enum, Preview: preview, + LaunchStage: launchStage, DeprecationMessage: deprecationMessageFor(refProp.Deprecated), OutputOnly: isOutputOnly(refProp.Behaviors), } diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go new file mode 100644 index 00000000000..a316d622475 --- /dev/null +++ b/bundle/internal/schema/parser_test.go @@ -0,0 +1,67 @@ +package main + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNormalizeLaunchStage(t *testing.T) { + tests := []struct { + input string + want string + }{ + {"GA", ""}, + {"", ""}, + {"PUBLIC_PREVIEW", "PUBLIC_PREVIEW"}, + {"PUBLIC_BETA", "PUBLIC_BETA"}, + {"PRIVATE_PREVIEW", "PRIVATE_PREVIEW"}, + } + for _, tc := range tests { + assert.Equal(t, tc.want, normalizeLaunchStage(tc.input)) + } +} + +func TestNotableEnumLaunchStages(t *testing.T) { + t.Run("drops GA, keeps preview values", func(t *testing.T) { + got := notableEnumLaunchStages(map[string]string{ + "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", + "STANDARD": "GA", + }) + assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, got) + }) + + t.Run("returns nil when every value is GA", func(t *testing.T) { + assert.Nil(t, notableEnumLaunchStages(map[string]string{"STANDARD": "GA"})) + }) + + t.Run("returns nil for empty input", func(t *testing.T) { + assert.Nil(t, notableEnumLaunchStages(nil)) + }) +} + +func TestNonEmptyEnumDescriptions(t *testing.T) { + t.Run("keeps non-empty descriptions", func(t *testing.T) { + got := nonEmptyEnumDescriptions(map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }) + assert.Equal(t, map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }, got) + }) + + t.Run("drops empty descriptions", func(t *testing.T) { + got := nonEmptyEnumDescriptions(map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "", + }) + assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "Storage-optimized endpoint."}, got) + }) + + t.Run("returns nil for empty input", func(t *testing.T) { + assert.Nil(t, nonEmptyEnumDescriptions(nil)) + assert.Nil(t, nonEmptyEnumDescriptions(map[string]string{"STANDARD": ""})) + }) +} diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index c8b34e1ff9e..c6f1296baa9 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,16 +162,22 @@ "type": "object", "properties": { "budget_policy_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "compute_max_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute_min_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute_size": { @@ -191,19 +217,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, @@ -608,23 +641,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, @@ -647,51 +685,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": "[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": "[Beta] The desired usage policy to associate with the instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -766,8 +814,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.", @@ -851,9 +900,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": { @@ -1205,8 +1255,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.", @@ -1237,8 +1288,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", @@ -1249,9 +1301,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": { @@ -1259,8 +1312,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.", @@ -1279,7 +1333,9 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications" }, "parameters": { - "$ref": "#/$defs/map/string" + "description": "[Beta]", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission" @@ -1289,14 +1345,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" @@ -1330,9 +1388,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 } }, @@ -1634,9 +1693,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": { @@ -2009,19 +2069,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, @@ -2041,7 +2109,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" @@ -2056,11 +2126,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 } }, @@ -2094,7 +2168,9 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" }, "index_subtype": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype" + "description": "[Beta]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "index_type": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType" @@ -3998,9 +4074,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -4163,9 +4240,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 } }, @@ -4771,6 +4849,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -4795,6 +4877,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." ] }, { @@ -4909,7 +5003,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 @@ -4934,9 +5030,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": { @@ -5017,6 +5114,10 @@ "enum": [ "GPU_1xA10", "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -5420,12 +5521,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 @@ -5443,16 +5546,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 @@ -5474,6 +5580,14 @@ "STOPPED", "UPDATING", "FAILING_OVER" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5501,16 +5615,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": "[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 @@ -5532,6 +5649,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5548,6 +5673,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5628,6 +5758,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5643,32 +5778,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 @@ -5696,6 +5838,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]" ] }, { @@ -5711,20 +5866,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 @@ -5774,6 +5933,28 @@ "CAN_CREATE", "CAN_MONITOR_ONLY", "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[PrPr]", + "[PrPr]" ] }, { @@ -5788,20 +5969,24 @@ "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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 Preview] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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 Preview] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5819,11 +6004,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 Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_name": { - "description": "A valid workspace email address.", - "$ref": "#/$defs/string" + "description": "[Public Preview] A valid workspace email address.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5841,6 +6029,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -5890,8 +6082,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": "[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 @@ -5908,21 +6101,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gpu_type": { - "description": "GPU type.", + "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "num_gpus": { - "description": "Number of GPUs.", + "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6065,9 +6261,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": { @@ -6093,15 +6290,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dbt_cloud_job_id": { - "description": "Id of the dbt Cloud job to be triggered", + "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6119,15 +6318,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-preview": "PRIVATE", + "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.", + "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6264,50 +6465,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dl_runtime_image": { - "description": "Runtime image", + "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "mlflow_experiment_name": { - "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "training_script_path": { - "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "yaml_parameters_file_path": { - "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6436,9 +6646,10 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "kind": { @@ -6450,9 +6661,10 @@ "$ref": "#/$defs/string" }, "version_id": { - "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6475,6 +6687,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." ] }, { @@ -6491,6 +6707,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." ] }, { @@ -6523,8 +6743,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.", @@ -6636,9 +6857,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": { @@ -6665,21 +6887,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "import_from_git_branch": { - "description": "Name of the branch which the job is imported from.", + "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "job_config_path": { - "description": "Path of the job YAML file that contains the job specification.", + "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6703,6 +6928,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." ] }, { @@ -6722,6 +6951,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." ] }, { @@ -6798,33 +7034,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "condition": { - "description": "The condition based on which to trigger a job run.", + "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "securable_name": { - "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", + "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6847,6 +7088,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -6971,20 +7217,24 @@ "$ref": "#/$defs/bool" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of tables to update with fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of tables to update without fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -7005,28 +7255,33 @@ "$ref": "#/$defs/bool" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of tables to update with fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "parameters": { - "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", - "$ref": "#/$defs/map/string" + "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "pipeline_id": { "description": "The full name of the pipeline task to execute.", "$ref": "#/$defs/string" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of tables to update without fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string" + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -7046,24 +7301,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 @@ -7080,20 +7340,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 @@ -7110,24 +7374,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 @@ -7144,15 +7413,17 @@ "type": "object", "properties": { "main": { - "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "parameters": { - "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", + "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7170,13 +7441,17 @@ "type": "object", "properties": { "name": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "value": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7255,6 +7530,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" ] }, { @@ -7269,17 +7552,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 @@ -7293,9 +7578,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 @@ -7305,32 +7591,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 @@ -7355,6 +7646,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, { @@ -7641,6 +7936,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -7733,16 +8033,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 Preview] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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": "[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.", @@ -7753,16 +8055,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": { @@ -7802,8 +8107,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": { @@ -7842,13 +8149,15 @@ "$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_operator_task": { - "description": "The task runs a Python operator task.", + "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "python_wheel_task": { @@ -7958,8 +8267,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.", @@ -8026,8 +8336,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": { @@ -8088,8 +8400,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.", @@ -8193,12 +8506,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, @@ -8219,8 +8534,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 @@ -8237,9 +8553,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 } }, @@ -8258,60 +8575,74 @@ "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": "[Beta] Jira specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "kafka_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions" + "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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 } }, @@ -8331,6 +8662,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -8366,16 +8701,19 @@ "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": "[Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", - "$ref": "#/$defs/string" + "description": "[Beta] (Required, Immutable) The name of the schema for the connector's staging storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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": "[Beta] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -8403,6 +8741,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -8459,21 +8806,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-preview": "PRIVATE", + "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", + "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "path_filter": { - "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", + "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8491,64 +8841,80 @@ "type": "object", "properties": { "corrupt_record_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_filters": { - "description": "Generic options", + "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "format": { - "description": "required for TableSpec", + "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", "x-databricks-preview": "PRIVATE", + "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", + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "ignore_corrupt_files": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "infer_column_types": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "reader_case_sensitive": { - "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "rescued_data_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_evolution_mode": { - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", + "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", + "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "single_variant_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8573,6 +8939,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8592,6 +8968,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8646,9 +9029,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8667,21 +9051,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-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8702,19 +9089,24 @@ "type": "object", "properties": { "entity_type": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_ingestion_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "url": { - "description": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8734,6 +9126,11 @@ "FILE", "FILE_METADATA", "PERMISSION" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8748,16 +9145,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 @@ -8774,41 +9174,47 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "connection_parameters": { - "description": "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.", + "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gateway_storage_name": { - "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", + "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8831,45 +9237,56 @@ "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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType" + "description": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "data_staging_options": { - "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions" + "description": "[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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 @@ -8887,16 +9304,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": "[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 @@ -8913,23 +9333,26 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "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}", + "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "report_parameters": { - "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -8949,15 +9372,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-preview": "PRIVATE", + "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", + "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8994,6 +9419,28 @@ "META_MARKETING", "ZENDESK", "FOREIGN_CATALOG" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PrPr]", + "[Beta]", + "[PuPr]", + "[Beta]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9009,8 +9456,9 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", - "$ref": "#/$defs/slice/string" + "description": "[Beta] (Optional) Projects to filter Jira data on", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9027,33 +9475,38 @@ "type": "object", "properties": { "as_variant": { - "description": "Parse the entire value as a single Variant column.", + "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema": { - "description": "Inline schema string for JSON parsing (Spark DDL format).", + "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_evolution_mode": { - "description": "(Optional) Schema evolution mode for schema inference.", + "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_file_path": { - "description": "Path to a schema file (.ddl).", + "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_hints": { - "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9071,45 +9524,52 @@ "type": "object", "properties": { "client_config": { - "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "key_transformer": { - "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "max_offsets_per_trigger": { - "description": "Internal option to control the maximum number of offsets to process per trigger.", + "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "starting_offset": { - "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "topic_pattern": { - "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "topics": { - "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "value_transformer": { - "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9140,36 +9600,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": "[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": "[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": "[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": "[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": "[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": "[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": "[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": "[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 @@ -9227,16 +9695,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, @@ -9260,6 +9731,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9276,6 +9753,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -9291,67 +9772,77 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "folder_filter": { - "description": "Deprecated. Use include_folders instead.", + "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "include_folders": { - "description": "(Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", + "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "include_senders": { - "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", + "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sender_filter": { - "description": "Deprecated. Use include_senders instead.", + "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "start_date": { - "description": "(Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9371,8 +9862,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 @@ -9525,9 +10017,10 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "kind": { @@ -9539,9 +10032,10 @@ "$ref": "#/$defs/string" }, "version_id": { - "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9566,19 +10060,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": { @@ -9645,13 +10142,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 } }, @@ -9670,8 +10169,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 @@ -9689,12 +10189,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 @@ -9711,24 +10213,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, @@ -9750,21 +10257,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-preview": "PRIVATE", + "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.", + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "time_zone_id": { - "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9808,28 +10318,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, @@ -9851,21 +10367,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_ingestion_options": { - "description": "(Optional) File ingestion options for processing files.", + "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "url": { - "description": "Required. The SharePoint URL.", + "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9886,6 +10405,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9901,9 +10426,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9922,12 +10448,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 @@ -9944,12 +10472,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 } }, @@ -9967,36 +10498,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, @@ -10018,46 +10557,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 } }, @@ -10078,6 +10628,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10093,45 +10648,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-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "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.)", + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "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.", + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10153,6 +10715,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -10173,6 +10741,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -10188,14 +10764,17 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "Required: the wire format of the data.", + "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "json_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10214,6 +10793,10 @@ "enum": [ "STRING", "JSON" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -10229,9 +10812,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10249,16 +10833,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": "[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": "[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": "[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, @@ -10280,8 +10867,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": "[Beta] A raw representation of Postgres settings.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -10300,6 +10888,10 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -10314,16 +10906,19 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string" + "description": "[Beta] Budget policy to set on the newly created pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "storage_catalog": { - "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string" + "description": "[Beta] UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "storage_schema": { - "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string" + "description": "[Beta] UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -10340,12 +10935,14 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", - "$ref": "#/$defs/string" + "description": "[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": "[Beta] The value of the custom tag.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -10363,24 +10960,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": "[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": "[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": "[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": "[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": "[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 @@ -10400,6 +11002,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" ] }, { @@ -10440,8 +11047,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.", @@ -10470,22 +11078,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 } @@ -10504,8 +11116,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 @@ -10524,6 +11137,11 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10538,12 +11156,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 @@ -10630,6 +11250,12 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10644,6 +11270,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, { @@ -10725,6 +11354,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11082,6 +11717,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11263,6 +11909,10 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -11277,6 +11927,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, { @@ -11319,8 +11972,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**.", @@ -11338,8 +11992,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.", @@ -11362,8 +12017,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.", @@ -11392,16 +12048,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.", @@ -11430,8 +12088,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.", @@ -11471,6 +12130,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11508,6 +12175,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11547,6 +12222,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11565,6 +12250,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11580,6 +12271,10 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -11594,24 +12289,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, @@ -11632,15 +12332,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 @@ -11657,10 +12361,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 @@ -11677,13 +12385,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, @@ -11703,13 +12417,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 @@ -11726,12 +12446,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 @@ -11748,10 +12470,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 @@ -11813,6 +12539,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11843,16 +12579,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, @@ -11911,6 +12650,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -12065,6 +12808,10 @@ "enum": [ "STORAGE_OPTIMIZED", "STANDARD" + ], + "enumDescriptions": [ + "[PuPr]", + "" ] }, { @@ -12082,6 +12829,11 @@ "VECTOR", "FULL_TEXT", "HYBRID" + ], + "enumDescriptions": [ + "[Beta] Not supported. Use `HYBRID` instead.", + "[Beta] An index that uses full-text search without vector embeddings.", + "[Beta] An index that uses vector embeddings for similarity search and hybrid search." ] }, { @@ -12098,6 +12850,10 @@ "enum": [ "TRIGGERED", "CONTINUOUS" + ], + "enumDescriptions": [ + "If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.", + "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh." ] }, { @@ -12114,6 +12870,10 @@ "enum": [ "DELTA_SYNC", "DIRECT_ACCESS" + ], + "enumDescriptions": [ + "An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.", + "An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates." ] }, { diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 7c5aa72fd20..9f76c549245 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,18 +109,24 @@ "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_max_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, @@ -151,22 +177,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" } }, @@ -584,17 +617,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": { @@ -603,8 +640,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" } }, @@ -620,23 +658,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": "[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": { @@ -645,18 +687,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": { @@ -664,18 +709,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": "[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" } }, @@ -747,8 +795,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": { @@ -854,9 +903,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" }, @@ -1167,8 +1217,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": { @@ -1207,8 +1258,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": { @@ -1222,9 +1274,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" }, @@ -1234,8 +1287,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": { @@ -1259,7 +1313,9 @@ "x-since-version": "v0.229.0" }, "parameters": { + "description": "[Beta]", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.2.0" }, "permissions": { @@ -1272,15 +1328,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": { @@ -1322,9 +1380,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" } @@ -1629,9 +1688,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" }, @@ -2004,7 +2064,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": { @@ -2012,15 +2074,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" } }, @@ -2033,7 +2101,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": { @@ -2053,12 +2123,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" } @@ -2089,7 +2163,9 @@ "x-since-version": "v1.1.0" }, "index_subtype": { + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "index_type": { @@ -3675,9 +3751,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -3807,9 +3884,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" } @@ -4332,6 +4410,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "compute.DataSecurityMode": { @@ -4348,6 +4430,18 @@ "DATA_SECURITY_MODE_STANDARD", "DATA_SECURITY_MODE_DEDICATED", "DATA_SECURITY_MODE_AUTO" + ], + "enumDescriptions": [ + "", + "Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.", + "Legacy alias for `DATA_SECURITY_MODE_STANDARD`.", + "This mode is for users migrating from legacy Table ACL clusters.", + "This mode is for users migrating from legacy Passthrough on high concurrency clusters.", + "This mode is for users migrating from legacy Passthrough on standard clusters.", + "This mode provides a way that doesn’t have UC nor passthrough enabled.", + "A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.", + "A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.", + "\u003cDatabricks\u003e will choose the most appropriate access mode depending on your compute configuration." ] }, "compute.DbfsStorageInfo": { @@ -4431,7 +4525,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" } }, @@ -4451,9 +4547,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" }, @@ -4517,6 +4614,10 @@ "enum": [ "GPU_1xA10", "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "compute.InitScriptInfo": { @@ -4827,13 +4928,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" } }, @@ -4844,18 +4947,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" } }, @@ -4870,6 +4976,14 @@ "STOPPED", "UPDATING", "FAILING_OVER" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.DeltaTableSyncInfo": { @@ -4881,18 +4995,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": "[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" } }, @@ -4907,6 +5024,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.ProvisioningPhase": { @@ -4915,6 +5040,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.SyncedTableContinuousUpdateStatus": { @@ -4947,6 +5077,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.SyncedTableSpec": { @@ -4954,38 +5089,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" } }, @@ -5006,6 +5148,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": { @@ -5013,23 +5168,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" } }, @@ -5064,29 +5223,55 @@ "CAN_CREATE", "CAN_MONITOR_ONLY", "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 Preview] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "subscribers": { - "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "description": "[Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", + "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "workspace_path": { - "description": "The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", + "description": "[Public Preview] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" } }, @@ -5097,12 +5282,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 Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "user_name": { - "description": "A valid workspace email address.", + "description": "[Public Preview] A valid workspace email address.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" } }, @@ -5113,6 +5301,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "jobs.CleanRoomsNotebookTask": { @@ -5150,8 +5342,9 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" } }, @@ -5161,23 +5354,26 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", + "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" } @@ -5282,9 +5478,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" }, @@ -5305,16 +5502,18 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.256.0" } @@ -5325,16 +5524,18 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" } @@ -5445,57 +5646,66 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "compute": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "dl_runtime_image": { - "description": "Runtime image", + "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "mlflow_experiment_name": { - "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" } @@ -5594,9 +5804,10 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, @@ -5611,9 +5822,10 @@ "x-since-version": "v0.229.0" }, "version_id": { - "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" } @@ -5629,6 +5841,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": { @@ -5637,6 +5853,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": { @@ -5665,8 +5885,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": { @@ -5746,9 +5967,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" }, @@ -5770,23 +5992,26 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -5803,6 +6028,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": { @@ -5814,6 +6043,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": { @@ -5862,37 +6098,42 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" } @@ -5908,6 +6149,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "jobs.NotebookTask": { @@ -5991,23 +6237,27 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -6022,13 +6272,15 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "parameters": { - "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.2.0" }, "pipeline_id": { @@ -6037,18 +6289,21 @@ "x-since-version": "v0.229.0" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -6061,28 +6316,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" } }, @@ -6092,23 +6352,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" } }, @@ -6118,28 +6382,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" } }, @@ -6149,16 +6418,18 @@ "type": "object", "properties": { "main": { - "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "parameters": { - "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", + "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -6169,14 +6440,18 @@ "type": "object", "properties": { "name": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -6237,24 +6512,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", @@ -6271,9 +6556,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", @@ -6285,35 +6571,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", @@ -6331,6 +6622,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, "jobs.SparkJarTask": { @@ -6556,6 +6851,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "jobs.Subscription": { @@ -6625,8 +6925,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 Preview] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "clean_rooms_notebook_task": { @@ -6635,8 +6936,9 @@ "x-since-version": "v0.237.0" }, "compute": { - "description": "Task level compute configuration.", + "description": "[Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" }, "condition_task": { @@ -6650,17 +6952,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" }, @@ -6710,8 +7015,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" }, @@ -6760,14 +7067,16 @@ "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_operator_task": { - "description": "The task runs a Python operator task.", + "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, @@ -6879,8 +7188,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": { @@ -6929,8 +7239,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" }, @@ -6983,8 +7295,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": { @@ -7054,13 +7367,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" } }, @@ -7074,8 +7389,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" } }, @@ -7085,9 +7401,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" } @@ -7099,70 +7416,84 @@ "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": "[Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "kafka_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-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" } @@ -7175,6 +7506,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "pipelines.CronTrigger": { @@ -7196,18 +7531,21 @@ "description": "Location of staged data storage", "properties": { "catalog_name": { - "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the schema for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "volume_name": { - "description": "(Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", + "description": "[Beta] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" } }, @@ -7228,6 +7566,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "pipelines.DeploymentKind": { @@ -7263,23 +7610,26 @@ "type": "object", "properties": { "modified_after": { - "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7290,74 +7640,90 @@ "type": "object", "properties": { "corrupt_record_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_filters": { - "description": "Generic options", + "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format": { - "description": "required for TableSpec", + "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format_options": { - "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "ignore_corrupt_files": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "infer_column_types": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "reader_case_sensitive": { - "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "rescued_data_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_evolution_mode": { - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "single_variant_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7375,6 +7741,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7386,6 +7762,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.FileLibrary": { @@ -7419,9 +7802,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -7433,23 +7817,26 @@ "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "properties": { "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7463,21 +7850,26 @@ "type": "object", "properties": { "entity_type": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { - "description": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7490,24 +7882,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" } }, @@ -7517,46 +7917,52 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -7572,54 +7978,65 @@ "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": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "data_staging_options": { - "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "description": "[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "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" } }, @@ -7630,18 +8047,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": "[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" } }, @@ -7651,25 +8071,28 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.271.0", @@ -7682,16 +8105,18 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", + "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" } @@ -7721,6 +8146,28 @@ "META_MARKETING", "ZENDESK", "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": { @@ -7728,8 +8175,9 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", + "description": "[Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" } }, @@ -7739,37 +8187,42 @@ "type": "object", "properties": { "as_variant": { - "description": "Parse the entire value as a single Variant column.", + "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema": { - "description": "Inline schema string for JSON parsing (Spark DDL format).", + "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_evolution_mode": { - "description": "(Optional) Schema evolution mode for schema inference.", + "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_file_path": { - "description": "Path to a schema file (.ddl).", + "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_hints": { - "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -7780,51 +8233,58 @@ "type": "object", "properties": { "client_config": { - "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "key_transformer": { - "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "max_offsets_per_trigger": { - "description": "Internal option to control the maximum number of offsets to process per trigger.", + "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "starting_offset": { - "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topic_pattern": { - "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topics": { - "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value_transformer": { - "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -7840,43 +8300,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": "[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": "[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": "[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": "[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": "[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": "[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": "[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": "[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" } }, @@ -7914,18 +8382,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" } }, @@ -7942,6 +8413,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.OutlookBodyFormat": { @@ -7950,6 +8427,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "pipelines.OutlookOptions": { @@ -7957,76 +8438,86 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.299.2", @@ -8039,8 +8530,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" } }, @@ -8184,9 +8676,10 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, @@ -8201,9 +8694,10 @@ "x-since-version": "v0.229.0" }, "version_id": { - "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" } @@ -8222,21 +8716,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" }, @@ -8284,14 +8781,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" } @@ -8303,8 +8802,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" } }, @@ -8315,13 +8815,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" } }, @@ -8331,28 +8833,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" } }, @@ -8367,23 +8874,26 @@ "type": "object", "properties": { "days_of_week": { - "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", + "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" } @@ -8414,33 +8924,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" } }, @@ -8455,23 +8971,26 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -8485,6 +9004,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.SmartsheetOptions": { @@ -8492,9 +9017,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8506,13 +9032,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" } }, @@ -8522,13 +9050,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" } @@ -8539,43 +9070,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" } }, @@ -8590,55 +9129,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" } @@ -8652,6 +9202,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "pipelines.TikTokAdsOptions": { @@ -8659,51 +9214,58 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -8718,6 +9280,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -8730,6 +9298,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.Transformer": { @@ -8737,15 +9313,18 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "Required: the wire format of the data.", + "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "json_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -8757,6 +9336,10 @@ "enum": [ "STRING", "JSON" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "pipelines.ZendeskSupportOptions": { @@ -8764,9 +9347,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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8777,18 +9361,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": "[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": "[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": "[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" } }, @@ -8803,8 +9390,9 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" } }, @@ -8816,24 +9404,31 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "postgres.NewPipelineSpec": { "type": "object", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "storage_catalog": { - "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "storage_schema": { - "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" } }, @@ -8843,13 +9438,15 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[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": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" } }, @@ -8860,28 +9457,33 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "autoscaling_limit_max_cu": { - "description": "The maximum number of Compute Units. Minimum value is 0.5.", + "description": "[Beta] The maximum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", + "x-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": "[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": "[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": "[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": "[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" } }, @@ -8894,6 +9496,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" ] }, "serving.Ai21LabsConfig": { @@ -8921,8 +9528,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": { @@ -8947,25 +9555,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 @@ -8977,8 +9589,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" } }, @@ -8990,19 +9603,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" } }, @@ -9075,12 +9695,21 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.AiGatewayRateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, "serving.AiGatewayUsageTrackingConfig": { @@ -9146,6 +9775,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.AnthropicConfig": { @@ -9447,6 +10082,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.FallbackConfig": { @@ -9601,12 +10247,19 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "serving.RateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, "serving.Route": { @@ -9636,8 +10289,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": { @@ -9660,8 +10314,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": { @@ -9690,8 +10345,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": { @@ -9716,8 +10372,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": { @@ -9726,8 +10383,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": { @@ -9764,8 +10422,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": { @@ -9801,6 +10460,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.ServingEndpointPermissionLevel": { @@ -9822,6 +10489,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.TrafficConfig": { @@ -9846,6 +10521,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.AlertEvaluationState": { @@ -9856,6 +10541,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.AlertLifecycleState": { @@ -9863,34 +10554,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" } }, @@ -9904,17 +10604,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" } }, @@ -9924,11 +10628,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" } }, @@ -9938,15 +10646,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" } }, @@ -9959,15 +10673,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" } }, @@ -9977,13 +10697,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" } }, @@ -9993,11 +10715,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" } }, @@ -10038,6 +10764,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.CreateWarehouseRequestWarehouseType": { @@ -10052,18 +10788,21 @@ "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" } }, @@ -10102,6 +10841,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "sql.SpotInstancePolicy": { @@ -10215,6 +10958,10 @@ "enum": [ "STORAGE_OPTIMIZED", "STANDARD" + ], + "enumDescriptions": [ + "[PuPr]", + "" ] }, "vectorsearch.IndexSubtype": { @@ -10224,6 +10971,11 @@ "VECTOR", "FULL_TEXT", "HYBRID" + ], + "enumDescriptions": [ + "[Beta] Not supported. Use `HYBRID` instead.", + "[Beta] An index that uses full-text search without vector embeddings.", + "[Beta] An index that uses vector embeddings for similarity search and hybrid search." ] }, "vectorsearch.PipelineType": { @@ -10232,6 +10984,10 @@ "enum": [ "TRIGGERED", "CONTINUOUS" + ], + "enumDescriptions": [ + "If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.", + "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh." ] }, "vectorsearch.VectorIndexType": { @@ -10240,6 +10996,10 @@ "enum": [ "DELTA_SYNC", "DIRECT_ACCESS" + ], + "enumDescriptions": [ + "An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.", + "An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates." ] }, "workspace.AzureKeyVaultSecretScopeMetadata": { diff --git a/libs/jsonschema/extension.go b/libs/jsonschema/extension.go index 0bc23afcb1b..17ee101213a 100644 --- a/libs/jsonschema/extension.go +++ b/libs/jsonschema/extension.go @@ -48,6 +48,17 @@ type Extension struct { // from the generated Sphinx documentation. Preview string `json:"x-databricks-preview,omitempty"` + // LaunchStage indicates the field's launch stage from cli.json + // (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"` + + // EnumDescriptions is the parallel-array form emitted alongside Enum. VSCode + // renders these next to each enum value in autocomplete dropdowns. Each entry + // combines the per-value launch-stage label and textual description sourced + // from cli.json's enum_launch_stages and enum_descriptions. + EnumDescriptions []string `json:"enumDescriptions,omitempty"` + // This field is not in JSON schema spec, but it is supported in VSCode and in the Databricks Workspace // It is used to provide a rich description of the field in the hover tooltip. // https://code.visualstudio.com/docs/languages/json#_use-rich-formatting-in-hovers diff --git a/python/databricks/bundles/jobs/_models/alert_task.py b/python/databricks/bundles/jobs/_models/alert_task.py index b044b797780..66da2e9e4e7 100644 --- a/python/databricks/bundles/jobs/_models/alert_task.py +++ b/python/databricks/bundles/jobs/_models/alert_task.py @@ -19,23 +19,23 @@ class AlertTask: alert_id: VariableOrOptional[str] = None """ - The alert_id is the canonical identifier of the alert. + [Public Preview] The alert_id is the canonical identifier of the alert. """ subscribers: VariableOrList[AlertTaskSubscriber] = field(default_factory=list) """ - The subscribers receive alert evaluation result notifications after the alert task is completed. + [Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. """ warehouse_id: VariableOrOptional[str] = None """ - The warehouse_id identifies the warehouse settings used by the alert task. + [Public Preview] The warehouse_id identifies the warehouse settings used by the alert task. """ workspace_path: VariableOrOptional[str] = None """ - The workspace_path is the path to the alert file in the workspace. The path: + [Public Preview] The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. @@ -54,23 +54,23 @@ class AlertTaskDict(TypedDict, total=False): alert_id: VariableOrOptional[str] """ - The alert_id is the canonical identifier of the alert. + [Public Preview] The alert_id is the canonical identifier of the alert. """ subscribers: VariableOrList[AlertTaskSubscriberParam] """ - The subscribers receive alert evaluation result notifications after the alert task is completed. + [Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. """ warehouse_id: VariableOrOptional[str] """ - The warehouse_id identifies the warehouse settings used by the alert task. + [Public Preview] The warehouse_id identifies the warehouse settings used by the alert task. """ workspace_path: VariableOrOptional[str] """ - The workspace_path is the path to the alert file in the workspace. The path: + [Public Preview] The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. diff --git a/python/databricks/bundles/jobs/_models/alert_task_subscriber.py b/python/databricks/bundles/jobs/_models/alert_task_subscriber.py index a66936f9b40..0921eb11524 100644 --- a/python/databricks/bundles/jobs/_models/alert_task_subscriber.py +++ b/python/databricks/bundles/jobs/_models/alert_task_subscriber.py @@ -17,10 +17,13 @@ class AlertTaskSubscriber: """ destination_id: VariableOrOptional[str] = None + """ + [Public Preview] + """ user_name: VariableOrOptional[str] = None """ - A valid workspace email address. + [Public Preview] A valid workspace email address. """ @classmethod @@ -35,10 +38,13 @@ class AlertTaskSubscriberDict(TypedDict, total=False): """""" destination_id: VariableOrOptional[str] + """ + [Public Preview] + """ user_name: VariableOrOptional[str] """ - A valid workspace email address. + [Public Preview] A valid workspace email address. """ diff --git a/python/databricks/bundles/jobs/_models/compute.py b/python/databricks/bundles/jobs/_models/compute.py index d5803f81302..3df3b13d7fc 100644 --- a/python/databricks/bundles/jobs/_models/compute.py +++ b/python/databricks/bundles/jobs/_models/compute.py @@ -19,7 +19,7 @@ class Compute: hardware_accelerator: VariableOrOptional[HardwareAcceleratorType] = None """ - Hardware accelerator configuration for Serverless GPU workloads. + [Beta] Hardware accelerator configuration for Serverless GPU workloads. """ @classmethod @@ -35,7 +35,7 @@ class ComputeDict(TypedDict, total=False): hardware_accelerator: VariableOrOptional[HardwareAcceleratorTypeParam] """ - Hardware accelerator configuration for Serverless GPU workloads. + [Beta] Hardware accelerator configuration for Serverless GPU workloads. """ diff --git a/python/databricks/bundles/jobs/_models/compute_config.py b/python/databricks/bundles/jobs/_models/compute_config.py index e688eb0cd34..116d91392a4 100644 --- a/python/databricks/bundles/jobs/_models/compute_config.py +++ b/python/databricks/bundles/jobs/_models/compute_config.py @@ -19,21 +19,21 @@ class ComputeConfig: """ :meta private: [EXPERIMENTAL] - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - GPU type. + [Private Preview] GPU type. """ @classmethod @@ -51,21 +51,21 @@ class ComputeConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - GPU type. + [Private Preview] GPU type. """ diff --git a/python/databricks/bundles/jobs/_models/dashboard_task.py b/python/databricks/bundles/jobs/_models/dashboard_task.py index 4f9cd829a1a..c38c14f83df 100644 --- a/python/databricks/bundles/jobs/_models/dashboard_task.py +++ b/python/databricks/bundles/jobs/_models/dashboard_task.py @@ -22,7 +22,7 @@ class DashboardTask: """ :meta private: [EXPERIMENTAL] - Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key. + [Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key. The parameter value format is dependent on the filter type: - For text and single-select filters, provide a single value (e.g. `"value"`) - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) @@ -55,7 +55,7 @@ class DashboardTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key. + [Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key. The parameter value format is dependent on the filter type: - For text and single-select filters, provide a single value (e.g. `"value"`) - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) diff --git a/python/databricks/bundles/jobs/_models/dbt_platform_task.py b/python/databricks/bundles/jobs/_models/dbt_platform_task.py index 82ebe71e220..992b8e9e922 100644 --- a/python/databricks/bundles/jobs/_models/dbt_platform_task.py +++ b/python/databricks/bundles/jobs/_models/dbt_platform_task.py @@ -19,14 +19,14 @@ class DbtPlatformTask: """ :meta private: [EXPERIMENTAL] - The resource name of the UC connection that authenticates the dbt platform for this task + [Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + [Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ @classmethod @@ -44,14 +44,14 @@ class DbtPlatformTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The resource name of the UC connection that authenticates the dbt platform for this task + [Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + [Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ diff --git a/python/databricks/bundles/jobs/_models/environment.py b/python/databricks/bundles/jobs/_models/environment.py index 4324405f024..98b8e209434 100644 --- a/python/databricks/bundles/jobs/_models/environment.py +++ b/python/databricks/bundles/jobs/_models/environment.py @@ -47,6 +47,9 @@ class Environment: """ java_dependencies: VariableOrList[str] = field(default_factory=list) + """ + [Public Preview] + """ @classmethod def from_dict(cls, value: "EnvironmentDict") -> "Self": @@ -90,6 +93,9 @@ class EnvironmentDict(TypedDict, total=False): """ java_dependencies: VariableOrList[str] + """ + [Public Preview] + """ EnvironmentParam = EnvironmentDict | Environment diff --git a/python/databricks/bundles/jobs/_models/gcp_attributes.py b/python/databricks/bundles/jobs/_models/gcp_attributes.py index 0ab838fe214..e87ff1ab37c 100644 --- a/python/databricks/bundles/jobs/_models/gcp_attributes.py +++ b/python/databricks/bundles/jobs/_models/gcp_attributes.py @@ -34,7 +34,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -105,7 +105,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py index 9bc82df2e20..d4d22f2f271 100644 --- a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py +++ b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py @@ -24,26 +24,28 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Command launcher to run the actual script, e.g. bash, python etc. + [Private Preview] Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfig] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ mlflow_experiment_name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional string containing the name of the MLflow experiment to log the run to. If name is not + [Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. """ @@ -51,7 +53,7 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository + [Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `GIT`: Script is located in cloud Git provider. @@ -61,14 +63,14 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. + [Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. """ yaml_parameters: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional string containing model parameters passed to the training script in yaml format. + [Private Preview] Optional string containing model parameters passed to the training script in yaml format. If present, then the content in yaml_parameters_file_path will be ignored. """ @@ -76,7 +78,7 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - Optional path to a YAML file containing model parameters passed to the training script. + [Private Preview] Optional path to a YAML file containing model parameters passed to the training script. """ @classmethod @@ -94,26 +96,28 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Command launcher to run the actual script, e.g. bash, python etc. + [Private Preview] Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfigParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ mlflow_experiment_name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional string containing the name of the MLflow experiment to log the run to. If name is not + [Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. """ @@ -121,7 +125,7 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository + [Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `GIT`: Script is located in cloud Git provider. @@ -131,14 +135,14 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. + [Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. """ yaml_parameters: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional string containing model parameters passed to the training script in yaml format. + [Private Preview] Optional string containing model parameters passed to the training script in yaml format. If present, then the content in yaml_parameters_file_path will be ignored. """ @@ -146,7 +150,7 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Optional path to a YAML file containing model parameters passed to the training script. + [Private Preview] Optional path to a YAML file containing model parameters passed to the training script. """ diff --git a/python/databricks/bundles/jobs/_models/job.py b/python/databricks/bundles/jobs/_models/job.py index e836d4c9a89..d75cd7b1200 100644 --- a/python/databricks/bundles/jobs/_models/job.py +++ b/python/databricks/bundles/jobs/_models/job.py @@ -73,7 +73,7 @@ class Job(Resource): budget_policy_id: VariableOrOptional[str] = None """ - The id of the user specified budget policy to use for this job. + [Public Preview] The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. """ @@ -195,7 +195,7 @@ class Job(Resource): """ :meta private: [EXPERIMENTAL] - The id of the user specified usage policy to use for this job. + [Private Preview] The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the usage policy used by this workload. """ @@ -218,7 +218,7 @@ class JobDict(TypedDict, total=False): budget_policy_id: VariableOrOptional[str] """ - The id of the user specified budget policy to use for this job. + [Public Preview] The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. """ @@ -340,7 +340,7 @@ class JobDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The id of the user specified usage policy to use for this job. + [Private Preview] The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the usage policy used by this workload. """ diff --git a/python/databricks/bundles/jobs/_models/job_email_notifications.py b/python/databricks/bundles/jobs/_models/job_email_notifications.py index b97648f4dce..e8474261a8d 100644 --- a/python/databricks/bundles/jobs/_models/job_email_notifications.py +++ b/python/databricks/bundles/jobs/_models/job_email_notifications.py @@ -38,7 +38,7 @@ class JobEmailNotifications: on_streaming_backlog_exceeded: VariableOrList[str] = field(default_factory=list) """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ @@ -82,7 +82,7 @@ class JobEmailNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[str] """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ diff --git a/python/databricks/bundles/jobs/_models/job_run_as.py b/python/databricks/bundles/jobs/_models/job_run_as.py index ac980cfc75b..4e5c4a72e26 100644 --- a/python/databricks/bundles/jobs/_models/job_run_as.py +++ b/python/databricks/bundles/jobs/_models/job_run_as.py @@ -21,7 +21,7 @@ class JobRunAs: """ :meta private: [EXPERIMENTAL] - Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. + [Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. """ service_principal_name: VariableOrOptional[str] = None @@ -49,7 +49,7 @@ class JobRunAsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. + [Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. """ service_principal_name: VariableOrOptional[str] diff --git a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py index a253b8d7dba..eebf5713a93 100644 --- a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py +++ b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py @@ -27,21 +27,21 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - The condition based on which to trigger a job run. + [Private Preview] The condition based on which to trigger a job run. """ aliases: VariableOrList[str] = field(default_factory=list) """ :meta private: [EXPERIMENTAL] - Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. + [Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] = None """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after the specified amount of time has passed since + [Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. """ @@ -49,7 +49,7 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, + [Private Preview] Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, "mycatalog.myschema" in the case of schema-level triggers) or empty in the case of metastore-level triggers. """ @@ -57,7 +57,7 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after no model updates have occurred for the specified time + [Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The minimum allowed value is 60 seconds. """ @@ -77,21 +77,21 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The condition based on which to trigger a job run. + [Private Preview] The condition based on which to trigger a job run. """ aliases: VariableOrList[str] """ :meta private: [EXPERIMENTAL] - Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. + [Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after the specified amount of time has passed since + [Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. """ @@ -99,7 +99,7 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, + [Private Preview] Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, "mycatalog.myschema" in the case of schema-level triggers) or empty in the case of metastore-level triggers. """ @@ -107,7 +107,7 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after no model updates have occurred for the specified time + [Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The minimum allowed value is 60 seconds. """ diff --git a/python/databricks/bundles/jobs/_models/pipeline_params.py b/python/databricks/bundles/jobs/_models/pipeline_params.py index 488018cb3d8..6c653b3e6c3 100644 --- a/python/databricks/bundles/jobs/_models/pipeline_params.py +++ b/python/databricks/bundles/jobs/_models/pipeline_params.py @@ -20,23 +20,23 @@ class PipelineParams: full_refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ refresh_flow_selection: VariableOrList[str] = field(default_factory=list) """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] = field(default_factory=list) """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ @classmethod @@ -57,23 +57,23 @@ class PipelineParamsDict(TypedDict, total=False): full_refresh_selection: VariableOrList[str] """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ refresh_flow_selection: VariableOrList[str] """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ diff --git a/python/databricks/bundles/jobs/_models/pipeline_task.py b/python/databricks/bundles/jobs/_models/pipeline_task.py index 5489156892b..256a5d8f913 100644 --- a/python/databricks/bundles/jobs/_models/pipeline_task.py +++ b/python/databricks/bundles/jobs/_models/pipeline_task.py @@ -30,29 +30,29 @@ class PipelineTask: full_refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ parameters: VariableOrDict[str] = field(default_factory=dict) """ - Key/value-map of parameters passed to the pipeline execution. + [Beta] Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. """ refresh_flow_selection: VariableOrList[str] = field(default_factory=list) """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] = field(default_factory=list) """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ @classmethod @@ -78,29 +78,29 @@ class PipelineTaskDict(TypedDict, total=False): full_refresh_selection: VariableOrList[str] """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ parameters: VariableOrDict[str] """ - Key/value-map of parameters passed to the pipeline execution. + [Beta] Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. """ refresh_flow_selection: VariableOrList[str] """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_model.py b/python/databricks/bundles/jobs/_models/power_bi_model.py index b31c5735abb..72ddd53ea21 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_model.py +++ b/python/databricks/bundles/jobs/_models/power_bi_model.py @@ -20,27 +20,27 @@ class PowerBiModel: authentication_method: VariableOrOptional[AuthenticationMethod] = None """ - How the published Power BI model authenticates to Databricks + [Public Preview] How the published Power BI model authenticates to Databricks """ model_name: VariableOrOptional[str] = None """ - The name of the Power BI model + [Public Preview] The name of the Power BI model """ overwrite_existing: VariableOrOptional[bool] = None """ - Whether to overwrite existing Power BI models + [Public Preview] Whether to overwrite existing Power BI models """ storage_mode: VariableOrOptional[StorageMode] = None """ - The default storage mode of the Power BI model + [Public Preview] The default storage mode of the Power BI model """ workspace_name: VariableOrOptional[str] = None """ - The name of the Power BI workspace of the model + [Public Preview] The name of the Power BI workspace of the model """ @classmethod @@ -56,27 +56,27 @@ class PowerBiModelDict(TypedDict, total=False): authentication_method: VariableOrOptional[AuthenticationMethodParam] """ - How the published Power BI model authenticates to Databricks + [Public Preview] How the published Power BI model authenticates to Databricks """ model_name: VariableOrOptional[str] """ - The name of the Power BI model + [Public Preview] The name of the Power BI model """ overwrite_existing: VariableOrOptional[bool] """ - Whether to overwrite existing Power BI models + [Public Preview] Whether to overwrite existing Power BI models """ storage_mode: VariableOrOptional[StorageModeParam] """ - The default storage mode of the Power BI model + [Public Preview] The default storage mode of the Power BI model """ workspace_name: VariableOrOptional[str] """ - The name of the Power BI workspace of the model + [Public Preview] The name of the Power BI workspace of the model """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_table.py b/python/databricks/bundles/jobs/_models/power_bi_table.py index 83e433da6d8..4c91b194cf5 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_table.py +++ b/python/databricks/bundles/jobs/_models/power_bi_table.py @@ -16,22 +16,22 @@ class PowerBiTable: catalog: VariableOrOptional[str] = None """ - The catalog name in Databricks + [Public Preview] The catalog name in Databricks """ name: VariableOrOptional[str] = None """ - The table name in Databricks + [Public Preview] The table name in Databricks """ schema: VariableOrOptional[str] = None """ - The schema name in Databricks + [Public Preview] The schema name in Databricks """ storage_mode: VariableOrOptional[StorageMode] = None """ - The Power BI storage mode of the table + [Public Preview] The Power BI storage mode of the table """ @classmethod @@ -47,22 +47,22 @@ class PowerBiTableDict(TypedDict, total=False): catalog: VariableOrOptional[str] """ - The catalog name in Databricks + [Public Preview] The catalog name in Databricks """ name: VariableOrOptional[str] """ - The table name in Databricks + [Public Preview] The table name in Databricks """ schema: VariableOrOptional[str] """ - The schema name in Databricks + [Public Preview] The schema name in Databricks """ storage_mode: VariableOrOptional[StorageModeParam] """ - The Power BI storage mode of the table + [Public Preview] The Power BI storage mode of the table """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_task.py b/python/databricks/bundles/jobs/_models/power_bi_task.py index ceea220ed89..61d6930d1bf 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_task.py +++ b/python/databricks/bundles/jobs/_models/power_bi_task.py @@ -23,27 +23,27 @@ class PowerBiTask: connection_resource_name: VariableOrOptional[str] = None """ - The resource name of the UC connection to authenticate from Databricks to Power BI + [Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI """ power_bi_model: VariableOrOptional[PowerBiModel] = None """ - The semantic model to update + [Public Preview] The semantic model to update """ refresh_after_update: VariableOrOptional[bool] = None """ - Whether the model should be refreshed after the update + [Public Preview] Whether the model should be refreshed after the update """ tables: VariableOrList[PowerBiTable] = field(default_factory=list) """ - The tables to be exported to Power BI + [Public Preview] The tables to be exported to Power BI """ warehouse_id: VariableOrOptional[str] = None """ - The SQL warehouse ID to use as the Power BI data source + [Public Preview] The SQL warehouse ID to use as the Power BI data source """ @classmethod @@ -59,27 +59,27 @@ class PowerBiTaskDict(TypedDict, total=False): connection_resource_name: VariableOrOptional[str] """ - The resource name of the UC connection to authenticate from Databricks to Power BI + [Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI """ power_bi_model: VariableOrOptional[PowerBiModelParam] """ - The semantic model to update + [Public Preview] The semantic model to update """ refresh_after_update: VariableOrOptional[bool] """ - Whether the model should be refreshed after the update + [Public Preview] Whether the model should be refreshed after the update """ tables: VariableOrList[PowerBiTableParam] """ - The tables to be exported to Power BI + [Public Preview] The tables to be exported to Power BI """ warehouse_id: VariableOrOptional[str] """ - The SQL warehouse ID to use as the Power BI data source + [Public Preview] The SQL warehouse ID to use as the Power BI data source """ diff --git a/python/databricks/bundles/jobs/_models/python_operator_task.py b/python/databricks/bundles/jobs/_models/python_operator_task.py index cf6f4760ba3..be557e49e63 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task.py @@ -23,7 +23,7 @@ class PythonOperatorTask: """ :meta private: [EXPERIMENTAL] - Fully qualified name of the main class or function. + [Private Preview] Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ @@ -33,7 +33,7 @@ class PythonOperatorTask: """ :meta private: [EXPERIMENTAL] - An ordered list of task parameters. + [Private Preview] An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ @@ -52,7 +52,7 @@ class PythonOperatorTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Fully qualified name of the main class or function. + [Private Preview] Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ @@ -60,7 +60,7 @@ class PythonOperatorTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - An ordered list of task parameters. + [Private Preview] An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ diff --git a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py index b1f252b3106..e109668e4e2 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py @@ -18,11 +18,15 @@ class PythonOperatorTaskParameter: name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ value: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -39,11 +43,15 @@ class PythonOperatorTaskParameterDict(TypedDict, total=False): name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ value: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/jobs/_models/task.py b/python/databricks/bundles/jobs/_models/task.py index 8cb2fe0c273..19f12c8a993 100644 --- a/python/databricks/bundles/jobs/_models/task.py +++ b/python/databricks/bundles/jobs/_models/task.py @@ -110,7 +110,7 @@ class Task: alert_task: VariableOrOptional[AlertTask] = None """ - The task evaluates a Databricks alert and sends notifications to subscribers + [Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. """ @@ -122,7 +122,7 @@ class Task: compute: VariableOrOptional[Compute] = None """ - Task level compute configuration. + [Beta] Task level compute configuration. """ condition_task: VariableOrOptional[ConditionTask] = None @@ -139,6 +139,8 @@ class Task: dbt_platform_task: VariableOrOptional[DbtPlatformTask] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ dbt_task: VariableOrOptional[DbtTask] = None @@ -193,6 +195,8 @@ class Task: gen_ai_compute_task: VariableOrOptional[GenAiComputeTask] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ health: VariableOrOptional[JobsHealthRules] = None @@ -240,14 +244,14 @@ class Task: power_bi_task: VariableOrOptional[PowerBiTask] = None """ - The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + [Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present. """ python_operator_task: VariableOrOptional[PythonOperatorTask] = None """ :meta private: [EXPERIMENTAL] - The task runs a Python operator task. + [Private Preview] The task runs a Python operator task. """ python_wheel_task: VariableOrOptional[PythonWheelTask] = None @@ -328,7 +332,7 @@ class TaskDict(TypedDict, total=False): alert_task: VariableOrOptional[AlertTaskParam] """ - The task evaluates a Databricks alert and sends notifications to subscribers + [Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. """ @@ -340,7 +344,7 @@ class TaskDict(TypedDict, total=False): compute: VariableOrOptional[ComputeParam] """ - Task level compute configuration. + [Beta] Task level compute configuration. """ condition_task: VariableOrOptional[ConditionTaskParam] @@ -357,6 +361,8 @@ class TaskDict(TypedDict, total=False): dbt_platform_task: VariableOrOptional[DbtPlatformTaskParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ dbt_task: VariableOrOptional[DbtTaskParam] @@ -411,6 +417,8 @@ class TaskDict(TypedDict, total=False): gen_ai_compute_task: VariableOrOptional[GenAiComputeTaskParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ health: VariableOrOptional[JobsHealthRulesParam] @@ -458,14 +466,14 @@ class TaskDict(TypedDict, total=False): power_bi_task: VariableOrOptional[PowerBiTaskParam] """ - The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + [Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present. """ python_operator_task: VariableOrOptional[PythonOperatorTaskParam] """ :meta private: [EXPERIMENTAL] - The task runs a Python operator task. + [Private Preview] The task runs a Python operator task. """ python_wheel_task: VariableOrOptional[PythonWheelTaskParam] diff --git a/python/databricks/bundles/jobs/_models/task_email_notifications.py b/python/databricks/bundles/jobs/_models/task_email_notifications.py index 35837985156..5b0ae515f61 100644 --- a/python/databricks/bundles/jobs/_models/task_email_notifications.py +++ b/python/databricks/bundles/jobs/_models/task_email_notifications.py @@ -38,7 +38,7 @@ class TaskEmailNotifications: on_streaming_backlog_exceeded: VariableOrList[str] = field(default_factory=list) """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ @@ -82,7 +82,7 @@ class TaskEmailNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[str] """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ diff --git a/python/databricks/bundles/jobs/_models/trigger_settings.py b/python/databricks/bundles/jobs/_models/trigger_settings.py index 67b3a4def74..490f5175dd8 100644 --- a/python/databricks/bundles/jobs/_models/trigger_settings.py +++ b/python/databricks/bundles/jobs/_models/trigger_settings.py @@ -38,6 +38,8 @@ class TriggerSettings: model: VariableOrOptional[ModelTriggerConfiguration] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ pause_status: VariableOrOptional[PauseStatus] = None @@ -71,6 +73,8 @@ class TriggerSettingsDict(TypedDict, total=False): model: VariableOrOptional[ModelTriggerConfigurationParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ pause_status: VariableOrOptional[PauseStatusParam] diff --git a/python/databricks/bundles/jobs/_models/webhook_notifications.py b/python/databricks/bundles/jobs/_models/webhook_notifications.py index c0f3edf0887..ffd043261dc 100644 --- a/python/databricks/bundles/jobs/_models/webhook_notifications.py +++ b/python/databricks/bundles/jobs/_models/webhook_notifications.py @@ -33,7 +33,7 @@ class WebhookNotifications: on_streaming_backlog_exceeded: VariableOrList[Webhook] = field(default_factory=list) """ - An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. @@ -72,7 +72,7 @@ class WebhookNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[WebhookParam] """ - An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. diff --git a/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py b/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py index e8b5b69de33..3a538d30fa6 100644 --- a/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py +++ b/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py @@ -17,12 +17,12 @@ class AutoFullRefreshPolicy: enabled: VariableOr[bool] """ - (Required, Mutable) Whether to enable auto full refresh or not. + [Public Preview] (Required, Mutable) Whether to enable auto full refresh or not. """ min_interval_hours: VariableOrOptional[int] = None """ - (Optional, Mutable) Specify the minimum interval in hours between the timestamp + [Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. """ @@ -40,12 +40,12 @@ class AutoFullRefreshPolicyDict(TypedDict, total=False): enabled: VariableOr[bool] """ - (Required, Mutable) Whether to enable auto full refresh or not. + [Public Preview] (Required, Mutable) Whether to enable auto full refresh or not. """ min_interval_hours: VariableOrOptional[int] """ - (Optional, Mutable) Specify the minimum interval in hours between the timestamp + [Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. """ diff --git a/python/databricks/bundles/pipelines/_models/confluence_connector_options.py b/python/databricks/bundles/pipelines/_models/confluence_connector_options.py index 8158448f323..0c6ed1f1ebe 100644 --- a/python/databricks/bundles/pipelines/_models/confluence_connector_options.py +++ b/python/databricks/bundles/pipelines/_models/confluence_connector_options.py @@ -17,7 +17,7 @@ class ConfluenceConnectorOptions: include_confluence_spaces: VariableOrList[str] = field(default_factory=list) """ - (Optional) Spaces to filter Confluence data on + [Public Preview] (Optional) Spaces to filter Confluence data on """ @classmethod @@ -33,7 +33,7 @@ class ConfluenceConnectorOptionsDict(TypedDict, total=False): include_confluence_spaces: VariableOrList[str] """ - (Optional) Spaces to filter Confluence data on + [Public Preview] (Optional) Spaces to filter Confluence data on """ diff --git a/python/databricks/bundles/pipelines/_models/connection_parameters.py b/python/databricks/bundles/pipelines/_models/connection_parameters.py index 98ed0dbcda0..e4c3d43cc59 100644 --- a/python/databricks/bundles/pipelines/_models/connection_parameters.py +++ b/python/databricks/bundles/pipelines/_models/connection_parameters.py @@ -19,7 +19,7 @@ class ConnectionParameters: """ :meta private: [EXPERIMENTAL] - Source catalog for initial connection. + [Private Preview] Source catalog for initial connection. This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. For Oracle databases, this maps to a service name. @@ -40,7 +40,7 @@ class ConnectionParametersDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Source catalog for initial connection. + [Private Preview] Source catalog for initial connection. This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. For Oracle databases, this maps to a service name. diff --git a/python/databricks/bundles/pipelines/_models/connector_options.py b/python/databricks/bundles/pipelines/_models/connector_options.py index b236e16f762..ba03b1619fb 100644 --- a/python/databricks/bundles/pipelines/_models/connector_options.py +++ b/python/databricks/bundles/pipelines/_models/connector_options.py @@ -61,69 +61,75 @@ class ConnectorOptions: confluence_options: VariableOrOptional[ConfluenceConnectorOptions] = None """ - Confluence specific options for ingestion + [Public Preview] Confluence specific options for ingestion """ gdrive_options: VariableOrOptional[GoogleDriveOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ google_ads_options: VariableOrOptional[GoogleAdsOptions] = None """ :meta private: [EXPERIMENTAL] - Google Ads specific options for ingestion (object-level). + [Private Preview] Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). """ jira_options: VariableOrOptional[JiraConnectorOptions] = None """ - Jira specific options for ingestion + [Beta] Jira specific options for ingestion """ kafka_options: VariableOrOptional[KafkaOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ meta_ads_options: VariableOrOptional[MetaMarketingOptions] = None """ - Meta Marketing (Meta Ads) specific options for ingestion + [Beta] Meta Marketing (Meta Ads) specific options for ingestion """ outlook_options: VariableOrOptional[OutlookOptions] = None """ :meta private: [EXPERIMENTAL] - Outlook specific options for ingestion + [Private Preview] Outlook specific options for ingestion """ sharepoint_options: VariableOrOptional[SharepointOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ smartsheet_options: VariableOrOptional[SmartsheetOptions] = None """ :meta private: [EXPERIMENTAL] - Smartsheet specific options for ingestion + [Private Preview] Smartsheet specific options for ingestion """ tiktok_ads_options: VariableOrOptional[TikTokAdsOptions] = None """ :meta private: [EXPERIMENTAL] - TikTok Ads specific options for ingestion + [Private Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptions] = None """ :meta private: [EXPERIMENTAL] - Zendesk Support specific options for ingestion + [Private Preview] Zendesk Support specific options for ingestion """ @classmethod @@ -139,69 +145,75 @@ class ConnectorOptionsDict(TypedDict, total=False): confluence_options: VariableOrOptional[ConfluenceConnectorOptionsParam] """ - Confluence specific options for ingestion + [Public Preview] Confluence specific options for ingestion """ gdrive_options: VariableOrOptional[GoogleDriveOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ google_ads_options: VariableOrOptional[GoogleAdsOptionsParam] """ :meta private: [EXPERIMENTAL] - Google Ads specific options for ingestion (object-level). + [Private Preview] Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). """ jira_options: VariableOrOptional[JiraConnectorOptionsParam] """ - Jira specific options for ingestion + [Beta] Jira specific options for ingestion """ kafka_options: VariableOrOptional[KafkaOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ meta_ads_options: VariableOrOptional[MetaMarketingOptionsParam] """ - Meta Marketing (Meta Ads) specific options for ingestion + [Beta] Meta Marketing (Meta Ads) specific options for ingestion """ outlook_options: VariableOrOptional[OutlookOptionsParam] """ :meta private: [EXPERIMENTAL] - Outlook specific options for ingestion + [Private Preview] Outlook specific options for ingestion """ sharepoint_options: VariableOrOptional[SharepointOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ smartsheet_options: VariableOrOptional[SmartsheetOptionsParam] """ :meta private: [EXPERIMENTAL] - Smartsheet specific options for ingestion + [Private Preview] Smartsheet specific options for ingestion """ tiktok_ads_options: VariableOrOptional[TikTokAdsOptionsParam] """ :meta private: [EXPERIMENTAL] - TikTok Ads specific options for ingestion + [Private Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptionsParam] """ :meta private: [EXPERIMENTAL] - Zendesk Support specific options for ingestion + [Private Preview] Zendesk Support specific options for ingestion """ diff --git a/python/databricks/bundles/pipelines/_models/data_staging_options.py b/python/databricks/bundles/pipelines/_models/data_staging_options.py index 3b6854b81dd..c6e599c73fb 100644 --- a/python/databricks/bundles/pipelines/_models/data_staging_options.py +++ b/python/databricks/bundles/pipelines/_models/data_staging_options.py @@ -17,17 +17,17 @@ class DataStagingOptions: catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location. """ schema_name: VariableOr[str] """ - (Required, Immutable) The name of the schema for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the schema for the connector's staging storage location. """ volume_name: VariableOrOptional[str] = None """ - (Optional) The Unity Catalog-compatible name for the storage location. + [Beta] (Optional) The Unity Catalog-compatible name for the storage location. This is the volume to use for the data that is extracted by the connector. Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : @@ -47,17 +47,17 @@ class DataStagingOptionsDict(TypedDict, total=False): catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location. """ schema_name: VariableOr[str] """ - (Required, Immutable) The name of the schema for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the schema for the connector's staging storage location. """ volume_name: VariableOrOptional[str] """ - (Optional) The Unity Catalog-compatible name for the storage location. + [Beta] (Optional) The Unity Catalog-compatible name for the storage location. This is the volume to use for the data that is extracted by the connector. Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : diff --git a/python/databricks/bundles/pipelines/_models/file_filter.py b/python/databricks/bundles/pipelines/_models/file_filter.py index 92283b649c8..8d24212250d 100644 --- a/python/databricks/bundles/pipelines/_models/file_filter.py +++ b/python/databricks/bundles/pipelines/_models/file_filter.py @@ -19,7 +19,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring after the specified time. + [Private Preview] Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -28,7 +28,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring before the specified time. + [Private Preview] Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -37,7 +37,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with file names matching the pattern + [Private Preview] Include files with file names matching the pattern Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter """ @@ -56,7 +56,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring after the specified time. + [Private Preview] Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -65,7 +65,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring before the specified time. + [Private Preview] Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -74,7 +74,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with file names matching the pattern + [Private Preview] Include files with file names matching the pattern Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter """ diff --git a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py index 1d6f18dfc5f..c3855364f72 100644 --- a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py +++ b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py @@ -31,51 +31,59 @@ class FileIngestionOptions: corrupt_record_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_filters: VariableOrList[FileFilter] = field(default_factory=list) """ :meta private: [EXPERIMENTAL] - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormat] = None """ :meta private: [EXPERIMENTAL] - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] = field(default_factory=dict) """ :meta private: [EXPERIMENTAL] - Format-specific options + [Private Preview] Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ infer_column_types: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ reader_case_sensitive: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] - Column name case sensitivity + [Private Preview] Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ schema_evolution_mode: VariableOrOptional[ @@ -84,20 +92,22 @@ class FileIngestionOptions: """ :meta private: [EXPERIMENTAL] - Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + [Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Override inferred schema of specific columns + [Private Preview] Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints """ single_variant_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -114,51 +124,59 @@ class FileIngestionOptionsDict(TypedDict, total=False): corrupt_record_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_filters: VariableOrList[FileFilterParam] """ :meta private: [EXPERIMENTAL] - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormatParam] """ :meta private: [EXPERIMENTAL] - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] """ :meta private: [EXPERIMENTAL] - Format-specific options + [Private Preview] Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ infer_column_types: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ reader_case_sensitive: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] - Column name case sensitivity + [Private Preview] Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ schema_evolution_mode: VariableOrOptional[ @@ -167,20 +185,22 @@ class FileIngestionOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + [Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Override inferred schema of specific columns + [Private Preview] Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints """ single_variant_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/gcp_attributes.py b/python/databricks/bundles/pipelines/_models/gcp_attributes.py index 1670e8c02f5..7ae9b24d4d5 100644 --- a/python/databricks/bundles/pipelines/_models/gcp_attributes.py +++ b/python/databricks/bundles/pipelines/_models/gcp_attributes.py @@ -34,7 +34,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -105,7 +105,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/pipelines/_models/google_ads_config.py b/python/databricks/bundles/pipelines/_models/google_ads_config.py index debbe468b2b..68ad306a40c 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_config.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_config.py @@ -19,7 +19,7 @@ class GoogleAdsConfig: """ :meta private: [EXPERIMENTAL] - (Required) Manager Account ID (also called MCC Account ID) used to list and access + [Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. This is required for fetching the list of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), @@ -41,7 +41,7 @@ class GoogleAdsConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Required) Manager Account ID (also called MCC Account ID) used to list and access + [Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. This is required for fetching the list of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), diff --git a/python/databricks/bundles/pipelines/_models/google_ads_options.py b/python/databricks/bundles/pipelines/_models/google_ads_options.py index 3cd04a5ef7f..3af2893e5a5 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_options.py @@ -23,7 +23,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional at this level) Manager Account ID (also called MCC Account ID) used to list + [Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. """ @@ -32,7 +32,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables to capture late-arriving data. + [Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. """ @@ -40,7 +40,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 2 years of historical data. """ @@ -60,7 +60,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional at this level) Manager Account ID (also called MCC Account ID) used to list + [Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. """ @@ -69,7 +69,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables to capture late-arriving data. + [Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. """ @@ -77,7 +77,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 2 years of historical data. """ diff --git a/python/databricks/bundles/pipelines/_models/google_drive_options.py b/python/databricks/bundles/pipelines/_models/google_drive_options.py index 71b251e83e8..968daabefb7 100644 --- a/python/databricks/bundles/pipelines/_models/google_drive_options.py +++ b/python/databricks/bundles/pipelines/_models/google_drive_options.py @@ -26,18 +26,22 @@ class GoogleDriveOptions: entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityType] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ url: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Google Drive URL. + [Private Preview] Google Drive URL. """ @classmethod @@ -54,18 +58,22 @@ class GoogleDriveOptionsDict(TypedDict, total=False): entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityTypeParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ url: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Google Drive URL. + [Private Preview] Google Drive URL. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_config.py b/python/databricks/bundles/pipelines/_models/ingestion_config.py index c452222df9c..b9276540f8a 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_config.py @@ -18,17 +18,17 @@ class IngestionConfig: report: VariableOrOptional[ReportSpec] = None """ - Select a specific source report. + [Public Preview] Select a specific source report. """ schema: VariableOrOptional[SchemaSpec] = None """ - Select all tables from a specific source schema. + [Public Preview] Select all tables from a specific source schema. """ table: VariableOrOptional[TableSpec] = None """ - Select a specific source table. + [Public Preview] Select a specific source table. """ @classmethod @@ -44,17 +44,17 @@ class IngestionConfigDict(TypedDict, total=False): report: VariableOrOptional[ReportSpecParam] """ - Select a specific source report. + [Public Preview] Select a specific source report. """ schema: VariableOrOptional[SchemaSpecParam] """ - Select all tables from a specific source schema. + [Public Preview] Select all tables from a specific source schema. """ table: VariableOrOptional[TableSpecParam] """ - Select a specific source table. + [Public Preview] Select a specific source table. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py index 79c26080742..a1f73e0a85c 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py @@ -23,35 +23,35 @@ class IngestionGatewayPipelineDefinition: """ :meta private: [EXPERIMENTAL] - Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + [Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the schema for the gateway pipelines's storage location. + [Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location. """ connection_parameters: VariableOrOptional[ConnectionParameters] = None """ :meta private: [EXPERIMENTAL] - Optional, Internal. Parameters required to establish an initial connection with the source. + [Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source. """ gateway_storage_name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional. The Unity Catalog-compatible name for the gateway storage location. + [Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. """ @@ -71,35 +71,35 @@ class IngestionGatewayPipelineDefinitionDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + [Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the schema for the gateway pipelines's storage location. + [Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location. """ connection_parameters: VariableOrOptional[ConnectionParametersParam] """ :meta private: [EXPERIMENTAL] - Optional, Internal. Parameters required to establish an initial connection with the source. + [Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source. """ gateway_storage_name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional. The Unity Catalog-compatible name for the gateway storage location. + [Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py index 050ca666636..20e1cfe78ca 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py @@ -39,7 +39,7 @@ class IngestionPipelineDefinition: connection_name: VariableOrOptional[str] = None """ - The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with + [Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with both connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle, (connector_type = QUERY_BASED OR connector_type = CDC). If connection name corresponds to database connectors like Oracle, and connector_type is not provided then @@ -51,12 +51,12 @@ class IngestionPipelineDefinition: connector_type: VariableOrOptional[ConnectorType] = None """ - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptions] = None """ - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. @@ -64,12 +64,12 @@ class IngestionPipelineDefinition: full_refresh_window: VariableOrOptional[OperationTimeWindow] = None """ - (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + [Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. """ ingest_from_uc_foreign_catalog: VariableOrOptional[bool] = None """ - Immutable. If set to true, the pipeline will ingest tables from the + [Public Preview] Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. @@ -77,7 +77,7 @@ class IngestionPipelineDefinition: ingestion_gateway_id: VariableOrOptional[str] = None """ - Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. + [Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. @@ -86,21 +86,23 @@ class IngestionPipelineDefinition: netsuite_jar_path: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ objects: VariableOrList[IngestionConfig] = field(default_factory=list) """ - Required. Settings specifying tables to replicate and the destination for the replicated tables. + [Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables. """ source_configurations: VariableOrList[SourceConfig] = field(default_factory=list) """ - Top-level source configurations + [Public Preview] Top-level source configurations """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. """ @classmethod @@ -116,7 +118,7 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): connection_name: VariableOrOptional[str] """ - The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with + [Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with both connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle, (connector_type = QUERY_BASED OR connector_type = CDC). If connection name corresponds to database connectors like Oracle, and connector_type is not provided then @@ -128,12 +130,12 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): connector_type: VariableOrOptional[ConnectorTypeParam] """ - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptionsParam] """ - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. @@ -141,12 +143,12 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): full_refresh_window: VariableOrOptional[OperationTimeWindowParam] """ - (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + [Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. """ ingest_from_uc_foreign_catalog: VariableOrOptional[bool] """ - Immutable. If set to true, the pipeline will ingest tables from the + [Public Preview] Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. @@ -154,7 +156,7 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): ingestion_gateway_id: VariableOrOptional[str] """ - Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. + [Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. @@ -163,21 +165,23 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): netsuite_jar_path: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ objects: VariableOrList[IngestionConfigParam] """ - Required. Settings specifying tables to replicate and the destination for the replicated tables. + [Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables. """ source_configurations: VariableOrList[SourceConfigParam] """ - Top-level source configurations + [Public Preview] Top-level source configurations """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py index babdc662917..33a73ffa5c8 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py @@ -17,7 +17,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: cursor_columns: VariableOrList[str] = field(default_factory=list) """ - The names of the monotonically increasing columns in the source table that are used to enable + [Public Preview] The names of the monotonically increasing columns in the source table that are used to enable the table to be read and ingested incrementally through structured streaming. The columns are allowed to have repeated values but have to be non-decreasing. If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these @@ -27,7 +27,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: deletion_condition: VariableOrOptional[str] = None """ - Specifies a SQL WHERE condition that specifies that the source row has been deleted. + [Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted. This is sometimes referred to as "soft-deletes". For example: "Operation = 'DELETE'" or "is_deleted = true". This field is orthogonal to `hard_deletion_sync_interval_in_seconds`, @@ -38,7 +38,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: hard_deletion_sync_min_interval_in_seconds: VariableOrOptional[int] = None """ - Specifies the minimum interval (in seconds) between snapshots on primary keys + [Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys for detecting and synchronizing hard deletions—i.e., rows that have been physically removed from the source table. This interval acts as a lower bound. If ingestion runs less frequently than @@ -68,7 +68,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic cursor_columns: VariableOrList[str] """ - The names of the monotonically increasing columns in the source table that are used to enable + [Public Preview] The names of the monotonically increasing columns in the source table that are used to enable the table to be read and ingested incrementally through structured streaming. The columns are allowed to have repeated values but have to be non-decreasing. If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these @@ -78,7 +78,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic deletion_condition: VariableOrOptional[str] """ - Specifies a SQL WHERE condition that specifies that the source row has been deleted. + [Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted. This is sometimes referred to as "soft-deletes". For example: "Operation = 'DELETE'" or "is_deleted = true". This field is orthogonal to `hard_deletion_sync_interval_in_seconds`, @@ -89,7 +89,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic hard_deletion_sync_min_interval_in_seconds: VariableOrOptional[int] """ - Specifies the minimum interval (in seconds) between snapshots on primary keys + [Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys for detecting and synchronizing hard deletions—i.e., rows that have been physically removed from the source table. This interval acts as a lower bound. If ingestion runs less frequently than diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py index 56e1840c791..c86ff492d22 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py @@ -19,7 +19,7 @@ class IngestionPipelineDefinitionWorkdayReportParameters: """ :meta private: [EXPERIMENTAL] - Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), + [Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), and the corresponding value is a SQL-like expression used to compute the parameter value at runtime. Example: { @@ -45,7 +45,7 @@ class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=Fa """ :meta private: [EXPERIMENTAL] - Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), + [Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), and the corresponding value is a SQL-like expression used to compute the parameter value at runtime. Example: { diff --git a/python/databricks/bundles/pipelines/_models/jira_connector_options.py b/python/databricks/bundles/pipelines/_models/jira_connector_options.py index b0d1e82582f..ed97e56ddfd 100644 --- a/python/databricks/bundles/pipelines/_models/jira_connector_options.py +++ b/python/databricks/bundles/pipelines/_models/jira_connector_options.py @@ -17,7 +17,7 @@ class JiraConnectorOptions: include_jira_spaces: VariableOrList[str] = field(default_factory=list) """ - (Optional) Projects to filter Jira data on + [Beta] (Optional) Projects to filter Jira data on """ @classmethod @@ -33,7 +33,7 @@ class JiraConnectorOptionsDict(TypedDict, total=False): include_jira_spaces: VariableOrList[str] """ - (Optional) Projects to filter Jira data on + [Beta] (Optional) Projects to filter Jira data on """ diff --git a/python/databricks/bundles/pipelines/_models/json_transformer_options.py b/python/databricks/bundles/pipelines/_models/json_transformer_options.py index dc00e759691..22c8d37956b 100644 --- a/python/databricks/bundles/pipelines/_models/json_transformer_options.py +++ b/python/databricks/bundles/pipelines/_models/json_transformer_options.py @@ -23,14 +23,14 @@ class JsonTransformerOptions: """ :meta private: [EXPERIMENTAL] - Parse the entire value as a single Variant column. + [Private Preview] Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Inline schema string for JSON parsing (Spark DDL format). + [Private Preview] Inline schema string for JSON parsing (Spark DDL format). """ schema_evolution_mode: VariableOrOptional[ @@ -39,21 +39,21 @@ class JsonTransformerOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Schema evolution mode for schema inference. + [Private Preview] (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Path to a schema file (.ddl). + [Private Preview] Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + [Private Preview] (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ @classmethod @@ -71,14 +71,14 @@ class JsonTransformerOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Parse the entire value as a single Variant column. + [Private Preview] Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Inline schema string for JSON parsing (Spark DDL format). + [Private Preview] Inline schema string for JSON parsing (Spark DDL format). """ schema_evolution_mode: VariableOrOptional[ @@ -87,21 +87,21 @@ class JsonTransformerOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Schema evolution mode for schema inference. + [Private Preview] (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Path to a schema file (.ddl). + [Private Preview] Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + [Private Preview] (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ diff --git a/python/databricks/bundles/pipelines/_models/kafka_options.py b/python/databricks/bundles/pipelines/_models/kafka_options.py index 9a33e5e1e3d..b37566a291b 100644 --- a/python/databricks/bundles/pipelines/_models/kafka_options.py +++ b/python/databricks/bundles/pipelines/_models/kafka_options.py @@ -27,7 +27,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Undocumented backdoor mechanism for overriding parameters + [Private Preview] Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time. """ @@ -36,7 +36,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message key. + [Private Preview] (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -44,14 +44,14 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Internal option to control the maximum number of offsets to process per trigger. + [Private Preview] Internal option to control the maximum number of offsets to process per trigger. """ starting_offset: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - (Optional) Where to begin reading when no checkpoint exists. + [Private Preview] (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ @@ -59,7 +59,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Java regex pattern to subscribe to matching topics. + [Private Preview] Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ @@ -67,7 +67,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Topics to subscribe to. + [Private Preview] Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ @@ -75,7 +75,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message value. + [Private Preview] (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ @@ -94,7 +94,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Undocumented backdoor mechanism for overriding parameters + [Private Preview] Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time. """ @@ -103,7 +103,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message key. + [Private Preview] (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -111,14 +111,14 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Internal option to control the maximum number of offsets to process per trigger. + [Private Preview] Internal option to control the maximum number of offsets to process per trigger. """ starting_offset: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - (Optional) Where to begin reading when no checkpoint exists. + [Private Preview] (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ @@ -126,7 +126,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Java regex pattern to subscribe to matching topics. + [Private Preview] Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ @@ -134,7 +134,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Topics to subscribe to. + [Private Preview] Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ @@ -142,7 +142,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message value. + [Private Preview] (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ diff --git a/python/databricks/bundles/pipelines/_models/meta_marketing_options.py b/python/databricks/bundles/pipelines/_models/meta_marketing_options.py index fb9d5b8f8ba..c78284427e3 100644 --- a/python/databricks/bundles/pipelines/_models/meta_marketing_options.py +++ b/python/databricks/bundles/pipelines/_models/meta_marketing_options.py @@ -17,44 +17,44 @@ class MetaMarketingOptions: action_attribution_windows: VariableOrList[str] = field(default_factory=list) """ - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + [Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") """ action_breakdowns: VariableOrList[str] = field(default_factory=list) """ - (Optional) Action breakdowns to configure for data aggregation + [Beta] (Optional) Action breakdowns to configure for data aggregation """ action_report_time: VariableOrOptional[str] = None """ - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) """ breakdowns: VariableOrList[str] = field(default_factory=list) """ - (Optional) Breakdowns to configure for data aggregation + [Beta] (Optional) Breakdowns to configure for data aggregation """ custom_insights_lookback_window: VariableOrOptional[int] = None """ - (Optional) Window in days to revisit data during sync to capture + [Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. """ level: VariableOrOptional[str] = None """ - (Optional) Granularity of data to pull (account, ad, adset, campaign) + [Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) """ start_date: VariableOrOptional[str] = None """ - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added + [Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested """ time_increment: VariableOrOptional[str] = None """ - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) """ @classmethod @@ -70,44 +70,44 @@ class MetaMarketingOptionsDict(TypedDict, total=False): action_attribution_windows: VariableOrList[str] """ - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + [Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") """ action_breakdowns: VariableOrList[str] """ - (Optional) Action breakdowns to configure for data aggregation + [Beta] (Optional) Action breakdowns to configure for data aggregation """ action_report_time: VariableOrOptional[str] """ - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) """ breakdowns: VariableOrList[str] """ - (Optional) Breakdowns to configure for data aggregation + [Beta] (Optional) Breakdowns to configure for data aggregation """ custom_insights_lookback_window: VariableOrOptional[int] """ - (Optional) Window in days to revisit data during sync to capture + [Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. """ level: VariableOrOptional[str] """ - (Optional) Granularity of data to pull (account, ad, adset, campaign) + [Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) """ start_date: VariableOrOptional[str] """ - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added + [Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested """ time_increment: VariableOrOptional[str] """ - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) """ diff --git a/python/databricks/bundles/pipelines/_models/operation_time_window.py b/python/databricks/bundles/pipelines/_models/operation_time_window.py index 85720ab6c1a..8acd9ea7bb8 100644 --- a/python/databricks/bundles/pipelines/_models/operation_time_window.py +++ b/python/databricks/bundles/pipelines/_models/operation_time_window.py @@ -22,18 +22,18 @@ class OperationTimeWindow: start_hour: VariableOr[int] """ - An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + [Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. """ days_of_week: VariableOrList[DayOfWeek] = field(default_factory=list) """ - Days of week in which the window is allowed to happen + [Public Preview] Days of week in which the window is allowed to happen If not specified all days of the week will be used. """ time_zone_id: VariableOrOptional[str] = None """ - Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ @@ -50,18 +50,18 @@ class OperationTimeWindowDict(TypedDict, total=False): start_hour: VariableOr[int] """ - An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + [Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. """ days_of_week: VariableOrList[DayOfWeekParam] """ - Days of week in which the window is allowed to happen + [Public Preview] Days of week in which the window is allowed to happen If not specified all days of the week will be used. """ time_zone_id: VariableOrOptional[str] """ - Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ diff --git a/python/databricks/bundles/pipelines/_models/outlook_options.py b/python/databricks/bundles/pipelines/_models/outlook_options.py index 5d88963498b..36fafbdfd91 100644 --- a/python/databricks/bundles/pipelines/_models/outlook_options.py +++ b/python/databricks/bundles/pipelines/_models/outlook_options.py @@ -29,7 +29,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ @@ -37,7 +37,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Defines how the body_content column is populated. + [Private Preview] (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. """ @@ -46,7 +46,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter mail folders to include in the sync. + [Private Preview] (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. @@ -56,7 +56,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). + [Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. """ @@ -65,7 +65,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by sender address. Uses exact email match. + [Private Preview] (Optional) Filter emails by sender address. Uses exact email match. Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. @@ -75,7 +75,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with + [Private Preview] (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with the part before "*"); otherwise substring match (subject contains the value). Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. @@ -86,7 +86,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format. Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. @@ -107,7 +107,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ @@ -115,7 +115,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Defines how the body_content column is populated. + [Private Preview] (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. """ @@ -124,7 +124,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter mail folders to include in the sync. + [Private Preview] (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. @@ -134,7 +134,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). + [Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. """ @@ -143,7 +143,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by sender address. Uses exact email match. + [Private Preview] (Optional) Filter emails by sender address. Uses exact email match. Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. @@ -153,7 +153,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with + [Private Preview] (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with the part before "*"); otherwise substring match (subject contains the value). Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. @@ -164,7 +164,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format. Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. diff --git a/python/databricks/bundles/pipelines/_models/path_pattern.py b/python/databricks/bundles/pipelines/_models/path_pattern.py index e8e04fd949a..55ad00ebd38 100644 --- a/python/databricks/bundles/pipelines/_models/path_pattern.py +++ b/python/databricks/bundles/pipelines/_models/path_pattern.py @@ -15,7 +15,7 @@ class PathPattern: include: VariableOrOptional[str] = None """ - The source code to include for pipelines + [Public Preview] The source code to include for pipelines """ @classmethod @@ -31,7 +31,7 @@ class PathPatternDict(TypedDict, total=False): include: VariableOrOptional[str] """ - The source code to include for pipelines + [Public Preview] The source code to include for pipelines """ diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index 798db0a9bb8..5d23141c42f 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -67,7 +67,7 @@ class Pipeline(Resource): budget_policy_id: VariableOrOptional[str] = None """ - Budget policy of this pipeline. + [Public Preview] Budget policy of this pipeline. """ catalog: VariableOrOptional[str] = None @@ -107,7 +107,7 @@ class Pipeline(Resource): environment: VariableOrOptional[PipelinesEnvironment] = None """ - Environment specification for this pipeline used to install dependencies. + [Public Preview] Environment specification for this pipeline used to install dependencies. """ event_log: VariableOrOptional[EventLogSpec] = None @@ -124,7 +124,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - The definition of a gateway pipeline to support change data capture. + [Private Preview] The definition of a gateway pipeline to support change data capture. """ id: VariableOrOptional[str] = None @@ -134,7 +134,7 @@ class Pipeline(Resource): ingestion_definition: VariableOrOptional[IngestionPipelineDefinition] = None """ - The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + [Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. """ libraries: VariableOrList[PipelineLibrary] = field(default_factory=list) @@ -158,6 +158,9 @@ class Pipeline(Resource): """ parameters: VariableOrDict[str] = field(default_factory=dict) + """ + [Beta] + """ permissions: VariableOrList[PipelinePermission] = field(default_factory=list) @@ -170,12 +173,12 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - Restart window of this pipeline. + [Private Preview] Restart window of this pipeline. """ root_path: VariableOrOptional[str] = None """ - Root path for this pipeline. + [Public Preview] Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. """ @@ -213,7 +216,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - Usage policy of this pipeline. + [Private Preview] Usage policy of this pipeline. """ @classmethod @@ -234,7 +237,7 @@ class PipelineDict(TypedDict, total=False): budget_policy_id: VariableOrOptional[str] """ - Budget policy of this pipeline. + [Public Preview] Budget policy of this pipeline. """ catalog: VariableOrOptional[str] @@ -274,7 +277,7 @@ class PipelineDict(TypedDict, total=False): environment: VariableOrOptional[PipelinesEnvironmentParam] """ - Environment specification for this pipeline used to install dependencies. + [Public Preview] Environment specification for this pipeline used to install dependencies. """ event_log: VariableOrOptional[EventLogSpecParam] @@ -291,7 +294,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The definition of a gateway pipeline to support change data capture. + [Private Preview] The definition of a gateway pipeline to support change data capture. """ id: VariableOrOptional[str] @@ -301,7 +304,7 @@ class PipelineDict(TypedDict, total=False): ingestion_definition: VariableOrOptional[IngestionPipelineDefinitionParam] """ - The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + [Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. """ libraries: VariableOrList[PipelineLibraryParam] @@ -325,6 +328,9 @@ class PipelineDict(TypedDict, total=False): """ parameters: VariableOrDict[str] + """ + [Beta] + """ permissions: VariableOrList[PipelinePermissionParam] @@ -337,12 +343,12 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Restart window of this pipeline. + [Private Preview] Restart window of this pipeline. """ root_path: VariableOrOptional[str] """ - Root path for this pipeline. + [Public Preview] Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. """ @@ -380,7 +386,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Usage policy of this pipeline. + [Private Preview] Usage policy of this pipeline. """ diff --git a/python/databricks/bundles/pipelines/_models/pipeline_library.py b/python/databricks/bundles/pipelines/_models/pipeline_library.py index fa5b9e09e1c..90d048f9644 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline_library.py +++ b/python/databricks/bundles/pipelines/_models/pipeline_library.py @@ -36,7 +36,7 @@ class PipelineLibrary: glob: VariableOrOptional[PathPattern] = None """ - The unified field to include source codes. + [Public Preview] The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. """ @@ -45,14 +45,14 @@ class PipelineLibrary: """ :meta private: [EXPERIMENTAL] - URI of the jar to be installed. Currently only DBFS is supported. + [Private Preview] URI of the jar to be installed. Currently only DBFS is supported. """ maven: VariableOrOptional[MavenLibrary] = None """ :meta private: [EXPERIMENTAL] - Specification of a maven library to be installed. + [Private Preview] Specification of a maven library to be installed. """ notebook: VariableOrOptional[NotebookLibrary] = None @@ -78,7 +78,7 @@ class PipelineLibraryDict(TypedDict, total=False): glob: VariableOrOptional[PathPatternParam] """ - The unified field to include source codes. + [Public Preview] The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. """ @@ -87,14 +87,14 @@ class PipelineLibraryDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - URI of the jar to be installed. Currently only DBFS is supported. + [Private Preview] URI of the jar to be installed. Currently only DBFS is supported. """ maven: VariableOrOptional[MavenLibraryParam] """ :meta private: [EXPERIMENTAL] - Specification of a maven library to be installed. + [Private Preview] Specification of a maven library to be installed. """ notebook: VariableOrOptional[NotebookLibraryParam] diff --git a/python/databricks/bundles/pipelines/_models/pipelines_environment.py b/python/databricks/bundles/pipelines/_models/pipelines_environment.py index 4a24f7e1e62..6f1850b9eb4 100644 --- a/python/databricks/bundles/pipelines/_models/pipelines_environment.py +++ b/python/databricks/bundles/pipelines/_models/pipelines_environment.py @@ -18,7 +18,7 @@ class PipelinesEnvironment: dependencies: VariableOrList[str] = field(default_factory=list) """ - List of pip dependencies, as supported by the version of pip in this environment. + [Public Preview] List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), """ @@ -27,7 +27,7 @@ class PipelinesEnvironment: """ :meta private: [EXPERIMENTAL] - The environment version of the serverless Python environment used to execute + [Private Preview] The environment version of the serverless Python environment used to execute customer Python code. Each environment version includes a specific Python version and a curated set of pre-installed libraries with defined versions, providing a stable and reproducible execution environment. @@ -52,7 +52,7 @@ class PipelinesEnvironmentDict(TypedDict, total=False): dependencies: VariableOrList[str] """ - List of pip dependencies, as supported by the version of pip in this environment. + [Public Preview] List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), """ @@ -61,7 +61,7 @@ class PipelinesEnvironmentDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The environment version of the serverless Python environment used to execute + [Private Preview] The environment version of the serverless Python environment used to execute customer Python code. Each environment version includes a specific Python version and a curated set of pre-installed libraries with defined versions, providing a stable and reproducible execution environment. diff --git a/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py b/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py index 87092e7d7a7..a25c35870a9 100644 --- a/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py +++ b/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py @@ -21,7 +21,7 @@ class PostgresCatalogConfig: slot_config: VariableOrOptional[PostgresSlotConfig] = None """ - Optional. The Postgres slot configuration to use for logical replication + [Public Preview] Optional. The Postgres slot configuration to use for logical replication """ @classmethod @@ -37,7 +37,7 @@ class PostgresCatalogConfigDict(TypedDict, total=False): slot_config: VariableOrOptional[PostgresSlotConfigParam] """ - Optional. The Postgres slot configuration to use for logical replication + [Public Preview] Optional. The Postgres slot configuration to use for logical replication """ diff --git a/python/databricks/bundles/pipelines/_models/postgres_slot_config.py b/python/databricks/bundles/pipelines/_models/postgres_slot_config.py index 3c392c2d330..31db5806e62 100644 --- a/python/databricks/bundles/pipelines/_models/postgres_slot_config.py +++ b/python/databricks/bundles/pipelines/_models/postgres_slot_config.py @@ -17,12 +17,12 @@ class PostgresSlotConfig: publication_name: VariableOrOptional[str] = None """ - The name of the publication to use for the Postgres source + [Public Preview] The name of the publication to use for the Postgres source """ slot_name: VariableOrOptional[str] = None """ - The name of the logical replication slot to use for the Postgres source + [Public Preview] The name of the logical replication slot to use for the Postgres source """ @classmethod @@ -38,12 +38,12 @@ class PostgresSlotConfigDict(TypedDict, total=False): publication_name: VariableOrOptional[str] """ - The name of the publication to use for the Postgres source + [Public Preview] The name of the publication to use for the Postgres source """ slot_name: VariableOrOptional[str] """ - The name of the logical replication slot to use for the Postgres source + [Public Preview] The name of the logical replication slot to use for the Postgres source """ diff --git a/python/databricks/bundles/pipelines/_models/report_spec.py b/python/databricks/bundles/pipelines/_models/report_spec.py index 02d4a8760af..f2b6fc1aacd 100644 --- a/python/databricks/bundles/pipelines/_models/report_spec.py +++ b/python/databricks/bundles/pipelines/_models/report_spec.py @@ -19,27 +19,27 @@ class ReportSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_url: VariableOr[str] """ - Required. Report URL in the source system. + [Public Preview] Required. Report URL in the source system. """ destination_table: VariableOrOptional[str] = None """ - Required. Destination table name. The pipeline fails if a table with that name already exists. + [Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. """ @classmethod @@ -55,27 +55,27 @@ class ReportSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_url: VariableOr[str] """ - Required. Report URL in the source system. + [Public Preview] Required. Report URL in the source system. """ destination_table: VariableOrOptional[str] """ - Required. Destination table name. The pipeline fails if a table with that name already exists. + [Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. """ diff --git a/python/databricks/bundles/pipelines/_models/restart_window.py b/python/databricks/bundles/pipelines/_models/restart_window.py index b148614499e..dcc468b3ffc 100644 --- a/python/databricks/bundles/pipelines/_models/restart_window.py +++ b/python/databricks/bundles/pipelines/_models/restart_window.py @@ -24,7 +24,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. + [Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. Continuous pipeline restart is triggered only within a five-hour window starting at this hour. """ @@ -32,7 +32,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). + [Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). If not specified all days of the week will be used. """ @@ -40,7 +40,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ @@ -59,7 +59,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. + [Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. Continuous pipeline restart is triggered only within a five-hour window starting at this hour. """ @@ -67,7 +67,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). + [Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). If not specified all days of the week will be used. """ @@ -75,7 +75,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ diff --git a/python/databricks/bundles/pipelines/_models/schema_spec.py b/python/databricks/bundles/pipelines/_models/schema_spec.py index 9f756992026..a00c3b9334a 100644 --- a/python/databricks/bundles/pipelines/_models/schema_spec.py +++ b/python/databricks/bundles/pipelines/_models/schema_spec.py @@ -23,32 +23,32 @@ class SchemaSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store tables. + [Public Preview] Required. Destination catalog to store tables. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + [Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. """ source_schema: VariableOr[str] """ - Required. Schema name in the source database. + [Public Preview] Required. Schema name in the source database. """ connector_options: VariableOrOptional[ConnectorOptions] = None """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ source_catalog: VariableOrOptional[str] = None """ - The source catalog name. Might be optional depending on the type of source. + [Public Preview] The source catalog name. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. """ @classmethod @@ -64,32 +64,32 @@ class SchemaSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store tables. + [Public Preview] Required. Destination catalog to store tables. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + [Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. """ source_schema: VariableOr[str] """ - Required. Schema name in the source database. + [Public Preview] Required. Schema name in the source database. """ connector_options: VariableOrOptional[ConnectorOptionsParam] """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ source_catalog: VariableOrOptional[str] """ - The source catalog name. Might be optional depending on the type of source. + [Public Preview] The source catalog name. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. """ diff --git a/python/databricks/bundles/pipelines/_models/sharepoint_options.py b/python/databricks/bundles/pipelines/_models/sharepoint_options.py index 8bf678ab886..6f5994995a7 100644 --- a/python/databricks/bundles/pipelines/_models/sharepoint_options.py +++ b/python/databricks/bundles/pipelines/_models/sharepoint_options.py @@ -27,7 +27,7 @@ class SharepointOptions: """ :meta private: [EXPERIMENTAL] - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ @@ -35,14 +35,14 @@ class SharepointOptions: """ :meta private: [EXPERIMENTAL] - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ @classmethod @@ -60,7 +60,7 @@ class SharepointOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ @@ -68,14 +68,14 @@ class SharepointOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ diff --git a/python/databricks/bundles/pipelines/_models/smartsheet_options.py b/python/databricks/bundles/pipelines/_models/smartsheet_options.py index 061bf1e6000..d378d8ec2a0 100644 --- a/python/databricks/bundles/pipelines/_models/smartsheet_options.py +++ b/python/databricks/bundles/pipelines/_models/smartsheet_options.py @@ -21,7 +21,7 @@ class SmartsheetOptions: """ :meta private: [EXPERIMENTAL] - (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ + [Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ Checkbox/etc.). Cells that do not conform to the declared type are set to NULL. When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. @@ -43,7 +43,7 @@ class SmartsheetOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ + [Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ Checkbox/etc.). Cells that do not conform to the declared type are set to NULL. When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. diff --git a/python/databricks/bundles/pipelines/_models/source_catalog_config.py b/python/databricks/bundles/pipelines/_models/source_catalog_config.py index 246079cee0f..e61521e1f3f 100644 --- a/python/databricks/bundles/pipelines/_models/source_catalog_config.py +++ b/python/databricks/bundles/pipelines/_models/source_catalog_config.py @@ -21,12 +21,12 @@ class SourceCatalogConfig: postgres: VariableOrOptional[PostgresCatalogConfig] = None """ - Postgres-specific catalog-level configuration parameters + [Public Preview] Postgres-specific catalog-level configuration parameters """ source_catalog: VariableOrOptional[str] = None """ - Source catalog name + [Public Preview] Source catalog name """ @classmethod @@ -42,12 +42,12 @@ class SourceCatalogConfigDict(TypedDict, total=False): postgres: VariableOrOptional[PostgresCatalogConfigParam] """ - Postgres-specific catalog-level configuration parameters + [Public Preview] Postgres-specific catalog-level configuration parameters """ source_catalog: VariableOrOptional[str] """ - Source catalog name + [Public Preview] Source catalog name """ diff --git a/python/databricks/bundles/pipelines/_models/source_config.py b/python/databricks/bundles/pipelines/_models/source_config.py index ebbef1ef02c..afd2bae632f 100644 --- a/python/databricks/bundles/pipelines/_models/source_config.py +++ b/python/databricks/bundles/pipelines/_models/source_config.py @@ -23,12 +23,14 @@ class SourceConfig: catalog: VariableOrOptional[SourceCatalogConfig] = None """ - Catalog-level source configuration parameters + [Public Preview] Catalog-level source configuration parameters """ google_ads_config: VariableOrOptional[GoogleAdsConfig] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -44,12 +46,14 @@ class SourceConfigDict(TypedDict, total=False): catalog: VariableOrOptional[SourceCatalogConfigParam] """ - Catalog-level source configuration parameters + [Public Preview] Catalog-level source configuration parameters """ google_ads_config: VariableOrOptional[GoogleAdsConfigParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/table_spec.py b/python/databricks/bundles/pipelines/_models/table_spec.py index 10f5eb8ad1e..e2240ac360a 100644 --- a/python/databricks/bundles/pipelines/_models/table_spec.py +++ b/python/databricks/bundles/pipelines/_models/table_spec.py @@ -23,42 +23,42 @@ class TableSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_table: VariableOr[str] """ - Required. Table name in the source database. + [Public Preview] Required. Table name in the source database. """ connector_options: VariableOrOptional[ConnectorOptions] = None """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ destination_table: VariableOrOptional[str] = None """ - Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + [Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. """ source_catalog: VariableOrOptional[str] = None """ - Source catalog name. Might be optional depending on the type of source. + [Public Preview] Source catalog name. Might be optional depending on the type of source. """ source_schema: VariableOrOptional[str] = None """ - Schema name in the source database. Might be optional depending on the type of source. + [Public Preview] Schema name in the source database. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. """ @classmethod @@ -74,42 +74,42 @@ class TableSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_table: VariableOr[str] """ - Required. Table name in the source database. + [Public Preview] Required. Table name in the source database. """ connector_options: VariableOrOptional[ConnectorOptionsParam] """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ destination_table: VariableOrOptional[str] """ - Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + [Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. """ source_catalog: VariableOrOptional[str] """ - Source catalog name. Might be optional depending on the type of source. + [Public Preview] Source catalog name. Might be optional depending on the type of source. """ source_schema: VariableOrOptional[str] """ - Schema name in the source database. Might be optional depending on the type of source. + [Public Preview] Schema name in the source database. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. """ diff --git a/python/databricks/bundles/pipelines/_models/table_specific_config.py b/python/databricks/bundles/pipelines/_models/table_specific_config.py index 57e7fe2b1fe..117869fe710 100644 --- a/python/databricks/bundles/pipelines/_models/table_specific_config.py +++ b/python/databricks/bundles/pipelines/_models/table_specific_config.py @@ -31,7 +31,7 @@ class TableSpecificConfig: auto_full_refresh_policy: VariableOrOptional[AutoFullRefreshPolicy] = None """ - (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try + [Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try to fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy in table configuration will override the above level auto_full_refresh_policy. For example, @@ -46,7 +46,7 @@ class TableSpecificConfig: exclude_columns: VariableOrList[str] = field(default_factory=list) """ - A list of column names to be excluded for the ingestion. + [Public Preview] A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. @@ -54,7 +54,7 @@ class TableSpecificConfig: include_columns: VariableOrList[str] = field(default_factory=list) """ - A list of column names to be included for the ingestion. + [Public Preview] A list of column names to be included for the ingestion. When not specified, all columns except ones in exclude_columns will be included. Future columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. @@ -63,19 +63,19 @@ class TableSpecificConfig: primary_keys: VariableOrList[str] = field(default_factory=list) """ - The primary key of the table used to apply changes. + [Public Preview] The primary key of the table used to apply changes. """ query_based_connector_config: VariableOrOptional[ IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig ] = None """ - Configurations that are only applicable for query-based ingestion connectors. + [Public Preview] Configurations that are only applicable for query-based ingestion connectors. """ row_filter: VariableOrOptional[str] = None """ - (Optional, Immutable) The row filter condition to be applied to the table. + [Public Preview] (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. """ @@ -84,17 +84,17 @@ class TableSpecificConfig: """ :meta private: [EXPERIMENTAL] - If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + [Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector """ scd_type: VariableOrOptional[TableSpecificConfigScdType] = None """ - The SCD type to use to ingest the table. + [Public Preview] The SCD type to use to ingest the table. """ sequence_by: VariableOrList[str] = field(default_factory=list) """ - The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + [Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. """ workday_report_parameters: VariableOrOptional[ @@ -102,6 +102,8 @@ class TableSpecificConfig: ] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -117,7 +119,7 @@ class TableSpecificConfigDict(TypedDict, total=False): auto_full_refresh_policy: VariableOrOptional[AutoFullRefreshPolicyParam] """ - (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try + [Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try to fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy in table configuration will override the above level auto_full_refresh_policy. For example, @@ -132,7 +134,7 @@ class TableSpecificConfigDict(TypedDict, total=False): exclude_columns: VariableOrList[str] """ - A list of column names to be excluded for the ingestion. + [Public Preview] A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. @@ -140,7 +142,7 @@ class TableSpecificConfigDict(TypedDict, total=False): include_columns: VariableOrList[str] """ - A list of column names to be included for the ingestion. + [Public Preview] A list of column names to be included for the ingestion. When not specified, all columns except ones in exclude_columns will be included. Future columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. @@ -149,19 +151,19 @@ class TableSpecificConfigDict(TypedDict, total=False): primary_keys: VariableOrList[str] """ - The primary key of the table used to apply changes. + [Public Preview] The primary key of the table used to apply changes. """ query_based_connector_config: VariableOrOptional[ IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigParam ] """ - Configurations that are only applicable for query-based ingestion connectors. + [Public Preview] Configurations that are only applicable for query-based ingestion connectors. """ row_filter: VariableOrOptional[str] """ - (Optional, Immutable) The row filter condition to be applied to the table. + [Public Preview] (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. """ @@ -170,17 +172,17 @@ class TableSpecificConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + [Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector """ scd_type: VariableOrOptional[TableSpecificConfigScdTypeParam] """ - The SCD type to use to ingest the table. + [Public Preview] The SCD type to use to ingest the table. """ sequence_by: VariableOrList[str] """ - The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + [Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. """ workday_report_parameters: VariableOrOptional[ @@ -188,6 +190,8 @@ class TableSpecificConfigDict(TypedDict, total=False): ] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py index d37064947a1..a4a814b78b5 100644 --- a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py @@ -29,7 +29,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ @@ -37,7 +37,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Dimensions to include in the report. + [Private Preview] (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. """ @@ -46,7 +46,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables during incremental sync + [Private Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. """ @@ -55,7 +55,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Metrics to include in the report. + [Private Preview] (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) """ @@ -64,7 +64,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Whether to request lifetime metrics (all-time aggregated data). + [Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. """ @@ -73,7 +73,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ @@ -81,7 +81,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports and 30 days for hourly reports. @@ -102,7 +102,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ @@ -110,7 +110,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Dimensions to include in the report. + [Private Preview] (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. """ @@ -119,7 +119,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables during incremental sync + [Private Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. """ @@ -128,7 +128,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Metrics to include in the report. + [Private Preview] (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) """ @@ -137,7 +137,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Whether to request lifetime metrics (all-time aggregated data). + [Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. """ @@ -146,7 +146,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ @@ -154,7 +154,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports and 30 days for hourly reports. diff --git a/python/databricks/bundles/pipelines/_models/transformer.py b/python/databricks/bundles/pipelines/_models/transformer.py index 53c2a05eeca..84af0aa9d98 100644 --- a/python/databricks/bundles/pipelines/_models/transformer.py +++ b/python/databricks/bundles/pipelines/_models/transformer.py @@ -29,12 +29,14 @@ class Transformer: """ :meta private: [EXPERIMENTAL] - Required: the wire format of the data. + [Private Preview] Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -52,12 +54,14 @@ class TransformerDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Required: the wire format of the data. + [Private Preview] Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py index 2a4e85f02f4..21339a398eb 100644 --- a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py +++ b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py @@ -21,7 +21,7 @@ class ZendeskSupportOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date in YYYY-MM-DD format for the initial sync. + [Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """ @@ -40,7 +40,7 @@ class ZendeskSupportOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date in YYYY-MM-DD format for the initial sync. + [Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """ From e69435c0b39f91740c2390db6e29e69b4be6f53d Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Wed, 10 Jun 2026 08:53:48 +0200 Subject: [PATCH 10/11] Point VS Code at the local bundle schema for databricks.yml Map ./bundle/schema/jsonschema.json onto databricks.yml / bundle.yml in .vscode/settings.json so the schema generated in this repo is the one the editor validates and autocompletes against. Co-authored-by: Isaac --- .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 e6b64cd4f6a87a9158b7ee85a298518be2a4bee4 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Wed, 10 Jun 2026 09:04:21 +0200 Subject: [PATCH 11/11] Move PreviewTagShort to the annotation package Addresses review feedback: PreviewTagShort now lives alongside PreviewTag in bundle/internal/annotation, keeping the launch-stage label vocabulary in a single place. Pure refactor, no change to generated output. Co-authored-by: Isaac --- bundle/internal/annotation/preview.go | 14 ++++++++++++++ bundle/internal/annotation/preview_test.go | 17 +++++++++++++++++ bundle/internal/schema/annotations.go | 16 +--------------- 3 files changed, 32 insertions(+), 15 deletions(-) diff --git a/bundle/internal/annotation/preview.go b/bundle/internal/annotation/preview.go index 5b06d4bf9d0..f57f38ec2c8 100644 --- a/bundle/internal/annotation/preview.go +++ b/bundle/internal/annotation/preview.go @@ -15,3 +15,17 @@ func PreviewTag(launchStage string) string { } return "" } + +// 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 "" +} diff --git a/bundle/internal/annotation/preview_test.go b/bundle/internal/annotation/preview_test.go index b6f5977cb4a..fef3bcdef9d 100644 --- a/bundle/internal/annotation/preview_test.go +++ b/bundle/internal/annotation/preview_test.go @@ -23,3 +23,20 @@ func TestPreviewTag(t *testing.T) { assert.Equal(t, tc.want, annotation.PreviewTag(tc.launchStage)) } } + +func TestPreviewTagShort(t *testing.T) { + tests := []struct { + launchStage string + want string + }{ + {"PUBLIC_PREVIEW", "[PuPr]"}, + {"PUBLIC_BETA", "[Beta]"}, + {"PRIVATE_PREVIEW", "[PrPr]"}, + {"GA", ""}, + {"", ""}, + {"SOMETHING_ELSE", ""}, + } + for _, tc := range tests { + assert.Equal(t, tc.want, annotation.PreviewTagShort(tc.launchStage)) + } +} diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 3950c7897cd..44e7ad95d7f 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -207,7 +207,7 @@ func buildEnumDescriptions(enum []any, launchStages, descriptions map[string]str // 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) + short := annotation.PreviewTagShort(launchStage) switch { case short != "" && description != "": return short + " " + description @@ -217,20 +217,6 @@ func enumDescriptionLabel(launchStage, description string) string { 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 "" -} - // prefixWithPreviewTag prepends the launch-stage tag to a description while // guarding against double-tagging — if the description already starts with // the tag, it is returned unchanged.