From 3ddd19c0256d4bf4bfa969308723e4b84842f3de Mon Sep 17 00:00:00 2001 From: "databricks-ci-ghec-2[bot]" <184307802+databricks-ci-ghec-2[bot]@users.noreply.github.com> Date: Thu, 19 Nov 2026 07:11:06 +0000 Subject: [PATCH 1/2] Update Go SDK to v0.202.0 --- .codegen/_openapi_sha | 2 +- .codegen/cli.json | 1890 +++++++++++------ .../dependency-updates/go-sdk-v0.202.0.md | 1 + acceptance/cmd/pypi-wheel/output.txt | 4 +- .../workspace/apps/run-local-node/output.txt | 26 +- acceptance/help/output.txt | 2 +- acceptance/ssh/agent-launchers/output.txt | 48 +- bundle/internal/schema/annotations.yml | 20 - .../validation/generated/enum_fields.go | 4 +- bundle/schema/jsonschema.json | 91 +- .../published-app-integration.go | 26 +- .../usage-dashboards/usage-dashboards.go | 17 +- cmd/workspace/agent-kit/agent-kit.go | 28 +- cmd/workspace/ai-functions/ai-functions.go | 4 +- cmd/workspace/ai-search/ai-search.go | 150 +- .../clean-room-assets/clean-room-assets.go | 4 + cmd/workspace/connections/connections.go | 10 +- cmd/workspace/credentials/credentials.go | 4 +- .../data-classification.go | 23 +- cmd/workspace/data-quality/data-quality.go | 13 +- cmd/workspace/environments/environments.go | 12 +- cmd/workspace/functions/functions.go | 20 +- cmd/workspace/genie/genie.go | 26 +- cmd/workspace/lakewatch/lakewatch.go | 8 +- cmd/workspace/permissions/permissions.go | 34 +- cmd/workspace/pipelines/pipelines.go | 2 +- .../provider-files/provider-files.go | 28 +- .../provider-listings/provider-listings.go | 28 +- .../provider-personalization-requests.go | 16 +- .../provider-provider-analytics-dashboards.go | 25 +- .../provider-providers/provider-providers.go | 23 +- cmd/workspace/secrets/secrets.go | 94 +- .../software-artifacts/software-artifacts.go | 129 ++ cmd/workspace/tag-policies/tag-policies.go | 35 +- cmd/workspace/warehouses/warehouses.go | 18 +- .../workspace-settings-v2.go | 16 +- go.mod | 2 +- go.sum | 4 +- .../_models/anomaly_detection_config.py | 4 +- .../_models/cron_schedule.py | 10 +- .../_models/data_profiling_config.py | 76 +- .../_models/data_profiling_custom_metric.py | 20 +- .../_models/data_quality_monitor.py | 18 +- .../_models/inference_log_config.py | 24 +- .../_models/notification_destination.py | 2 + .../_models/notification_settings.py | 6 +- .../_models/time_series_config.py | 4 +- .../_models/ai_runtime_task_priority_class.py | 6 +- python/databricks/bundles/jobs/_models/job.py | 8 +- .../bundles/pipelines/_models/pipeline.py | 20 +- .../azure_key_vault_secret_scope_metadata.py | 8 +- .../_models/scope_backend_type.py | 3 +- .../bundles/sql_warehouses/_models/channel.py | 16 + .../_models/endpoint_tag_pair.py | 14 + .../sql_warehouses/_models/endpoint_tags.py | 6 + .../sql_warehouses/_models/sql_warehouse.py | 36 +- 56 files changed, 1916 insertions(+), 1252 deletions(-) create mode 100644 .nextchanges/dependency-updates/go-sdk-v0.202.0.md diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index b7f7be504e8..a9645feac47 100644 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -6005ee42f3882434563e5e1662aa0d95781ab781 \ No newline at end of file +874d8f1733df5029f169c35ed088d2f081eb6687 \ No newline at end of file diff --git a/.codegen/cli.json b/.codegen/cli.json index 96b1e8a0942..5f6725030fe 100644 --- a/.codegen/cli.json +++ b/.codegen/cli.json @@ -383,7 +383,8 @@ ] }, "session_id": { - "description": "Optional session identifier. When set, only entries with this exact `session_id` are\nreturned. Omitted-session (cross-session) entries are not included. Ignored when path is set.", + "description": "Deprecated: the service will ignore this filter. Until then, when set, only entries with\nthis exact `session_id` are returned, and omitted-session (cross-session) entries\nare not included. Ignored when path is set.", + "deprecated": true, "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -682,14 +683,15 @@ ] }, "path": { - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "IMMUTABLE" ] }, "session_id": { - "description": "Optional identifier for the session associated with this memory entry. When omitted, the\nentry applies across the actor's sessions.", + "description": "Deprecated: memory entries will be identified by `(actor_id, path)`, and the service will\nignore this field on writes and omit it from responses. Until then, an omitted value means the\nentry applies across the actor's sessions.", + "deprecated": true, "launch_stage": "PUBLIC_BETA", "behaviors": [ "IMMUTABLE", @@ -951,7 +953,8 @@ "launch_stage": "PUBLIC_BETA" }, "session_id": { - "description": "Optional session identifier. When set, only entries with this exact `session_id` are\nsearched. Omitted-session (cross-session) entries are not included.", + "description": "Deprecated: the service will ignore this filter. Until then, when set, only entries with\nthis exact `session_id` are searched, and omitted-session (cross-session) entries\nare not included.", + "deprecated": true, "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -1299,7 +1302,7 @@ "launch_stage": "GA" }, "labels": { - "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters.", + "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters. When multilabel is true, a single label is also accepted.", "launch_stage": "GA" }, "options": { @@ -1340,7 +1343,7 @@ "description": "ai_decide", "fields": { "version": { - "description": "The function API version to invoke. Defaults to \"1.0\". Supported versions: [\"1.0\"].", + "description": "The function API version to invoke. If unset, the version is inferred per row. Supported versions: [\"1.0\"].", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -1848,14 +1851,14 @@ "fields": { "name": { "description": "Name of the column.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "type_text": { "description": "Data type of the column (e.g., \"string\", \"int\", \"array\u003cfloat\u003e\").", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -1867,11 +1870,11 @@ "endpoint": { "description": "The Endpoint resource to create. Fields other than `endpoint.name` carry the desired\nconfiguration; `endpoint.name` is server-assigned from `parent` and `endpoint_id`.", "ref": "aisearch.Endpoint", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "endpoint_id": { "description": "Short name of the endpoint, which becomes the last segment of `name`. The server rejects\na request without it. The name can have at most 50 characters, can contain only lowercase\nletters, digits, hyphens, periods, and underscores, and must start and end with a letter\nor digit.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -1883,11 +1886,11 @@ "index": { "description": "The Index resource to create. Fields other than `index.name` carry the desired\nconfiguration; `index.name` is server-assigned from `parent` and `index_id`.", "ref": "aisearch.Index", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "index_id": { "description": "Three-level Unity Catalog table name for the new index, in the form `catalog.schema.name`.\nThe server composes the full `Index.name` as `{parent}/indexes/{index_id}` and rejects an\nempty value.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -1899,11 +1902,11 @@ "fields": { "key": { "description": "Key field for an AI Search endpoint tag.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "value": { "description": "[Optional] Value field for an AI Search endpoint tag.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -1915,14 +1918,14 @@ "fields": { "failed_primary_keys": { "description": "Primary keys of rows that failed to process.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "success_row_count": { "description": "Count of rows processed successfully.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -1937,9 +1940,9 @@ "FAILURE" ], "enum_launch_stages": { - "FAILURE": "PUBLIC_PREVIEW", - "PARTIAL_SUCCESS": "PUBLIC_PREVIEW", - "SUCCESS": "PUBLIC_PREVIEW" + "FAILURE": "GA", + "PARTIAL_SUCCESS": "GA", + "SUCCESS": "GA" } }, "aisearch.DeleteEndpointRequest": {}, @@ -1949,35 +1952,35 @@ "fields": { "columns_to_sync": { "description": "Columns of the source table to include in the index. When empty, all columns are synced. The\nprimary key and the embedding source or vector column are always synced. Only synced columns\ncan be returned in query results or used in filters.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "embedding_source_columns": { "description": "Columns whose text Databricks embeds during sync, using the model endpoint named on each\ncolumn. Set either this field or `embedding_vector_columns`, not both.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "embedding_vector_columns": { "description": "Columns of the source table that already hold precomputed embedding vectors. Set either this\nfield or `embedding_source_columns`, not both.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "embedding_writeback_table": { "description": "Three-level name of a Delta table to write the synced rows and computed embeddings to. It\napplies only when embeddings are computed from `embedding_source_columns`, and the table must\nnot already exist.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "pipeline_id": { "description": "The ID of the pipeline that is used to sync the index.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -1985,11 +1988,11 @@ "pipeline_type": { "description": "Sync mode of the pipeline that keeps the index up to date. `TRIGGERED` syncs at creation and\nthen each time SyncIndex is called; `CONTINUOUS` processes source changes as they arrive.\nStorage Optimized endpoints accept only `TRIGGERED`, and an unset value is rejected.", "ref": "aisearch.PipelineType", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "source_table": { "description": "Three-level Unity Catalog name of the source Delta table, in the form `catalog.schema.table`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2001,21 +2004,21 @@ "fields": { "embedding_source_columns": { "description": "Columns that contain the text to embed, each with the model endpoint that computes its\nembeddings.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "embedding_vector_columns": { "description": "Columns that hold precomputed embedding vectors. A single vector column is supported, and it\ncannot be the primary key.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "schema_json": { "description": "The schema of the index in JSON format, mapping each column name to its type. Supported\ntypes are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector columns: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`. The schema must include\nthe primary key column and the embedding vector column.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2027,15 +2030,15 @@ "fields": { "embedding_model_endpoint": { "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", - "launch_stage": "PUBLIC_PREVIEW" + "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": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "name": { "description": "Name of the column whose text is embedded.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -2044,11 +2047,11 @@ "fields": { "embedding_dimension": { "description": "Number of elements in each embedding vector. It must be positive.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "name": { "description": "Name of the column that holds the precomputed embedding vectors.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -2057,35 +2060,35 @@ "fields": { "budget_policy_id": { "description": "ID of the serverless budget policy to apply to the endpoint. The caller must have\npermission to use the policy. Set either this field or `usage_policy_id`, not both.\nResponses do not echo this field; they report the applied policy in\n`effective_budget_policy_id`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "create_time": { "description": "Time the endpoint was created.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "creator": { "description": "User name of the principal that created the endpoint. For a user, it is the user's email\naddress; for any other principal, it is the principal's unique name.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "custom_tags": { "description": "Custom tags assigned to the endpoint. On update, the list replaces all of the endpoint's\nexisting tags.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "effective_budget_policy_id": { "description": "ID of the budget policy that is currently applied to the endpoint.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2093,7 +2096,7 @@ "endpoint_status": { "description": "Current lifecycle state of the endpoint, with an optional message that explains it.", "ref": "aisearch.EndpointStatus", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2101,39 +2104,39 @@ "endpoint_type": { "description": "Type of endpoint. Required on create and immutable thereafter.", "ref": "aisearch.EndpointType", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "id": { "description": "System-generated UUID that uniquely identifies the endpoint.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "index_count": { "description": "Number of indexes on the endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "last_updated_user": { "description": "User name of the principal that last updated the endpoint, in the same format as `creator`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { "description": "Full resource name of the endpoint, in the form\n`workspaces/{workspace_id}/endpoints/{endpoint_id}`. On create, the server composes it\nfrom `parent` and `endpoint_id` and ignores any value supplied in the request body.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "replica_count": { "description": "The client-supplied desired number of replicas for the endpoint, applied at\ncreate/update time. Mutually exclusive with `target_qps`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2141,14 +2144,14 @@ "scaling_info": { "description": "Scaling information for the endpoint", "ref": "aisearch.EndpointScalingInfo", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "target_qps": { "description": "Target QPS for the endpoint. Mutually exclusive with `replica_count`. Best-effort;\nthe system does not guarantee this QPS will be achieved. Responses report the requested\nvalue in `scaling_info.requested_target_qps`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2156,21 +2159,21 @@ "throughput_info": { "description": "Throughput information for the endpoint", "ref": "aisearch.EndpointThroughputInfo", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "update_time": { "description": "Time the endpoint was last updated.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "usage_policy_id": { "description": "ID of the usage policy to apply to the endpoint. The server treats it as the same setting\nas `budget_policy_id`, so set only one of the two.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2212,7 +2215,7 @@ }, "requested_target_qps": { "description": "The requested QPS target for the endpoint. Best-effort; the system does not\nguarantee this QPS will be achieved.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2220,7 +2223,7 @@ "state": { "description": "The current state of the scaling change request.", "ref": "aisearch.ScalingChangeState", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2265,7 +2268,7 @@ "fields": { "message": { "description": "Human-readable detail about the endpoint's current state or the reason for a state transition.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2273,7 +2276,7 @@ "state": { "description": "Current lifecycle state of the endpoint. See `State` for the meaning of each value.", "ref": "aisearch.EndpointStatusState", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2294,15 +2297,15 @@ "STARTING" ], "enum_launch_stages": { - "DELETED": "PUBLIC_PREVIEW", - "OFFLINE": "PUBLIC_PREVIEW", - "ONLINE": "PUBLIC_PREVIEW", - "PROVISIONING": "PUBLIC_PREVIEW", - "RED_STATE": "PUBLIC_PREVIEW", + "DELETED": "GA", + "OFFLINE": "GA", + "ONLINE": "GA", + "PROVISIONING": "GA", + "RED_STATE": "GA", "STARTING": "PRIVATE_PREVIEW", "STOPPED": "PRIVATE_PREVIEW", "STOPPING": "PRIVATE_PREVIEW", - "YELLOW_STATE": "PUBLIC_PREVIEW" + "YELLOW_STATE": "GA" } }, "aisearch.EndpointThroughputInfo": { @@ -2310,7 +2313,7 @@ "fields": { "change_request_message": { "description": "Additional information about the throughput change request", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2318,56 +2321,56 @@ "change_request_state": { "description": "The state of the most recent throughput change request", "ref": "aisearch.ThroughputChangeRequestState", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "current_concurrency": { "description": "The current concurrency (total CPU) allocated to the endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "current_concurrency_utilization_percentage": { "description": "The current utilization of concurrency as a percentage (0-100)", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "current_num_replicas": { "description": "The current number of replicas allocated to the endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "maximum_concurrency_allowed": { "description": "The maximum concurrency allowed for this endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "minimal_concurrency_allowed": { "description": "The minimum concurrency allowed for this endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "requested_concurrency": { "description": "The requested concurrency (total CPU) for the endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "requested_num_replicas": { "description": "The requested number of replicas for the endpoint", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2381,8 +2384,8 @@ "STANDARD" ], "enum_launch_stages": { - "STANDARD": "PUBLIC_PREVIEW", - "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW" + "STANDARD": "GA", + "STORAGE_OPTIMIZED": "GA" } }, "aisearch.FacetResultData": { @@ -2390,14 +2393,14 @@ "fields": { "facet_array": { "description": "Facet rows; each row is `[facet_column_name, value_or_range, count]`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "facet_row_count": { "description": "Number of facet rows returned.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2411,7 +2414,7 @@ "fields": { "creator": { "description": "Creator of the index.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2419,7 +2422,7 @@ "delta_sync_index_spec": { "description": "Specification for a Delta Sync index. Set when `index_type` is `DELTA_SYNC`.", "ref": "aisearch.DeltaSyncIndexSpec", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE", "OPTIONAL" @@ -2428,7 +2431,7 @@ "direct_access_index_spec": { "description": "Specification for a Direct Access index. Set when `index_type` is `DIRECT_ACCESS`.", "ref": "aisearch.DirectAccessIndexSpec", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE", "OPTIONAL" @@ -2436,7 +2439,7 @@ }, "endpoint": { "description": "Name of the endpoint associated with the index. Ignored on create — the endpoint is\ntaken from `CreateIndexRequest.parent`; populated only on output.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2444,7 +2447,7 @@ "index_subtype": { "description": "Subtype of the index. Use `HYBRID` for vector and hybrid search, or `FULL_TEXT` for\nkeyword-only search without embeddings; `VECTOR` is not a supported create value. Set on\ncreate and immutable thereafter.", "ref": "aisearch.IndexSubtype", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE", "OPTIONAL" @@ -2453,18 +2456,18 @@ "index_type": { "description": "Type of index. A `DELTA_SYNC` index is kept in sync with a source Delta table; a\n`DIRECT_ACCESS` index holds rows that you write through UpsertData and RemoveData. Set on\ncreate and immutable thereafter.", "ref": "aisearch.IndexType", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "name": { "description": "Name of the AI Search index. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}/indexes/{index}`) on output, where\n`{index}` is the index's Unity Catalog table name. On create, the user-supplied UC\ntable name is conveyed via `CreateIndexRequest.index_id`; the server composes the\nfull `name` and returns it on the response.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "primary_key": { "description": "Name of the column that uniquely identifies each row. It must exist in the source table\n(Delta Sync) or in `schema_json` (Direct Access) and cannot be the embedding source or vector\ncolumn. Set on create and immutable thereafter.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] @@ -2472,7 +2475,7 @@ "status": { "description": "Current status of the index.", "ref": "aisearch.IndexStatus", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2485,35 +2488,35 @@ "detailed_state": { "description": "Lifecycle and ingestion state. An online index can still have a failed update.", "ref": "aisearch.IndexStatusState", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "index_url": { "description": "Index API URL used to perform operations on the index.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "indexed_row_count": { "description": "Number of rows indexed.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "message": { "description": "Human-readable detail about the index's current state.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "ready": { "description": "Whether the index can serve queries. After CreateIndex, poll GetIndex until true; message describes progress.\nThis does not guarantee freshness or update success; check detailed_state for update failures.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2540,21 +2543,21 @@ "DOWNLOADING" ], "enum_launch_stages": { - "DOWNLOADING": "PUBLIC_PREVIEW", - "OFFLINE": "PUBLIC_PREVIEW", - "OFFLINE_FAILED": "PUBLIC_PREVIEW", - "ONLINE": "PUBLIC_PREVIEW", - "ONLINE_CONTINUOUS_UPDATE": "PUBLIC_PREVIEW", - "ONLINE_DIRECT_ACCESS": "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_ENDPOINT": "PUBLIC_PREVIEW", - "PROVISIONING_INDEX": "PUBLIC_PREVIEW", - "PROVISIONING_INITIAL_SNAPSHOT": "PUBLIC_PREVIEW", - "PROVISIONING_PIPELINE_RESOURCES": "PUBLIC_PREVIEW" + "DOWNLOADING": "GA", + "OFFLINE": "GA", + "OFFLINE_FAILED": "GA", + "ONLINE": "GA", + "ONLINE_CONTINUOUS_UPDATE": "GA", + "ONLINE_DIRECT_ACCESS": "GA", + "ONLINE_NO_PENDING_UPDATE": "GA", + "ONLINE_PIPELINE_FAILED": "GA", + "ONLINE_TRIGGERED_UPDATE": "GA", + "ONLINE_UPDATING_PIPELINE_RESOURCES": "GA", + "PROVISIONING": "GA", + "PROVISIONING_ENDPOINT": "GA", + "PROVISIONING_INDEX": "GA", + "PROVISIONING_INITIAL_SNAPSHOT": "GA", + "PROVISIONING_PIPELINE_RESOURCES": "GA" } }, "aisearch.IndexSubtype": { @@ -2565,9 +2568,9 @@ "HYBRID" ], "enum_launch_stages": { - "FULL_TEXT": "PUBLIC_PREVIEW", - "HYBRID": "PUBLIC_PREVIEW", - "VECTOR": "PUBLIC_PREVIEW" + "FULL_TEXT": "GA", + "HYBRID": "GA", + "VECTOR": "GA" }, "enum_descriptions": { "FULL_TEXT": "An index that uses full-text search without vector embeddings.", @@ -2582,8 +2585,8 @@ "DIRECT_ACCESS" ], "enum_launch_stages": { - "DELTA_SYNC": "PUBLIC_PREVIEW", - "DIRECT_ACCESS": "PUBLIC_PREVIEW" + "DELTA_SYNC": "GA", + "DIRECT_ACCESS": "GA" }, "enum_descriptions": { "DELTA_SYNC": "An index that automatically syncs with a source Delta Table,", @@ -2594,14 +2597,14 @@ "fields": { "page_size": { "description": "Maximum number of endpoints to return in one page. The server applies its own page size\nlimit, so a page can hold fewer endpoints than `page_size` even when more remain.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { "description": "Page token from a previous response. If not provided, returns the first page.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2613,14 +2616,14 @@ "fields": { "endpoints": { "description": "The endpoints in the workspace.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "next_page_token": { "description": "A token that can be used to get the next page of results. Empty when there are no more results.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2631,14 +2634,14 @@ "fields": { "page_size": { "description": "Maximum number of indexes to return. When unset, every index on the endpoint is returned.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { "description": "Page token from a previous response. If not provided, returns the first page.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2650,14 +2653,14 @@ "fields": { "indexes": { "description": "The indexes on the endpoint. The field is named `indexes` (not the irregular plural\n`indices`) to satisfy core::0132, which derives the response field name from the\nListIndexes method. core::0158::response-plural-first-field independently computes the\nresource plural as `indices` and is satisfied via a scoped field exception below.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "next_page_token": { "description": "A token that can be used to get the next page of results. Empty when there are no more results.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2671,8 +2674,8 @@ "CONTINUOUS" ], "enum_launch_stages": { - "CONTINUOUS": "PUBLIC_PREVIEW", - "TRIGGERED": "PUBLIC_PREVIEW" + "CONTINUOUS": "GA", + "TRIGGERED": "GA" }, "enum_descriptions": { "CONTINUOUS": "the pipeline processes new data as it arrives in the source table to", @@ -2684,60 +2687,60 @@ "fields": { "columns": { "description": "Columns to include in each result row. Only columns that are part of the index can be\nreturned.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "columns_to_rerank": { "description": "Columns whose values are sent to the reranker.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "facets": { "description": "Facets to compute over the matched results (e.g. `\"category TOP 5\"`).", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "filters_json": { "description": "JSON object of filters to apply, serialized as a string. Each key is a column name with an\noptional operator suffix such as `\u003c`, `\u003e=`, `NOT`, or `OR`, and each value is the value to\ncompare against. Only columns that are part of the index can be filtered. See\nhttps://docs.databricks.com/aws/en/ai-search/query-ai-search#filters for the supported\noperators.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "max_results": { "description": "Maximum number of results to return. Defaults to 10. It corresponds to `num_results` in the\nVector Search API.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "query_columns": { "description": "Text columns to search for `query_text`. When empty, all text columns are searched.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "query_text": { "description": "Query text. Required for Delta Sync indexes that compute embeddings from a model endpoint, and\nfor `HYBRID` and `FULL_TEXT` queries.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "query_type": { "description": "Query type: `ANN` for vector similarity search, `HYBRID` for combined vector and keyword\nsearch, or `FULL_TEXT` for keyword search without embeddings. Defaults to `ANN`.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "query_vector": { "description": "Query vector. Required for Direct Access indexes and Delta Sync indexes with self-managed\nvectors.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2745,21 +2748,21 @@ "reranker": { "description": "If set, results are reranked before being returned. See\nhttps://docs.databricks.com/aws/en/ai-search/query-ai-search#rerank for details.", "ref": "aisearch.RerankerConfig", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "score_threshold": { "description": "Score threshold for the approximate nearest-neighbor search; results that score below it are\nnot returned. Defaults to 0.0.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "sort_columns": { "description": "Sort clauses, e.g. `[\"rating DESC\", \"price ASC\"]`. Overrides relevance ordering.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2772,7 +2775,7 @@ "facet_result": { "description": "Facet aggregation rows, when facets were requested.", "ref": "aisearch.FacetResultData", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2780,7 +2783,7 @@ "manifest": { "description": "Metadata describing the result columns.", "ref": "aisearch.ResultManifest", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2788,7 +2791,7 @@ "result": { "description": "The matched result rows.", "ref": "aisearch.ResultData", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2800,7 +2803,7 @@ "fields": { "primary_keys": { "description": "Primary keys of the rows to remove.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -2810,7 +2813,7 @@ "result": { "description": "Per-row outcome of the delete.", "ref": "aisearch.DataModificationResult", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2818,7 +2821,7 @@ "status": { "description": "Overall status of the delete: `SUCCESS` when every row was removed, `PARTIAL_SUCCESS` when\nsome rows failed (see `result.failed_primary_keys`), or `FAILURE` when the operation failed.", "ref": "aisearch.DataModificationStatus", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2830,7 +2833,7 @@ "fields": { "model": { "description": "Reranker identifier: \"databricks_reranker\" for the base model, or a Model Serving\nendpoint name when `model_type` is MODEL_TYPE_FINETUNED.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2838,7 +2841,7 @@ "model_type": { "description": "Discriminator for how `model` is interpreted.", "ref": "aisearch.RerankerConfigModelType", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2846,7 +2849,7 @@ "parameters": { "description": "Parameters controlling reranking.", "ref": "aisearch.RerankerConfigRerankerParameters", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2860,8 +2863,8 @@ "MODEL_TYPE_FINETUNED" ], "enum_launch_stages": { - "MODEL_TYPE_BASE": "PUBLIC_PREVIEW", - "MODEL_TYPE_FINETUNED": "PUBLIC_PREVIEW" + "MODEL_TYPE_BASE": "GA", + "MODEL_TYPE_FINETUNED": "GA" } }, "aisearch.RerankerConfigRerankerParameters": { @@ -2869,7 +2872,7 @@ "fields": { "columns_to_rerank": { "description": "Columns whose values are concatenated and sent to the reranker.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2881,14 +2884,14 @@ "fields": { "data_array": { "description": "Result rows; each row is a list of column values aligned with the manifest columns.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "row_count": { "description": "Number of rows in the result set.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2900,28 +2903,28 @@ "fields": { "column_count": { "description": "Number of columns in the result set.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "columns": { "description": "Information about each column in the result set.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "facet_column_count": { "description": "Number of columns in the facet result.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "facet_columns": { "description": "Information about each facet column.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2936,9 +2939,9 @@ "SCALING_CHANGE_IN_PROGRESS" ], "enum_launch_stages": { - "SCALING_CHANGE_APPLIED": "PUBLIC_PREVIEW", - "SCALING_CHANGE_IN_PROGRESS": "PUBLIC_PREVIEW", - "SCALING_CHANGE_UNSPECIFIED": "PUBLIC_PREVIEW" + "SCALING_CHANGE_APPLIED": "GA", + "SCALING_CHANGE_IN_PROGRESS": "GA", + "SCALING_CHANGE_UNSPECIFIED": "GA" } }, "aisearch.ScanIndexRequest": { @@ -2946,14 +2949,14 @@ "fields": { "page_size": { "description": "Maximum number of rows to return in this page. Defaults to 10.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { "description": "Page token from a previous response; if unset, scanning starts from the beginning.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -2965,14 +2968,14 @@ "fields": { "data": { "description": "Rows in this page, ordered by primary key. Each row is a JSON object that maps column names to\nvalues.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "next_page_token": { "description": "Token for the next page; empty when the scan is exhausted.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -2996,12 +2999,12 @@ "CHANGE_ADJUSTED" ], "enum_launch_stages": { - "CHANGE_ADJUSTED": "PUBLIC_PREVIEW", - "CHANGE_FAILED": "PUBLIC_PREVIEW", - "CHANGE_IN_PROGRESS": "PUBLIC_PREVIEW", - "CHANGE_REACHED_MAXIMUM": "PUBLIC_PREVIEW", - "CHANGE_REACHED_MINIMUM": "PUBLIC_PREVIEW", - "CHANGE_SUCCESS": "PUBLIC_PREVIEW" + "CHANGE_ADJUSTED": "GA", + "CHANGE_FAILED": "GA", + "CHANGE_IN_PROGRESS": "GA", + "CHANGE_REACHED_MAXIMUM": "GA", + "CHANGE_REACHED_MINIMUM": "GA", + "CHANGE_SUCCESS": "GA" } }, "aisearch.UpdateEndpointRequest": { @@ -3009,11 +3012,11 @@ "endpoint": { "description": "The Endpoint resource to update. `endpoint.name` carries the full resource path.", "ref": "aisearch.Endpoint", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "update_mask": { "description": "Comma-separated list of `Endpoint` fields to update. The updatable fields are\n`budget_policy_id`, `usage_policy_id`, `custom_tags`, `replica_count`, and `target_qps`.\nThe server rejects nested paths and unknown fields.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -3022,7 +3025,7 @@ "fields": { "inputs_json": { "description": "JSON array of the rows to insert or update, serialized as a string. Each element is an object\nthat maps column names to values and must include the primary key column; vector columns are\ngiven as arrays of numbers. A row whose primary key already exists is overwritten. The array\nmust not be empty.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -3032,7 +3035,7 @@ "result": { "description": "Per-row outcome of the upsert.", "ref": "aisearch.DataModificationResult", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -3040,7 +3043,7 @@ "status": { "description": "Overall status of the upsert: `SUCCESS` when every row was written, `PARTIAL_SUCCESS` when\nsome rows failed (see `result.failed_primary_keys`), or `FAILURE` when the operation failed.", "ref": "aisearch.DataModificationStatus", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] @@ -5552,17 +5555,17 @@ "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.", + "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.\nThe request fails if the type is not set.", "ref": "billing.UsageDashboardType", "launch_stage": "GA" }, "major_version": { - "description": "The major version of the usage dashboard template to use. Defaults to VERSION_1.", + "description": "The major version of the usage dashboard template to import. Version 2 adds cost forecasting and\nobject-level cost drill-down.", "ref": "billing.UsageDashboardMajorVersion", "launch_stage": "GA" }, "workspace_id": { - "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "description": "The ID of the workspace to import the usage dashboard into. The workspace must be running, belong\nto the account, and not be a disaster recovery secondary.", "launch_stage": "GA" } } @@ -5570,7 +5573,7 @@ "billing.CreateBillingUsageDashboardResponse": { "fields": { "dashboard_id": { - "description": "The unique id of the usage dashboard.", + "description": "The ID of the AI/BI dashboard that was created.", "launch_stage": "GA" } } @@ -5811,12 +5814,12 @@ "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.", + "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.\nThe request fails if the type is not set.", "ref": "billing.UsageDashboardType", "launch_stage": "GA" }, "workspace_id": { - "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "description": "The ID of the workspace that contains the usage dashboard. If omitted, the most recently created\ndashboard of the given type across all workspaces in the account is returned.", "launch_stage": "GA" } } @@ -5824,11 +5827,11 @@ "billing.GetBillingUsageDashboardResponse": { "fields": { "dashboard_id": { - "description": "The unique id of the usage dashboard.", + "description": "The ID of the AI/BI dashboard. The ID is empty if no matching dashboard is found.", "launch_stage": "GA" }, "dashboard_url": { - "description": "The URL of the usage dashboard.", + "description": "The URL of the dashboard in its workspace. The URL is empty if no matching dashboard is found.", "launch_stage": "GA" } } @@ -7974,7 +7977,7 @@ "launch_stage": "GA" }, "connection_type": { - "description": "The type of connection.", + "description": "The type of external data source or service that the connection reaches. The connection type\ndetermines which keys are required in options and cannot be changed after creation.", "ref": "catalog.ConnectionType", "launch_stage": "GA" }, @@ -7987,12 +7990,12 @@ "launch_stage": "GA" }, "credential_type": { - "description": "The type of credential.", + "description": "The type of credential that is used to authenticate to the external data source. The server\nderives it from the connection type and the keys present in options.", "ref": "catalog.CredentialType", "launch_stage": "GA" }, "environment_settings": { - "description": "[Create,Update:OPT] Connection environment settings as EnvironmentSettings object.", + "description": "Environment settings for the connection, such as the Java libraries that it needs and the\nenvironment version.", "ref": "catalog.EnvironmentSettings", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -8016,7 +8019,7 @@ "launch_stage": "GA" }, "owner": { - "description": "Username of current owner of the connection.", + "description": "Username of the current owner of the connection. The creator becomes the owner at creation, and\nownership can be transferred on update.", "launch_stage": "GA" }, "properties": { @@ -8024,11 +8027,12 @@ "launch_stage": "GA" }, "provisioning_info": { + "description": "Provisioning status of the connection.", "ref": "catalog.ProvisioningInfo", "launch_stage": "GA" }, "read_only": { - "description": "If the connection is read only.", + "description": "Whether the connection is read only. All connections are currently read only, so a value set on\ncreate or update is ignored.", "launch_stage": "GA" }, "secrets": { @@ -8039,6 +8043,7 @@ ] }, "securable_type": { + "description": "The type of Unity Catalog securable. This is always CONNECTION.", "ref": "catalog.SecurableType", "launch_stage": "GA" }, @@ -8051,7 +8056,7 @@ "launch_stage": "GA" }, "url": { - "description": "URL of the remote data source, extracted from options.", + "description": "URL of the remote data source. The server derives it from the host, port and path options.", "launch_stage": "GA" } } @@ -8293,12 +8298,12 @@ "launch_stage": "GA" }, "connection_type": { - "description": "The type of connection.", + "description": "The type of external data source or service that the connection reaches. The connection type\ndetermines which keys are required in options and cannot be changed after creation.", "ref": "catalog.ConnectionType", "launch_stage": "GA" }, "environment_settings": { - "description": "[Create,Update:OPT] Connection environment settings as EnvironmentSettings object.", + "description": "Environment settings for the connection, such as the Java libraries that it needs and the\nenvironment version.", "ref": "catalog.EnvironmentSettings", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -8325,7 +8330,7 @@ "launch_stage": "GA" }, "read_only": { - "description": "If the connection is read only.", + "description": "Whether the connection is read only. All connections are currently read only, so a value set on\ncreate or update is ignored.", "launch_stage": "GA" }, "secrets": { @@ -8468,6 +8473,7 @@ } }, "catalog.CreateFunction": { + "description": "A user-defined function (UDF) registered in Unity Catalog. A function belongs to a schema and is referenced as\ncatalog_name.schema_name.function_name. Its body is either a SQL expression or query, or source code in an\nexternal language such as Python. See https://docs.databricks.com/aws/en/udf/unity-catalog for an overview.", "fields": { "catalog_name": { "description": "Name of parent Catalog.", @@ -8478,33 +8484,33 @@ "launch_stage": "GA" }, "data_type": { - "description": "Scalar function return data type.", + "description": "Data type of the value the function returns. A table function uses TABLE_TYPE\nand describes its result columns in return_params, except for a polymorphic Python UDTF, which omits them.", "ref": "catalog.ColumnTypeName", "launch_stage": "GA" }, "external_language": { - "description": "External function language.", + "description": "Language of the function body for an EXTERNAL function. It is required when\nroutine_body is EXTERNAL.", "launch_stage": "GA" }, "external_name": { - "description": "External function name.", + "description": "Name of the function in its external language. It is reserved for future use.", "launch_stage": "GA" }, "full_data_type": { - "description": "Pretty printed function data type.", + "description": "Return data type of the function in SQL syntax, including any type parameters\nsuch as precision and scale.", "launch_stage": "GA" }, "input_params": { - "description": "Function input parameters.", + "description": "Input parameters of the function. When it is set, parameters must contain at least\none entry. A function that takes no arguments omits input_params, even though the Create request schema marks it\nas required.", "ref": "catalog.FunctionParameterInfos", "launch_stage": "GA" }, "is_deterministic": { - "description": "Whether the function is deterministic.", + "description": "Whether the function returns the same result for the same arguments. It\ncorresponds to the DETERMINISTIC characteristic of CREATE FUNCTION.", "launch_stage": "GA" }, "is_null_call": { - "description": "Function null call.", + "description": "Whether the function is a null-call function in the sense of the SQL standard,\nwhich returns NULL whenever any argument is NULL.", "launch_stage": "GA" }, "name": { @@ -8512,7 +8518,7 @@ "launch_stage": "GA" }, "parameter_style": { - "description": "Function parameter style. **S** is the value for SQL.", + "description": "How arguments are passed to the function body. S means that each argument is\npassed as a single scalar value.", "ref": "catalog.CreateFunctionParameterStyle", "launch_stage": "GA" }, @@ -8521,17 +8527,17 @@ "launch_stage": "GA" }, "return_params": { - "description": "Table function return parameters.", + "description": "Result columns of a table function. Set it when data_type is TABLE_TYPE, except\nfor a polymorphic Python UDTF (an EXTERNAL Python function with full_data_type \"()\"), which must not set it.", "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**.", + "description": "Language of the function body. SQL means that routine_definition holds a SQL\nexpression or query. EXTERNAL means that it holds source code in the language named by external_language, and\nsql_data_access must then be NO_SQL.", "ref": "catalog.CreateFunctionRoutineBody", "launch_stage": "GA" }, "routine_definition": { - "description": "Function body.", + "description": "Body of the function. For a SQL function it is the expression or query that\ncomputes the result; for an EXTERNAL function it is the source code of the function. It is omitted when the\ncaller can only browse the function.", "launch_stage": "GA" }, "routine_dependencies": { @@ -8544,21 +8550,21 @@ "launch_stage": "GA" }, "security_type": { - "description": "Function security type.", + "description": "Whose privileges the function body runs with. DEFINER runs it with the privileges\nof the function owner.", "ref": "catalog.CreateFunctionSecurityType", "launch_stage": "GA" }, "specific_name": { - "description": "Specific name of the function; Reserved for future use.", + "description": "Specific name of the function. Set it to the same value as name.", "launch_stage": "GA" }, "sql_data_access": { - "description": "Function SQL data access.", + "description": "How the function body interacts with SQL data. CONTAINS_SQL means that the body\ncontains SQL but reads no table or view, READS_SQL_DATA means that it reads a table or view, and NO_SQL is\nrequired for EXTERNAL functions.", "ref": "catalog.CreateFunctionSqlDataAccess", "launch_stage": "GA" }, "sql_path": { - "description": "List of schemes whose objects can be referenced without qualification.", + "description": "List of schemas whose objects can be referenced without qualification.", "launch_stage": "GA" } } @@ -9392,7 +9398,7 @@ "catalog.DeleteFunctionRequest": { "fields": { "force": { - "description": "Force deletion even if the function is notempty.", + "description": "Force deletion even if the function is not empty.", "launch_stage": "GA" } } @@ -10326,6 +10332,7 @@ } }, "catalog.FunctionInfo": { + "description": "A user-defined function (UDF) registered in Unity Catalog. A function belongs to a schema and is referenced as\ncatalog_name.schema_name.function_name. Its body is either a SQL expression or query, or source code in an\nexternal language such as Python. See https://docs.databricks.com/aws/en/udf/unity-catalog for an overview.", "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.", @@ -10348,20 +10355,20 @@ "launch_stage": "GA" }, "data_type": { - "description": "Scalar function return data type.", + "description": "Data type of the value the function returns. A table function uses TABLE_TYPE\nand describes its result columns in return_params, except for a polymorphic Python UDTF, which omits them.", "ref": "catalog.ColumnTypeName", "launch_stage": "GA" }, "external_language": { - "description": "External function language.", + "description": "Language of the function body for an EXTERNAL function. It is required when\nroutine_body is EXTERNAL.", "launch_stage": "GA" }, "external_name": { - "description": "External function name.", + "description": "Name of the function in its external language. It is reserved for future use.", "launch_stage": "GA" }, "full_data_type": { - "description": "Pretty printed function data type.", + "description": "Return data type of the function in SQL syntax, including any type parameters\nsuch as precision and scale.", "launch_stage": "GA" }, "full_name": { @@ -10373,16 +10380,16 @@ "launch_stage": "GA" }, "input_params": { - "description": "Function input parameters.", + "description": "Input parameters of the function. When it is set, parameters must contain at least\none entry. A function that takes no arguments omits input_params, even though the Create request schema marks it\nas required.", "ref": "catalog.FunctionParameterInfos", "launch_stage": "GA" }, "is_deterministic": { - "description": "Whether the function is deterministic.", + "description": "Whether the function returns the same result for the same arguments. It\ncorresponds to the DETERMINISTIC characteristic of CREATE FUNCTION.", "launch_stage": "GA" }, "is_null_call": { - "description": "Function null call.", + "description": "Whether the function is a null-call function in the sense of the SQL standard,\nwhich returns NULL whenever any argument is NULL.", "launch_stage": "GA" }, "metastore_id": { @@ -10398,7 +10405,7 @@ "launch_stage": "GA" }, "parameter_style": { - "description": "Function parameter style. **S** is the value for SQL.", + "description": "How arguments are passed to the function body. S means that each argument is\npassed as a single scalar value.", "ref": "catalog.FunctionInfoParameterStyle", "launch_stage": "GA" }, @@ -10407,17 +10414,17 @@ "launch_stage": "GA" }, "return_params": { - "description": "Table function return parameters.", + "description": "Result columns of a table function. Set it when data_type is TABLE_TYPE, except\nfor a polymorphic Python UDTF (an EXTERNAL Python function with full_data_type \"()\"), which must not set it.", "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**.", + "description": "Language of the function body. SQL means that routine_definition holds a SQL\nexpression or query. EXTERNAL means that it holds source code in the language named by external_language, and\nsql_data_access must then be NO_SQL.", "ref": "catalog.FunctionInfoRoutineBody", "launch_stage": "GA" }, "routine_definition": { - "description": "Function body.", + "description": "Body of the function. For a SQL function it is the expression or query that\ncomputes the result; for an EXTERNAL function it is the source code of the function. It is omitted when the\ncaller can only browse the function.", "launch_stage": "GA" }, "routine_dependencies": { @@ -10430,21 +10437,21 @@ "launch_stage": "GA" }, "security_type": { - "description": "Function security type.", + "description": "Whose privileges the function body runs with. DEFINER runs it with the privileges\nof the function owner.", "ref": "catalog.FunctionInfoSecurityType", "launch_stage": "GA" }, "specific_name": { - "description": "Specific name of the function; Reserved for future use.", + "description": "Specific name of the function. Set it to the same value as name.", "launch_stage": "GA" }, "sql_data_access": { - "description": "Function SQL data access.", + "description": "How the function body interacts with SQL data. CONTAINS_SQL means that the body\ncontains SQL but reads no table or view, READS_SQL_DATA means that it reads a table or view, and NO_SQL is\nrequired for EXTERNAL functions.", "ref": "catalog.FunctionInfoSqlDataAccess", "launch_stage": "GA" }, "sql_path": { - "description": "List of schemes whose objects can be referenced without qualification.", + "description": "List of schemas whose objects can be referenced without qualification.", "launch_stage": "GA" }, "updated_at": { @@ -10506,29 +10513,29 @@ "launch_stage": "GA" }, "parameter_default": { - "description": "Default value of the parameter.", + "description": "Default value of the parameter as a SQL expression, used when a call omits the\nargument.", "launch_stage": "GA" }, "parameter_mode": { - "description": "Function parameter mode.", + "description": "Direction of the parameter. Only IN parameters, which pass a value into the\nfunction, are supported.", "ref": "catalog.FunctionParameterMode", "launch_stage": "GA" }, "parameter_type": { - "description": "Function parameter type.", + "description": "Whether the entry is an input parameter (PARAM) or a result column of a table\nfunction (COLUMN).", "ref": "catalog.FunctionParameterType", "launch_stage": "GA" }, "position": { - "description": "Ordinal position of column (starting at position 0).", + "description": "Zero-based position of the parameter in the parameter list. Positions must be\nunique and consecutive.", "launch_stage": "GA" }, "type_interval_type": { - "description": "Format of IntervalType.", + "description": "Unit range of the data type for INTERVAL parameters. It is unset for other\ntypes.", "launch_stage": "GA" }, "type_json": { - "description": "Full data type spec, JSON-serialized.", + "description": "Data type of the parameter as the JSON representation of a Spark SQL struct\nfield, with name, type, nullable and metadata keys.", "launch_stage": "GA" }, "type_name": { @@ -10545,7 +10552,7 @@ "launch_stage": "GA" }, "type_text": { - "description": "Full data type spec, SQL/catalogString text.", + "description": "Data type of the parameter in SQL syntax, including any type parameters such\nas precision and scale.", "launch_stage": "GA" } } @@ -10553,6 +10560,7 @@ "catalog.FunctionParameterInfos": { "fields": { "parameters": { + "description": "The parameters that make up the list, ordered by position.", "launch_stage": "GA" } } @@ -10579,6 +10587,7 @@ "description": "GCP temporary credentials for API authentication.\nRead more at https://developers.google.com/identity/protocols/oauth2/service-account", "fields": { "oauth_token": { + "description": "The OAuth 2.0 access token to pass as a bearer token to Google Cloud APIs.", "launch_stage": "GA" } } @@ -10618,14 +10627,17 @@ "catalog.GenerateTemporaryPathCredentialResponse": { "fields": { "aws_temp_credentials": { + "description": "Temporary AWS credentials that can be used to sign AWS API requests.", "ref": "catalog.AwsCredentials", "launch_stage": "GA" }, "azure_aad": { + "description": "A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the credential's identity.", "ref": "catalog.AzureActiveDirectoryToken", "launch_stage": "GA" }, "azure_user_delegation_sas": { + "description": "An Azure user delegation shared access signature (SAS) that grants access to the requested storage path.", "ref": "catalog.AzureUserDelegationSas", "launch_stage": "GA" }, @@ -10634,10 +10646,12 @@ "launch_stage": "GA" }, "gcp_oauth_token": { + "description": "A GCP OAuth 2.0 access token that is issued for the credential's service account.", "ref": "catalog.GcpOauthToken", "launch_stage": "GA" }, "r2_temp_credentials": { + "description": "Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API.", "ref": "catalog.R2Credentials", "launch_stage": "GA" }, @@ -10651,7 +10665,7 @@ "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)", + "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).\nExactly one resource is supported, and its URL must end with the `.default` scope.", "launch_stage": "GA" } } @@ -10660,7 +10674,7 @@ "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)", + "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).\nEach scope must be a Google OAuth 2.0 scope URL on the `googleapis.com` or `www.googleapis.com` host.", "launch_stage": "GA" } } @@ -10668,6 +10682,7 @@ "catalog.GenerateTemporaryServiceCredentialRequest": { "fields": { "azure_options": { + "description": "Options for an Azure service credential. They are required when the service credential uses an Azure managed\nidentity.", "ref": "catalog.GenerateTemporaryServiceCredentialAzureOptions", "launch_stage": "GA" }, @@ -10676,6 +10691,7 @@ "launch_stage": "GA" }, "gcp_options": { + "description": "Options for a GCP service credential. They are required when the service credential uses a Databricks-managed GCP\nservice account.", "ref": "catalog.GenerateTemporaryServiceCredentialGcpOptions", "launch_stage": "GA" } @@ -10697,14 +10713,17 @@ "catalog.GenerateTemporaryTableCredentialResponse": { "fields": { "aws_temp_credentials": { + "description": "Temporary AWS credentials that can be used to sign AWS API requests.", "ref": "catalog.AwsCredentials", "launch_stage": "GA" }, "azure_aad": { + "description": "A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the credential's identity.", "ref": "catalog.AzureActiveDirectoryToken", "launch_stage": "GA" }, "azure_user_delegation_sas": { + "description": "An Azure user delegation shared access signature (SAS) that grants access to the requested storage path.", "ref": "catalog.AzureUserDelegationSas", "launch_stage": "GA" }, @@ -10713,10 +10732,12 @@ "launch_stage": "GA" }, "gcp_oauth_token": { + "description": "A GCP OAuth 2.0 access token that is issued for the credential's service account.", "ref": "catalog.GcpOauthToken", "launch_stage": "GA" }, "r2_temp_credentials": { + "description": "Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API.", "ref": "catalog.R2Credentials", "launch_stage": "GA" }, @@ -10743,14 +10764,17 @@ "catalog.GenerateTemporaryVolumeCredentialResponse": { "fields": { "aws_temp_credentials": { + "description": "Temporary AWS credentials that can be used to sign AWS API requests.", "ref": "catalog.AwsCredentials", "launch_stage": "PUBLIC_PREVIEW" }, "azure_aad": { + "description": "A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the credential's identity.", "ref": "catalog.AzureActiveDirectoryToken", "launch_stage": "PUBLIC_PREVIEW" }, "azure_user_delegation_sas": { + "description": "An Azure user delegation shared access signature (SAS) that grants access to the requested storage path.", "ref": "catalog.AzureUserDelegationSas", "launch_stage": "PUBLIC_PREVIEW" }, @@ -10759,10 +10783,12 @@ "launch_stage": "PUBLIC_PREVIEW" }, "gcp_oauth_token": { + "description": "A GCP OAuth 2.0 access token that is issued for the credential's service account.", "ref": "catalog.GcpOauthToken", "launch_stage": "PUBLIC_PREVIEW" }, "r2_temp_credentials": { + "description": "Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API.", "ref": "catalog.R2Credentials", "launch_stage": "PUBLIC_PREVIEW" }, @@ -15731,10 +15757,12 @@ "catalog.TemporaryCredentials": { "fields": { "aws_temp_credentials": { + "description": "Temporary AWS credentials that can be used to sign AWS API requests.", "ref": "catalog.AwsCredentials", "launch_stage": "GA" }, "azure_aad": { + "description": "A Microsoft Entra ID (formerly Azure Active Directory) token that is issued for the credential's identity.", "ref": "catalog.AzureActiveDirectoryToken", "launch_stage": "GA" }, @@ -15743,10 +15771,12 @@ "launch_stage": "GA" }, "gcp_oauth_token": { + "description": "A GCP OAuth 2.0 access token that is issued for the credential's service account.", "ref": "catalog.GcpOauthToken", "launch_stage": "GA" }, "r2_temp_credentials": { + "description": "Temporary Cloudflare R2 credentials that can be used with the R2 S3-compatible API.", "ref": "catalog.R2Credentials", "launch_stage": "GA" } @@ -15939,7 +15969,7 @@ "catalog.UpdateConnection": { "fields": { "environment_settings": { - "description": "[Create,Update:OPT] Connection environment settings as EnvironmentSettings object.", + "description": "Environment settings for the connection, such as the Java libraries that it needs and the\nenvironment version.", "ref": "catalog.EnvironmentSettings", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -15955,7 +15985,7 @@ "launch_stage": "GA" }, "owner": { - "description": "Username of current owner of the connection.", + "description": "Username of the current owner of the connection. The creator becomes the owner at creation, and\nownership can be transferred on update.", "launch_stage": "GA" }, "secrets": { @@ -17132,7 +17162,7 @@ ] }, "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**", + "description": "Local details for a foreign table that are only available to its owner.\nPresent if and only if **asset_type** is **FOREIGN_TABLE**", "ref": "cleanrooms.CleanRoomAssetForeignTableLocalDetails", "launch_stage": "GA", "behaviors": [ @@ -17167,7 +17197,7 @@ ] }, "status": { - "description": "Status of the asset", + "description": "The sharing status of the asset. `PERMISSION_DENIED` means the clean room owner no longer has\nthe privileges needed on the underlying Unity Catalog object, so the asset is not shared into the\nclean room.", "ref": "cleanrooms.CleanRoomAssetStatusEnum", "launch_stage": "GA", "behaviors": [ @@ -24345,14 +24375,14 @@ "dashboards.GenieEvalResponse": { "fields": { "response": { - "description": "The response content (either text or SQL query).", + "description": "The content of this entry is the SQL statement when `response_type` is SQL, or Genie's text answer when it\nis TEXT.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "response_type": { - "description": "Type of response", + "description": "Whether this entry is a SQL statement or a text answer.", "ref": "dashboards.GenieEvalResponseType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -24360,7 +24390,7 @@ ] }, "sql_execution_result": { - "description": "SQL Statement Execution response.", + "description": "Result of executing the SQL statement, only set when `response_type` is SQL. The value has the structure of\na [Statement Execution API response](https://docs.databricks.com/api/statement-execution/v1/get-statement-result).", "ref": "sql.StatementResponse", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -24383,7 +24413,7 @@ "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.", + "description": "Benchmark SQL statement that defines the expected answer, as it was when the run started.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -24394,14 +24424,14 @@ "launch_stage": "PUBLIC_BETA" }, "created_by_user": { - "description": "User ID who created evaluation result.", + "description": "ID of the user who started the evaluation run.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "question": { - "description": "Stored snapshot of original benchmark question text.", + "description": "Text of the benchmark question as it was when the run started. Later edits to the question do not change it.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -24416,7 +24446,7 @@ "launch_stage": "PUBLIC_BETA" }, "status": { - "description": "Current status of this evaluation result.", + "description": "Current status of this result. NOT_STARTED and RUNNING mean the question has not finished. DONE means Genie\nanswered and the response was assessed. EVALUATION_FAILED means Genie could not answer the question or the\nbenchmark SQL could not run. EVALUATION_CANCELLED and EVALUATION_TIMEOUT mean the run was cancelled or its\nbackground job stopped before this question finished.", "ref": "dashboards.EvaluationStatusType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -24429,14 +24459,14 @@ "description": "Shows detailed information for an evaluation result.", "fields": { "actual_response": { - "description": "The actual response generated by Genie.", + "description": "Genie's response to the benchmark question. A SQL entry carries the generated statement and its execution\nresult, and a TEXT entry carries Genie's text answer. The list is empty when Genie produced no response.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "assessment": { - "description": "Assessment of the evaluation result: good, bad, or needs review", + "description": "Outcome of comparing Genie's response with the benchmark. GOOD means the results matched, BAD means they\ndiffered, and NEEDS_REVIEW means the comparison was inconclusive and a person should review the result. The\nvalue is only meaningful once the result status is DONE.", "ref": "dashboards.GenieEvalAssessment", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -24455,7 +24485,7 @@ "launch_stage": "PUBLIC_BETA" }, "eval_run_status": { - "description": "Current status of the evaluation run.", + "description": "Current status of this evaluation result, not of the whole run. Once the status is DONE,\nthe response and automatic assessment are complete. A user can still change the assessment manually.", "ref": "dashboards.EvaluationStatusType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -24463,14 +24493,14 @@ ] }, "expected_response": { - "description": "The expected responses from the benchmark.", + "description": "The expected answer from the benchmark question: one SQL entry with the benchmark SQL statement and its\nexecution result.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "manual_assessment": { - "description": "Whether this evaluation was manually assessed.", + "description": "Whether a user set the assessment manually after reviewing the result. A manual assessment replaces the\nautomatic one and clears `assessment_reasons`.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -24487,7 +24517,7 @@ } }, "dashboards.GenieEvalRunResponse": { - "description": "A benchmark evaluation run. The public benchmark API currently evaluates chat-mode responses.", + "description": "A benchmark evaluation run. A run asks Genie each selected benchmark question in a Genie space, compares\nevery response with the benchmark SQL, and records one evaluation result per question. Runs execute\nasynchronously; poll the run until its status is terminal, then list its results. All evaluation run methods\nrequire CAN EDIT permission on the space. The public benchmark API currently evaluates chat-mode responses.", "fields": { "created_timestamp": { "description": "Timestamp when the evaluation run was created (milliseconds since epoch).", @@ -24498,7 +24528,7 @@ "launch_stage": "PUBLIC_BETA" }, "eval_run_status": { - "description": "Current status of the evaluation run.", + "description": "Current status of the run, derived from the statuses of its results. Unless a result has timed out\nor the run has been cancelled, the run is RUNNING while any question has not finished. It is DONE\nonce every question has finished, whether it was scored or failed.\nEVALUATION_CANCELLED means the run was cancelled before all questions finished, and EVALUATION_TIMEOUT\nmeans the background evaluation job stopped before they did.\nDONE, EVALUATION_CANCELLED and EVALUATION_TIMEOUT are terminal run statuses.\nNOT_STARTED and EVALUATION_FAILED appear only on individual results.", "ref": "dashboards.EvaluationStatusType", "launch_stage": "PUBLIC_BETA" }, @@ -24507,15 +24537,15 @@ "launch_stage": "PUBLIC_BETA" }, "num_correct": { - "description": "Number of questions answered correctly.", + "description": "Number of questions whose result is assessed GOOD, including results assessed manually.", "launch_stage": "PUBLIC_BETA" }, "num_done": { - "description": "Number of questions that have been completed.", + "description": "Number of questions that have finished, either scored (DONE) or failed (EVALUATION_FAILED). Cancelled and\ntimed-out questions are not counted.", "launch_stage": "PUBLIC_BETA" }, "num_needs_review": { - "description": "Number of questions that need manual review.", + "description": "Number of finished questions whose result is assessed NEEDS_REVIEW and has not been reviewed manually yet.", "launch_stage": "PUBLIC_BETA" }, "num_questions": { @@ -27232,7 +27262,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "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.", + "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. The built-in\ntags are listed at\nhttps://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -27252,14 +27282,14 @@ "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.", + "description": "Auto-tagging configurations that apply to this catalog. Each entry overrides the\nmetastore-level auto-tagging setting for its classification tag; tags without an entry\ninherit the metastore-level setting.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "excluded_schemas": { - "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned, including schemas\ncreated later.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "ref": "dataclassification.CatalogConfigSchemaNames", "launch_stage": "GA", "behaviors": [ @@ -27267,7 +27297,7 @@ ] }, "included_schemas": { - "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned. Schemas created later are not scanned\nuntil you add them to the list.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "ref": "dataclassification.CatalogConfigSchemaNames", "launch_stage": "GA", "behaviors": [ @@ -27308,7 +27338,7 @@ "launch_stage": "GA" }, "update_mask": { - "description": "Field mask specifying which fields to update.", + "description": "Comma-separated list of the fields of catalog_config to update, for example\n`included_schemas` or `auto_tag_configs`.", "launch_stage": "GA" } } @@ -27344,7 +27374,7 @@ "description": "Anomaly Detection Configurations.", "fields": { "excluded_table_full_names": { - "description": "List of fully qualified table names to exclude from anomaly detection.", + "description": "List of fully qualified table names to exclude from anomaly detection. Format: `catalog.schema.table_name`.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -27410,7 +27440,7 @@ "launch_stage": "GA" }, "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.", + "description": "The Java timezone ID in which the cron expression is evaluated. See\n[Java TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html) for the supported IDs.", "launch_stage": "GA" } } @@ -27430,7 +27460,7 @@ "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.", + "description": "The absolute workspace path of the directory where the monitor's assets, such as\nthe dashboard, are stored. The UI and the Python APIs normally prepopulate a default user location.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -27438,21 +27468,21 @@ ] }, "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.", + "description": "The fully qualified name of a baseline table. Format: `catalog.schema.table_name`.\nDrift metrics compare the monitored table against the baseline data, so the two tables must have the same\nschema.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "custom_metrics": { - "description": "Custom metrics.", + "description": "Custom metrics to compute in addition to the built-in ones. See\n[custom metrics](https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "dashboard_id": { - "description": "Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state.", + "description": "The ID of the dashboard that visualizes the computed metrics. It is empty while\nthe monitor is pending, when the dashboard was skipped with `skip_builtin_dashboard`, or when the caller is in\na different workspace from the one where the monitor was created.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -27473,7 +27503,7 @@ ] }, "inference_log": { - "description": "`Analysis Configuration` for monitoring inference log tables.", + "description": "Profiles an inference log table, which stores the requests and predictions of a model. Metrics are\ncomputed per time window and include model quality metrics.", "ref": "dataquality.InferenceLogConfig", "launch_stage": "GA", "behaviors": [ @@ -27495,14 +27525,14 @@ ] }, "monitored_table_name": { - "description": "Unity Catalog table to monitor. Format: `catalog.schema.table_name`", + "description": "The fully qualified name of the monitored table. Format: `catalog.schema.table_name`.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "notification_settings": { - "description": "Field for specifying notification settings.", + "description": "Who to notify about this monitor's refreshes. Only `on_failure` with\n`email_addresses` is supported here.", "ref": "dataquality.NotificationSettings", "launch_stage": "GA", "behaviors": [ @@ -27510,7 +27540,7 @@ ] }, "output_schema_id": { - "description": "ID of the schema where output tables are created.", + "description": "The UUID of the Unity Catalog schema where the profile and drift metrics tables\nare created.", "launch_stage": "GA" }, "profile_metrics_table_name": { @@ -27521,7 +27551,7 @@ ] }, "schedule": { - "description": "The cron schedule.", + "description": "The schedule on which the monitor refreshes its metrics. Refreshes can also be\ntriggered on demand through the Refresh resource.", "ref": "dataquality.CronSchedule", "launch_stage": "GA", "behaviors": [ @@ -27537,14 +27567,14 @@ ] }, "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.", + "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`col_1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "snapshot": { - "description": "`Analysis Configuration` for monitoring snapshot tables.", + "description": "Profiles the full contents of the table. Metrics are computed over all rows at each refresh.", "ref": "dataquality.SnapshotConfig", "launch_stage": "GA", "behaviors": [ @@ -27552,7 +27582,7 @@ ] }, "status": { - "description": "The data profiling monitor status.", + "description": "The status of the monitor. `DATA_PROFILING_STATUS_PENDING` means the monitor's\nassets are being created or updated. `DATA_PROFILING_STATUS_ACTIVE` means the monitor is ready and can be\nrefreshed. `DATA_PROFILING_STATUS_FAILED` and `DATA_PROFILING_STATUS_ERROR` mean the monitor is not\noperational, and `latest_monitor_failure_message` describes the cause when one was recorded.\n`DATA_PROFILING_STATUS_DELETE_PENDING` means the monitor is being deleted.", "ref": "dataquality.DataProfilingStatus", "launch_stage": "GA", "behaviors": [ @@ -27560,7 +27590,7 @@ ] }, "time_series": { - "description": "`Analysis Configuration` for monitoring time series tables.", + "description": "Profiles a time series table. Metrics are computed per time window, as defined by `timestamp_column`\nand `granularities`.", "ref": "dataquality.TimeSeriesConfig", "launch_stage": "GA", "behaviors": [ @@ -27568,7 +27598,7 @@ ] }, "warehouse_id": { - "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", + "description": "The ID of the SQL warehouse used to create the dashboard. If not specified, the first running warehouse the\ncaller can access is used.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -27585,7 +27615,7 @@ "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.", + "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" }, "name": { @@ -27593,11 +27623,11 @@ "launch_stage": "GA" }, "output_data_type": { - "description": "The output type of the custom metric.", + "description": "Specifies the Spark SQL data type of the metric value, either as a plain type name or as a JSON-encoded\nStructField.", "launch_stage": "GA" }, "type": { - "description": "The type of the custom metric.", + "description": "The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` metrics depend only on the\ncolumns of the input table, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics depend only on previously\ncomputed aggregate metrics, and `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` metrics depend on previously computed\naggregate or derived metrics.", "ref": "dataquality.DataProfilingCustomMetricType", "launch_stage": "GA" } @@ -27645,27 +27675,27 @@ "launch_stage": "GA" }, "label_column": { - "description": "Column for the label.", + "description": "Column containing the ground truth for the model's predictions.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "model_id_column": { - "description": "Column for the model identifier.", + "description": "Column containing the ID of the model that produced each prediction. A slice is created automatically for\neach distinct model ID.", "launch_stage": "GA" }, "prediction_column": { - "description": "Column for the prediction.", + "description": "Column containing the model's predicted values.", "launch_stage": "GA" }, "problem_type": { - "description": "Problem type the model aims to solve.", + "description": "The type of problem the model solves. It determines which model quality metrics are computed.", "ref": "dataquality.InferenceProblemType", "launch_stage": "GA" }, "timestamp_column": { - "description": "Column for the timestamp.", + "description": "Column containing the timestamp of each inference request. Its type must be TIMESTAMP or convertible to a\ntimestamp.", "launch_stage": "GA" } } @@ -27684,12 +27714,14 @@ "dataquality.ListMonitorRequest": { "fields": { "page_size": { + "description": "The maximum number of monitors to return in one page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { + "description": "Pagination token from a previous response, used to fetch the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -27701,9 +27733,11 @@ "description": "Response for listing Monitors.", "fields": { "monitors": { + "description": "The monitors on this page.", "launch_stage": "GA" }, "next_page_token": { + "description": "Pagination token to pass as `page_token` to fetch the next page.", "launch_stage": "GA" } } @@ -27736,10 +27770,10 @@ } }, "dataquality.Monitor": { - "description": "Monitor for the data quality of unity catalog entities such as schema or table.", + "description": "A data quality monitor on a Unity Catalog object. A `schema` monitor runs anomaly detection on the tables in the\nschema and is configured through `anomaly_detection_config`. A `table` monitor profiles a single table and is\nconfigured through `data_profiling_config`.", "fields": { "anomaly_detection_config": { - "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "description": "Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds\nthe settings of the parent schema's monitor if the schema has one.", "ref": "dataquality.AnomalyDetectionConfig", "launch_stage": "GA", "behaviors": [ @@ -27747,7 +27781,7 @@ ] }, "data_profiling_config": { - "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "description": "Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series`\nor `snapshot` must be set.", "ref": "dataquality.DataProfilingConfig", "launch_stage": "GA", "behaviors": [ @@ -27782,7 +27816,7 @@ ] }, "email_addresses": { - "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.", + "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.\nOnly supported on table monitors, via `data_profiling_config`; rejected on schema monitors.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -27794,7 +27828,7 @@ "description": "Settings for sending notifications on the data quality monitoring.", "fields": { "on_failure": { - "description": "Destinations to send notifications on failure/timeout.", + "description": "Recipients to notify when a refresh of the monitor fails or times out. Only supported on table\nmonitors, via `data_profiling_config`, and only `email_addresses` is accepted there.", "ref": "dataquality.NotificationDestination", "launch_stage": "GA", "behaviors": [ @@ -27913,7 +27947,7 @@ "launch_stage": "GA" }, "timestamp_column": { - "description": "Column for the timestamp.", + "description": "Column containing the timestamp of each row. Its type must be TIMESTAMP or convertible to a timestamp.", "launch_stage": "GA" } } @@ -27921,7 +27955,7 @@ "dataquality.UpdateMonitorRequest": { "fields": { "monitor": { - "description": "The monitor to update.", + "description": "The new values for the monitor. Only the fields named in `update_mask` are applied.", "ref": "dataquality.Monitor", "launch_stage": "GA" }, @@ -28768,17 +28802,17 @@ } }, "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.", + "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.\n\nWhen cpu_workspace_base_environment or gpu_workspace_base_environment is unset, new serverless\nnotebooks for that compute type use the Databricks Standard base environment: the latest\nstable standard environment version provided by Databricks, with no workspace base environment\napplied. The workspace settings page shows this as Standard Latest.", "fields": { "cpu_workspace_base_environment": { - "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "The default workspace base environment for CPU compute.\nIf unset, CPU compute defaults to the Databricks Standard base environment (Standard Latest).\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}", + "description": "The default workspace base environment for GPU compute.\nIf unset, GPU compute defaults to the Databricks Standard base environment (Standard Latest).\nFormat: workspace-base-environments/{workspace_base_environment}", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -29053,7 +29087,7 @@ "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.", + "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.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "launch_stage": "GA" } } @@ -29641,14 +29675,14 @@ ] }, "tables": { - "description": "Unity Catalog tables, views, and metric views, in the order they were added.", + "description": "Unity Catalog tables, views, and metric views, sorted by `identifier`.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "volumes": { - "description": "Unity Catalog volumes, in the order they were added.", + "description": "Unity Catalog volumes, sorted by `path`.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" @@ -30221,19 +30255,20 @@ "iam.AccessControlRequest": { "fields": { "group_name": { - "description": "name of the group", + "description": "Display name of the group.", "launch_stage": "GA" }, "permission_level": { + "description": "Permission level to grant to the principal.", "ref": "iam.PermissionLevel", "launch_stage": "GA" }, "service_principal_name": { - "description": "application ID of a service principal", + "description": "Application ID of the service principal.", "launch_stage": "GA" }, "user_name": { - "description": "name of the user", + "description": "Username of the user, which is the user's email address.", "launch_stage": "GA" } } @@ -30241,7 +30276,7 @@ "iam.AccessControlResponse": { "fields": { "all_permissions": { - "description": "All permissions.", + "description": "Permission levels the principal holds on the object, both granted directly and inherited.", "launch_stage": "GA" }, "display_name": { @@ -30249,15 +30284,15 @@ "launch_stage": "GA" }, "group_name": { - "description": "name of the group", + "description": "Display name of the group.", "launch_stage": "GA" }, "service_principal_name": { - "description": "Name of the service principal.", + "description": "Application ID of the service principal.", "launch_stage": "GA" }, "user_name": { - "description": "name of the user", + "description": "Username of the user, which is the user's email address.", "launch_stage": "GA" } } @@ -30764,7 +30799,7 @@ "iam.GetPermissionLevelsResponse": { "fields": { "permission_levels": { - "description": "Specific permission levels", + "description": "Permission levels that can be granted on objects of the requested type.", "launch_stage": "GA" } } @@ -31326,14 +31361,18 @@ } }, "iam.ObjectPermissions": { + "description": "The permissions set on an object, with one entry per principal that holds a permission on it.", "fields": { "access_control_list": { + "description": "Permissions on the object, with one entry per principal. Each entry lists the principal's direct\nand inherited permission levels.", "launch_stage": "GA" }, "object_id": { + "description": "Path that identifies the object in the access control list, built from the object type and the\nobject id.", "launch_stage": "GA" }, "object_type": { + "description": "Type of the object, as recorded in the access control list. It can differ from the\n`request_object_type` path segment, for example a request for `clusters` returns `cluster`.", "launch_stage": "GA" } } @@ -31548,12 +31587,15 @@ "iam.Permission": { "fields": { "inherited": { + "description": "Whether the permission is inherited from a parent object or the root object instead of being\ngranted directly on the object.", "launch_stage": "GA" }, "inherited_from_object": { + "description": "Paths of the objects the permission is inherited from. It is only set when `inherited` is true.", "launch_stage": "GA" }, "permission_level": { + "description": "Permission level the principal holds on the object.", "ref": "iam.PermissionLevel", "launch_stage": "GA" } @@ -31647,9 +31689,11 @@ "iam.PermissionsDescription": { "fields": { "description": { + "description": "Human-readable description of the permission level.", "launch_stage": "GA" }, "permission_level": { + "description": "Permission level that can be granted on the object.", "ref": "iam.PermissionLevel", "launch_stage": "GA" } @@ -31826,6 +31870,7 @@ "iam.SetObjectPermissions": { "fields": { "access_control_list": { + "description": "Permissions to apply to the object, with one entry per principal. Each entry names exactly one\nprincipal through `user_name`, `group_name` or `service_principal_name` and the\n`permission_level` for that principal.", "launch_stage": "GA" } } @@ -31948,6 +31993,7 @@ "iam.UpdateObjectPermissions": { "fields": { "access_control_list": { + "description": "Permissions to apply to the object, with one entry per principal. Each entry names exactly one\nprincipal through `user_name`, `group_name` or `service_principal_name` and the\n`permission_level` for that principal.", "launch_stage": "GA" } } @@ -32292,7 +32338,7 @@ "iamv2.DeleteWorkspaceAssignmentProxyRequest": {}, "iamv2.DeleteWorkspaceAssignmentRequest": {}, "iamv2.DirectGroupMember": { - "description": "A user, service principal, or group that's a direct member of a group.", + "description": "A user, service principal, or group that's a direct member of a group. To address a membership,\nput its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}` in\naccount APIs, or `GET /api/2.0/identity/groups/{group_id}/direct-members/{principal_id}` in\nworkspace APIs.", "fields": { "display_name": { "description": "The member's display name.", @@ -32385,7 +32431,7 @@ } }, "iamv2.ExternalGroup": { - "description": "A group from your identity provider (IdP), identified by its ID in your IdP. This resource is\nread-only. Getting an external group syncs its name and parent groups from your IdP, and adds\nit to your account if it isn't already there. If your account has group visibility filters, the\ngroup must match them.", + "description": "A group from your identity provider (IdP), identified by its ID in your IdP. This resource is\nread-only. Getting an external group syncs its name and parent groups from your IdP, and adds\nit to your account if it isn't already there. If your account has group visibility filters, the\ngroup must match them. To address an external group, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/external-groups/{external_group_id}` in account\nAPIs, or `GET /api/2.0/identity/external-groups/{external_group_id}` in workspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the group.", @@ -32425,7 +32471,7 @@ } }, "iamv2.ExternalServicePrincipal": { - "description": "A service principal from your identity provider (IdP), identified by its ID in your IdP. This\nresource is read-only and requires Microsoft Entra ID as your IdP. Getting an external service\nprincipal syncs its details and group memberships from your IdP, and adds it to your account if\nit isn't already there.", + "description": "A service principal from your identity provider (IdP), identified by its ID in your IdP. This\nresource is read-only and requires Microsoft Entra ID as your IdP. Getting an external service\nprincipal syncs its details and group memberships from your IdP, and adds it to your account if\nit isn't already there. To address an external service principal, put its resource name in the\nURL: `GET /api/2.0/identity/accounts/{account_id}/external-service-principals/{external_service_principal_id}`\nin account APIs, or\n`GET /api/2.0/identity/external-service-principals/{external_service_principal_id}` in workspace\nAPIs.", "fields": { "account_id": { "description": "The ID of the account that contains the service principal.", @@ -32480,7 +32526,7 @@ } }, "iamv2.ExternalUser": { - "description": "A user from your identity provider (IdP), identified by their ID in your IdP. This resource is\nread-only. Getting an external user syncs the user's details and group memberships from your\nIdP, and adds the user to your account if they aren't already there.", + "description": "A user from your identity provider (IdP), identified by their ID in your IdP. This resource is\nread-only. Getting an external user syncs the user's details and group memberships from your\nIdP, and adds the user to your account if they aren't already there. To address an external\nuser, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/external-users/{external_user_id}` in account APIs,\nor `GET /api/2.0/identity/external-users/{external_user_id}` in workspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the user.", @@ -32606,7 +32652,7 @@ "iamv2.GetWorkspaceAssignmentRequest": {}, "iamv2.GetWorkspaceIdentityDetailRequest": {}, "iamv2.Group": { - "description": "A group in your Databricks account.", + "description": "A group in your Databricks account. To address a group, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/groups/{group_id}` in account APIs, or\n`GET /api/2.0/identity/groups/{group_id}` in workspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the group.", @@ -32664,7 +32710,7 @@ } }, "iamv2.IdentityVisibilityFilter": { - "description": "An account-level rule that controls which groups from your identity provider (IdP) can be found\nin directory search and group pickers when automatic identity management is on. Filters apply to\nevery workspace in the account.\n\nIf you have no group filters, all groups are visible. Otherwise, a group is visible if it or any\nof its parent groups matches at least one filter. A group is also visible if it or any of its\nparent groups is already in your account. Local Databricks groups are always visible.\n\nYou can only create group filters. Filters don't affect provisioning or sign-in for users and\nservice principals. You can't change a filter: to change a rule, delete it and create a new one.", + "description": "An account-level rule that controls which groups from your identity provider (IdP) can be found\nin directory search and group pickers when automatic identity management is on. Filters apply to\nevery workspace in the account.\n\nIf you have no group filters, all groups are visible. Otherwise, a group is visible if it or any\nof its parent groups matches at least one filter. A group is also visible if it or any of its\nparent groups is already in your account. Local Databricks groups are always visible.\n\nYou can only create group filters. Filters don't affect provisioning or sign-in for users and\nservice principals. You can't change a filter: to change a rule, delete it and create a new one.\n\nTo address a filter, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "fields": { "exact": { "description": "Matches a group by its ID in your IdP.", @@ -33271,7 +33317,7 @@ } }, "iamv2.ServicePrincipal": { - "description": "A service principal in your Databricks account.", + "description": "A service principal in your Databricks account. To address a service principal, put its resource\nname in the URL: `GET /api/2.0/identity/accounts/{account_id}/service-principals/{service_principal_id}`\nin account APIs, or `GET /api/2.0/identity/service-principals/{service_principal_id}` in\nworkspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the service principal.", @@ -33339,7 +33385,7 @@ } }, "iamv2.TransitiveParentGroup": { - "description": "A group that a principal belongs to, either directly or through another group.", + "description": "A group that a principal belongs to, either directly or through another group. To list a\nprincipal's parent groups, put the principal's resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/principals/{principal_id}/transitive-parent-groups`\nin account APIs, or `GET /api/2.0/identity/principals/{principal_id}/transitive-parent-groups`\nin workspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the group.", @@ -33512,7 +33558,7 @@ } }, "iamv2.User": { - "description": "A user in your Databricks account.", + "description": "A user in your Databricks account. To address a user, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/users/{user_id}` in account APIs, or\n`GET /api/2.0/identity/users/{user_id}` in workspace APIs.", "fields": { "account_id": { "description": "The ID of the account that contains the user.", @@ -33669,7 +33715,7 @@ } }, "iamv2.WorkspaceAssignment": { - "description": "A principal's direct assignment to a workspace, and the entitlements it grants there.\n\nOnly principals assigned directly to the workspace have an assignment. A principal that gets\naccess only through a group doesn't. Creating an assignment gives the principal access to the\nworkspace, and deleting it removes that direct access. These APIs replace managing workspace\nassignments through SCIM and the permission assignment APIs. They require a workspace with\nidentity federation enabled. You can't assign, change, or unassign principals that Databricks\nmanages.\n\n`entitlements` is the only field you set. `effective_entitlements` also includes the\nentitlements the principal gets through its groups. An assignment must grant at least one\nentitlement. To remove a principal's direct access, delete the assignment.", + "description": "A principal's direct assignment to a workspace, and the entitlements it grants there.\n\nOnly principals assigned directly to the workspace have an assignment. A principal that gets\naccess only through a group doesn't. Creating an assignment gives the principal access to the\nworkspace, and deleting it removes that direct access. These APIs replace managing workspace\nassignments through SCIM and the permission assignment APIs. They require a workspace with\nidentity federation enabled. You can't assign, change, or unassign principals that Databricks\nmanages.\n\n`entitlements` is the only field you set. `effective_entitlements` also includes the\nentitlements the principal gets through its groups. An assignment must grant at least one\nentitlement. To remove a principal's direct access, delete the assignment.\n\nTo address an assignment, put its resource name in the URL:\n`GET /api/2.0/identity/accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\nin account APIs, or `GET /api/2.0/identity/workspace-assignments/{principal_id}` in workspace\nAPIs.", "fields": { "account_id": { "description": "The ID of the account that contains the workspace.", @@ -33781,7 +33827,7 @@ } }, "iamv2.WorkspaceIdentityDetail": { - "description": "A user, service principal, or group's status in a workspace, and whether it has access to the\nworkspace directly or through a group. Update it to activate or deactivate a user or service\nprincipal in the workspace.", + "description": "A user, service principal, or group's status in a workspace, and whether it has access to the\nworkspace directly or through a group. Update it to activate or deactivate a user or service\nprincipal in the workspace. To address it, put its resource name in the URL:\n`GET /api/2.0/identity/principals/{principal_id}/workspace-identity-detail`.", "fields": { "assignment_type": { "description": "Whether the principal is assigned to the workspace directly or has access through a group.", @@ -34157,11 +34203,11 @@ "jobs.AiRuntimeTaskPriorityClass": { "description": "Scheduling priority class for a workload — its priority and preemptability\nwhen the scheduler ranks pending work.", "enum": [ - "BEST_EFFORT", - "NORMAL" + "NORMAL", + "HIGH" ], "enum_launch_stages": { - "BEST_EFFORT": "PRIVATE_PREVIEW", + "HIGH": "PRIVATE_PREVIEW", "NORMAL": "PRIVATE_PREVIEW" } }, @@ -34897,8 +34943,8 @@ "launch_stage": "GA" }, "parent_path": { - "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "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* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `COST_OPTIMIZED`: Enables lower job costs by optimizing compute for your selected target duration time. Must provide a duration target.", @@ -36266,8 +36312,8 @@ "launch_stage": "GA" }, "parent_path": { - "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "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* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `COST_OPTIMIZED`: Enables lower job costs by optimizing compute for your selected target duration time. Must provide a duration target.", @@ -41024,7 +41070,7 @@ ] }, "schedule": { - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "ref": "lakewatch.Schedule", "launch_stage": "PUBLIC_BETA" }, @@ -42493,7 +42539,7 @@ } }, "lakewatch.Schedule": { - "description": "Defines when a recurring job executes.\n\nExactly one of the timing modes (`at_least_every`, `cron_expression`,\n`continuous`) must be set; combining them or setting none is rejected by the\nserver. `compute_group` and `enabled` are orthogonal to the timing.", + "description": "Defines when a recurring job executes.\n\nExactly one of the timing modes (`at_least_every`, `cron_expression`,\n`continuous`, `file_arrival`) must be set; combining them or setting none is\nrejected by the server. `compute_group` and `enabled` are orthogonal to the\ntiming.", "fields": { "at_least_every": { "description": "Duration string defining the minimum cadence. May contain components\nfor days, hours, minutes, seconds (e.g. `5d`, `5d3h`, `3d2h5m12s`,\n`12m16s`).", @@ -42903,15 +42949,19 @@ "description": "contact info for the consumer requesting data or performing a listing installation", "fields": { "company": { + "description": "Company of the consumer contact.", "launch_stage": "GA" }, "email": { + "description": "Email address of the consumer contact.", "launch_stage": "GA" }, "first_name": { + "description": "First name of the consumer contact.", "launch_stage": "GA" }, "last_name": { + "description": "Last name of the consumer contact.", "launch_stage": "GA" } } @@ -42959,17 +43009,21 @@ "marketplace.CreateFileRequest": { "fields": { "display_name": { + "description": "Name shown to consumers for the file, for example a notebook title. At most 255 characters.", "launch_stage": "GA" }, "file_parent": { + "description": "Provider profile or listing to attach the file to.", "ref": "marketplace.FileParent", "launch_stage": "GA" }, "marketplace_file_type": { + "description": "Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a\nLISTING parent.", "ref": "marketplace.MarketplaceFileType", "launch_stage": "GA" }, "mime_type": { + "description": "MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml\nfor icons.", "launch_stage": "GA" } } @@ -42977,11 +43031,12 @@ "marketplace.CreateFileResponse": { "fields": { "file_info": { + "description": "Metadata of the created file.", "ref": "marketplace.FileInfo", "launch_stage": "GA" }, "upload_url": { - "description": "Pre-signed POST URL to blob storage", + "description": "Short-lived URL for uploading the file content with an HTTP PUT request.", "launch_stage": "GA" } } @@ -43012,6 +43067,7 @@ "marketplace.CreateListingRequest": { "fields": { "listing": { + "description": "Listing to create.", "ref": "marketplace.Listing", "launch_stage": "GA" } @@ -43020,6 +43076,7 @@ "marketplace.CreateListingResponse": { "fields": { "listing_id": { + "description": "ID of the created listing.", "launch_stage": "GA" } } @@ -43066,6 +43123,7 @@ "marketplace.CreateProviderRequest": { "fields": { "provider": { + "description": "Provider profile to create.", "ref": "marketplace.ProviderInfo", "launch_stage": "GA" } @@ -43074,6 +43132,7 @@ "marketplace.CreateProviderResponse": { "fields": { "id": { + "description": "ID of the created provider profile.", "launch_stage": "GA" } } @@ -43105,9 +43164,11 @@ "marketplace.DataRefreshInfo": { "fields": { "interval": { + "description": "Number of time units. Must be greater than zero.", "launch_stage": "GA" }, "unit": { + "description": "Time unit that the interval is expressed in.", "ref": "marketplace.DataRefresh", "launch_stage": "GA" } @@ -43234,6 +43295,7 @@ "marketplace.FileInfo": { "fields": { "created_at": { + "description": "Time the file was created, in epoch milliseconds.", "launch_stage": "GA" }, "display_name": { @@ -43241,23 +43303,29 @@ "launch_stage": "GA" }, "download_link": { + "description": "Short-lived URL for downloading the file content.", "launch_stage": "GA" }, "file_parent": { + "description": "Provider or listing that the file belongs to.", "ref": "marketplace.FileParent", "launch_stage": "GA" }, "id": { + "description": "ID of the file.", "launch_stage": "GA" }, "marketplace_file_type": { + "description": "Purpose of the file, such as a provider icon or a notebook attached to a listing.", "ref": "marketplace.MarketplaceFileType", "launch_stage": "GA" }, "mime_type": { + "description": "MIME type of the file content, for example text/html for notebooks or image/png for icons.", "launch_stage": "GA" }, "status": { + "description": "Processing status of the file. New files start in FILE_STATUS_STAGING and become\nFILE_STATUS_PUBLISHED after Databricks has sanitized them.", "ref": "marketplace.FileStatus", "launch_stage": "GA" }, @@ -43266,6 +43334,7 @@ "launch_stage": "GA" }, "updated_at": { + "description": "Time the file was last updated, in epoch milliseconds.", "launch_stage": "GA" } } @@ -43273,10 +43342,12 @@ "marketplace.FileParent": { "fields": { "file_parent_type": { + "description": "Type of the parent: PROVIDER for provider icons, LISTING for notebooks attached to a listing.", "ref": "marketplace.FileParentType", "launch_stage": "GA" }, "parent_id": { + "description": "ID of the provider or listing that the file belongs to.", "launch_stage": "GA" } } @@ -43330,6 +43401,7 @@ "marketplace.GetFileResponse": { "fields": { "file_info": { + "description": "Metadata of the file.", "ref": "marketplace.FileInfo", "launch_stage": "GA" } @@ -43339,7 +43411,7 @@ "marketplace.GetLatestVersionProviderAnalyticsDashboardResponse": { "fields": { "version": { - "description": "version here is latest logical version of the dashboard template", + "description": "Latest available version of the dashboard template.", "launch_stage": "GA" } } @@ -43368,6 +43440,7 @@ "marketplace.GetListingResponse": { "fields": { "listing": { + "description": "The requested listing.", "ref": "marketplace.Listing", "launch_stage": "GA" } @@ -43376,9 +43449,11 @@ "marketplace.GetListingsRequest": { "fields": { "page_size": { + "description": "Maximum number of results to return per page.", "launch_stage": "GA" }, "page_token": { + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "launch_stage": "GA" } } @@ -43386,9 +43461,11 @@ "marketplace.GetListingsResponse": { "fields": { "listings": { + "description": "Listings on this page.", "launch_stage": "GA" }, "next_page_token": { + "description": "Token for the next page. Not set when there are no more results.", "launch_stage": "GA" } } @@ -43405,6 +43482,7 @@ "marketplace.GetProviderResponse": { "fields": { "provider": { + "description": "The requested provider profile.", "ref": "marketplace.ProviderInfo", "launch_stage": "GA" } @@ -43507,9 +43585,11 @@ "marketplace.ListAllPersonalizationRequestsResponse": { "fields": { "next_page_token": { + "description": "Token for the next page. Not set when there are no more results.", "launch_stage": "GA" }, "personalization_requests": { + "description": "Personalization requests on this page.", "launch_stage": "GA" } } @@ -43596,13 +43676,16 @@ "marketplace.ListFilesRequest": { "fields": { "file_parent": { + "description": "Provider profile or listing whose files to list.", "ref": "marketplace.FileParent", "launch_stage": "GA" }, "page_size": { + "description": "Maximum number of results to return per page.", "launch_stage": "GA" }, "page_token": { + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "launch_stage": "GA" } } @@ -43610,9 +43693,11 @@ "marketplace.ListFilesResponse": { "fields": { "file_infos": { + "description": "Files on this page.", "launch_stage": "GA" }, "next_page_token": { + "description": "Token for the next page. Not set when there are no more results.", "launch_stage": "GA" } } @@ -43733,13 +43818,15 @@ "marketplace.ListProviderAnalyticsDashboardResponse": { "fields": { "dashboard_id": { - "description": "dashboard_id will be used to open Lakeview dashboard.", + "description": "ID of the AI/BI dashboard in the workspace. Use it to open the dashboard.", "launch_stage": "GA" }, "id": { + "description": "Marketplace-specific ID of the dashboard record. Use it as the `id` when updating the dashboard.", "launch_stage": "GA" }, "version": { + "description": "Version of the dashboard template that the dashboard was created or last updated from.", "launch_stage": "GA" } } @@ -43747,9 +43834,11 @@ "marketplace.ListProvidersRequest": { "fields": { "page_size": { + "description": "Maximum number of results to return per page.", "launch_stage": "GA" }, "page_token": { + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "launch_stage": "GA" } } @@ -43757,23 +43846,29 @@ "marketplace.ListProvidersResponse": { "fields": { "next_page_token": { + "description": "Token for the next page. Not set when there are no more results.", "launch_stage": "GA" }, "providers": { + "description": "Provider profiles on this page.", "launch_stage": "GA" } } }, "marketplace.Listing": { + "description": "A Marketplace listing: a data product that a provider offers to consumers. The summary holds\nthe listing's identity, status and sharing configuration, and the detail holds the descriptive\ncontent that consumers see on the listing page.", "fields": { "detail": { + "description": "Descriptive content shown to consumers on the listing page, such as the description, links and\ndata attributes.", "ref": "marketplace.ListingDetail", "launch_stage": "GA" }, "id": { + "description": "ID of the listing. Assigned by the server; not allowed in create requests.", "launch_stage": "GA" }, "summary": { + "description": "Identity, status and sharing configuration of the listing.", "ref": "marketplace.ListingSummary", "launch_stage": "GA" } @@ -43782,7 +43877,7 @@ "marketplace.ListingDetail": { "fields": { "assets": { - "description": "Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK", + "description": "Types of assets included in the listing. At least one is required unless the listing is a\nDRAFT. Duplicate values are ignored.", "launch_stage": "GA" }, "collection_date_end": { @@ -43808,12 +43903,15 @@ "launch_stage": "GA" }, "description": { + "description": "Detailed description of the data product. Supports basic Markdown formatting such as bold,\nitalics and lists.", "launch_stage": "GA" }, "documentation_link": { + "description": "URL of documentation that helps consumers use the data product.", "launch_stage": "GA" }, "embedded_notebook_file_infos": { + "description": "Sample notebooks attached to the listing. Create each notebook with createFile, using the\nEMBEDDED_NOTEBOOK file type and the listing as the parent, and reference it here.", "launch_stage": "GA" }, "file_ids": { @@ -43824,7 +43922,7 @@ "launch_stage": "GA" }, "license": { - "description": "ID 20, 21 removed don't use\nLicense of the data asset - Required for listings with model based assets", + "description": "License of the data asset. Required for listings with model-based assets.", "launch_stage": "GA" }, "pricing_model": { @@ -43832,6 +43930,7 @@ "launch_stage": "GA" }, "privacy_policy_link": { + "description": "URL of the privacy policy for the listing. Defaults to the provider profile's privacy policy\nlink when empty.", "launch_stage": "GA" }, "size": { @@ -43839,13 +43938,15 @@ "launch_stage": "GA" }, "support_link": { + "description": "URL where consumers can get support for the listing.", "launch_stage": "GA" }, "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.", + "description": "Tags that annotate the listing with fixed, low-cardinality values, such as supported languages\nor tasks.", "launch_stage": "GA" }, "terms_of_service": { + "description": "URL of the terms of service for the listing. Defaults to the provider profile's terms of\nservice link when empty.", "launch_stage": "GA" }, "update_frequency": { @@ -43881,6 +43982,7 @@ "marketplace.ListingSetting": { "fields": { "visibility": { + "description": "PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE listings are visible\nonly to members of the private exchanges that they are shared in.", "ref": "marketplace.Visibility", "launch_stage": "GA" } @@ -43914,36 +44016,45 @@ "marketplace.ListingSummary": { "fields": { "categories": { + "description": "Categories that consumers can use to filter listings. They also appear as tags on the listing\ntile and detail page.", "launch_stage": "GA" }, "created_at": { + "description": "Time the listing was created, in epoch milliseconds.", "launch_stage": "GA" }, "created_by": { + "description": "Name of the user who created the listing.", "launch_stage": "GA" }, "created_by_id": { + "description": "ID of the user who created the listing.", "launch_stage": "GA" }, "exchange_ids": { + "description": "IDs of the private exchanges that the listing is shared in. A listing can be linked to at most\n10 exchanges.", "launch_stage": "GA" }, "git_repo": { - "description": "if a git repo is being created, a listing will be initialized with this field as opposed to a share", + "description": "Git repository that holds the listing's assets, used instead of a share for notebook and Git\nrepo listings. A listing cannot have both a share and a Git repo.", "ref": "marketplace.RepoInfo", "launch_stage": "GA" }, "listingType": { + "description": "How consumers get access to the listing. STANDARD listings are instantly available; PERSONALIZED\nlistings require the provider to approve each consumer request. Cannot be changed after the\nlisting is created.", "ref": "marketplace.ListingType", "launch_stage": "GA" }, "name": { + "description": "Display name of the listing. Must start with a letter or digit and be at most 100 characters.", "launch_stage": "GA" }, "provider_id": { + "description": "ID of the provider profile that owns the listing.", "launch_stage": "GA" }, "provider_region": { + "description": "Cloud and region of the provider's Unity Catalog metastore. Not allowed in create requests.", "ref": "marketplace.RegionInfo", "launch_stage": "GA" }, @@ -43954,27 +44065,34 @@ "launch_stage": "GA" }, "setting": { + "description": "Listing settings, such as whether the listing is visible in the public Marketplace or only in\nprivate exchanges.", "ref": "marketplace.ListingSetting", "launch_stage": "GA" }, "share": { + "description": "Delta Sharing share that holds the listing's data assets. Required to publish a STANDARD\nlisting, except for app and MCP server listings; notebook and Git repo listings can use\ngit_repo instead. The caller must have access to the share.", "ref": "marketplace.ShareInfo", "launch_stage": "GA" }, "status": { + "description": "Publication status of the listing. Only PUBLISHED listings are visible to consumers; create a\nlisting as DRAFT and set the status to PUBLISHED when it is ready.", "ref": "marketplace.ListingStatus", "launch_stage": "GA" }, "subtitle": { + "description": "One-line subtitle shown with the listing name.", "launch_stage": "GA" }, "updated_at": { + "description": "Time the listing was last updated, in epoch milliseconds.", "launch_stage": "GA" }, "updated_by": { + "description": "Name of the user who last updated the listing.", "launch_stage": "GA" }, "updated_by_id": { + "description": "ID of the user who last updated the listing.", "launch_stage": "GA" } } @@ -44027,41 +44145,52 @@ "marketplace.PersonalizationRequest": { "fields": { "comment": { + "description": "Comment that the consumer entered with the request.", "launch_stage": "GA" }, "consumer_region": { + "description": "Cloud and region of the consumer's Unity Catalog metastore.", "ref": "marketplace.RegionInfo", "launch_stage": "GA" }, "contact_info": { + "description": "Contact details that the consumer entered with the request.", "ref": "marketplace.ContactInfo", "launch_stage": "GA" }, "created_at": { + "description": "Time the request was created, in epoch milliseconds.", "launch_stage": "GA" }, "id": { + "description": "ID of the personalization request.", "launch_stage": "GA" }, "intended_use": { + "description": "How the consumer intends to use the data product, as entered with the request.", "launch_stage": "GA" }, "is_from_lighthouse": { "launch_stage": "GA" }, "listing_id": { + "description": "ID of the listing that the request was made for.", "launch_stage": "GA" }, "listing_name": { + "description": "Name of the listing that the request was made for.", "launch_stage": "GA" }, "metastore_id": { + "description": "ID of the consumer's Unity Catalog metastore.", "launch_stage": "GA" }, "provider_id": { + "description": "ID of the provider profile that owns the listing.", "launch_stage": "GA" }, "recipient_type": { + "description": "How the consumer receives the shared data: DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS for a consumer\non a Databricks workspace, DELTA_SHARING_RECIPIENT_TYPE_OPEN for a consumer on another platform\nwho uses a credential file.", "ref": "marketplace.DeltaSharingRecipientType", "launch_stage": "GA" }, @@ -44071,13 +44200,16 @@ "launch_stage": "GA" }, "status": { + "description": "Current status of the request.", "ref": "marketplace.PersonalizationRequestStatus", "launch_stage": "GA" }, "status_message": { + "description": "Reason that the provider gave in the most recent status update.", "launch_stage": "GA" }, "updated_at": { + "description": "Time the request was last updated, in epoch milliseconds.", "launch_stage": "GA" } } @@ -44099,6 +44231,7 @@ "marketplace.ProviderAnalyticsDashboard": { "fields": { "id": { + "description": "Marketplace-specific ID of the dashboard record, distinct from the AI/BI dashboard ID.", "launch_stage": "GA" } } @@ -44106,37 +44239,47 @@ "marketplace.ProviderInfo": { "fields": { "business_contact_email": { + "description": "Email address that Databricks uses to contact the provider. Not shown to consumers.", "launch_stage": "GA" }, "company_website_link": { + "description": "URL of the provider's website. Shown on all of the provider's listings.", "launch_stage": "GA" }, "dark_mode_icon_file_id": { + "description": "ID of the provider icon file used in dark mode, created with createFile using the PROVIDER_ICON\nfile type.", "launch_stage": "GA" }, "dark_mode_icon_file_path": { + "description": "URL for downloading the dark mode provider icon. Populated by the server from\ndark_mode_icon_file_id.", "launch_stage": "GA" }, "description": { + "description": "Description of the provider organization, shown on the provider profile and on all of its\nlistings.", "launch_stage": "GA" }, "icon_file_id": { + "description": "ID of the provider icon file, created with createFile using the PROVIDER_ICON file type.", "launch_stage": "GA" }, "icon_file_path": { + "description": "URL for downloading the provider icon. Populated by the server from icon_file_id.", "launch_stage": "GA" }, "id": { + "description": "ID of the provider profile. Assigned by the server; not allowed in create or update requests.", "launch_stage": "GA" }, "is_featured": { - "description": "is_featured is accessible by consumers only", + "description": "Whether Databricks features the provider in the Marketplace. Set by Databricks; not allowed in\ncreate or update requests.", "launch_stage": "GA" }, "name": { + "description": "Display name of the provider. Consumers can filter listings by provider name.", "launch_stage": "GA" }, "privacy_policy_link": { + "description": "URL of the provider's privacy policy. Shown on all of the provider's listings unless a listing\nsets its own privacy policy.", "launch_stage": "GA" }, "published_by": { @@ -44144,9 +44287,11 @@ "launch_stage": "GA" }, "support_contact_email": { + "description": "Email address that consumers can use to request support. Shown on all of the provider's\nlistings.", "launch_stage": "GA" }, "term_of_service_link": { + "description": "URL of the provider's terms of service. Shown on all of the provider's listings unless a listing\nsets its own terms of service.", "launch_stage": "GA" } } @@ -44154,9 +44299,11 @@ "marketplace.RegionInfo": { "fields": { "cloud": { + "description": "Cloud provider: aws, azure or gcp.", "launch_stage": "GA" }, "region": { + "description": "Cloud region, for example us-west-2.", "launch_stage": "GA" } } @@ -44228,6 +44375,7 @@ "marketplace.ShareInfo": { "fields": { "name": { + "description": "Name of the Delta Sharing share in the provider's Unity Catalog metastore.", "launch_stage": "GA" }, "type": { @@ -44351,6 +44499,7 @@ "marketplace.UpdateListingRequest": { "fields": { "listing": { + "description": "Full definition of the listing, including the fields that are not changing.", "ref": "marketplace.Listing", "launch_stage": "GA" } @@ -44359,6 +44508,7 @@ "marketplace.UpdateListingResponse": { "fields": { "listing": { + "description": "The updated listing.", "ref": "marketplace.Listing", "launch_stage": "GA" } @@ -44367,13 +44517,16 @@ "marketplace.UpdatePersonalizationRequestRequest": { "fields": { "reason": { + "description": "Message for the consumer that explains the status change, at most 255 characters.", "launch_stage": "GA" }, "share": { + "description": "Share to grant the consumer access to. Required when fulfilling a request for a listing with data\nassets and not allowed with other statuses. Ignored for app and MCP server listings.", "ref": "marketplace.ShareInfo", "launch_stage": "GA" }, "status": { + "description": "New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING,\nFULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.", "ref": "marketplace.PersonalizationRequestStatus", "launch_stage": "GA" } @@ -44382,6 +44535,7 @@ "marketplace.UpdatePersonalizationRequestResponse": { "fields": { "request": { + "description": "The updated personalization request.", "ref": "marketplace.PersonalizationRequest", "launch_stage": "GA" } @@ -44390,7 +44544,7 @@ "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", + "description": "Version of the dashboard template to update to. Must be newer than the version that the\ndashboard currently uses; use the version returned by getLatestVersionProviderAnalyticsDashboard.", "launch_stage": "GA" } } @@ -44398,14 +44552,15 @@ "marketplace.UpdateProviderAnalyticsDashboardResponse": { "fields": { "dashboard_id": { - "description": "this is newly created Lakeview dashboard for the user", + "description": "ID of the AI/BI dashboard that now contains the updated template.", "launch_stage": "GA" }, "id": { - "description": "id \u0026 version should be the same as the request", + "description": "Marketplace-specific ID of the dashboard record, the same as in the request.", "launch_stage": "GA" }, "version": { + "description": "Version of the dashboard template that the dashboard now uses.", "launch_stage": "GA" } } @@ -44413,6 +44568,7 @@ "marketplace.UpdateProviderRequest": { "fields": { "provider": { + "description": "Full definition of the provider profile, including the fields that are not changing.", "ref": "marketplace.ProviderInfo", "launch_stage": "GA" } @@ -44421,6 +44577,7 @@ "marketplace.UpdateProviderResponse": { "fields": { "provider": { + "description": "The updated provider profile.", "ref": "marketplace.ProviderInfo", "launch_stage": "GA" } @@ -52368,11 +52525,11 @@ "oauth2.CreatePublishedAppIntegration": { "fields": { "app_id": { - "description": "App id of the OAuth published app integration.\nFor example power-bi, tableau-deskop", + "description": "ID of the published OAuth app to enable, as returned in app_id by the list of published OAuth apps.\nThe short legacy IDs of the original published apps, such as power-bi and tableau-desktop, are also\naccepted. The request fails if the app is already enabled for the account.", "launch_stage": "GA" }, "token_access_policy": { - "description": "Token access policy", + "description": "Lifetimes of the tokens issued to the app. If omitted, the app's default token lifetimes apply.\nIf set, both TTL fields are required.", "ref": "oauth2.TokenAccessPolicy", "launch_stage": "GA" } @@ -52381,7 +52538,7 @@ "oauth2.CreatePublishedAppIntegrationOutput": { "fields": { "integration_id": { - "description": "Unique integration id for the published OAuth app", + "description": "ID of the published OAuth app integration.", "launch_stage": "GA" } } @@ -52588,27 +52745,30 @@ } }, "oauth2.GetPublishedAppIntegrationOutput": { + "description": "A published OAuth app integration enables an OAuth app published by Databricks, such as Power BI\nor Tableau Desktop, for the account. Databricks manages the app's client ID, redirect URLs and\nscopes; the integration only sets the lifetimes of the tokens issued to the app. To register your\nown application, use a custom OAuth app integration instead. See\nhttps://docs.databricks.com/aws/en/integrations/enable-disable-oauth.", "fields": { "app_id": { - "description": "App-id of the published app integration", + "description": "ID of the published OAuth app, as returned in app_id by the list of published OAuth apps.", "launch_stage": "GA" }, "create_time": { + "description": "Time the integration was created, as an ISO 8601 timestamp.", "launch_stage": "GA" }, "created_by": { + "description": "ID of the user who created the integration.", "launch_stage": "GA" }, "integration_id": { - "description": "Unique integration id for the published OAuth app", + "description": "ID of the published OAuth app integration in the account.", "launch_stage": "GA" }, "name": { - "description": "Display name of the published OAuth app", + "description": "Display name of the published OAuth app.", "launch_stage": "GA" }, "token_access_policy": { - "description": "Token access policy", + "description": "Lifetimes of the access and refresh tokens issued to the app.", "ref": "oauth2.TokenAccessPolicy", "launch_stage": "GA" } @@ -52622,6 +52782,7 @@ "launch_stage": "GA" }, "next_page_token": { + "description": "Token for the next page of results. If not present, there are no more results to show.", "launch_stage": "GA" } } @@ -52696,9 +52857,11 @@ "oauth2.ListPublishedAppIntegrationsRequest": { "fields": { "page_size": { + "description": "Maximum number of integrations to return in one page, at most 1000.", "launch_stage": "GA" }, "page_token": { + "description": "Token from the next_page_token field of a previous response. Omit it to request the first page.", "launch_stage": "GA" } } @@ -52796,7 +52959,7 @@ "launch_stage": "GA" }, "client_id": { - "description": "Client ID of the published OAuth app. It is the client_id in the OAuth flow", + "description": "Client ID of the published OAuth app. The app sends it as client_id in the OAuth flow.", "launch_stage": "GA" }, "description": { @@ -52913,7 +53076,7 @@ "oauth2.UpdatePublishedAppIntegration": { "fields": { "token_access_policy": { - "description": "Token access policy to be updated in the published OAuth app integration", + "description": "New token lifetimes for the app. Both TTL fields are required when the policy is set; the\nsingle-use refresh token settings keep their current values when omitted. If the policy is\nomitted, the integration is left unchanged.", "ref": "oauth2.TokenAccessPolicy", "launch_stage": "GA" } @@ -53095,8 +53258,8 @@ "launch_stage": "GA" }, "parent_path": { - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "photon": { "description": "Whether Photon is enabled for this pipeline.", @@ -53274,7 +53437,7 @@ "pipelines.CreatePipeline": { "fields": { "allow_duplicate_names": { - "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "description": "If false, deployment will fail if name conflicts with that of another pipeline.\n\nIgnored when `parent_path` is set. A pipeline in a workspace folder must have a name that is\nunique within that folder, and creation fails if the folder already contains an object with the\nsame name.", "launch_stage": "GA" }, "budget_policy_id": { @@ -53366,8 +53529,8 @@ "launch_stage": "PUBLIC_BETA" }, "parent_path": { - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "photon": { "description": "Whether Photon is enabled for this pipeline.", @@ -53527,7 +53690,7 @@ "pipelines.EditPipeline": { "fields": { "allow_duplicate_names": { - "description": "If false, deployment will fail if name has changed and conflicts the name of another pipeline.", + "description": "If false, deployment will fail if name has changed and conflicts with the name of another\npipeline.\n\nIgnored when the pipeline is in a workspace folder or the request sets `parent_path`.\nRenaming or moving such a pipeline fails if the target folder already contains an object with\nthe same name.", "launch_stage": "GA" }, "budget_policy_id": { @@ -53619,8 +53782,8 @@ "launch_stage": "PUBLIC_BETA" }, "parent_path": { - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "photon": { "description": "Whether Photon is enabled for this pipeline.", @@ -55253,8 +55416,8 @@ "launch_stage": "GA" }, "parent_path": { - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", + "launch_stage": "PUBLIC_BETA" }, "photon": { "description": "Whether Photon is enabled for this pipeline.", @@ -57213,7 +57376,7 @@ "launch_stage": "GA" }, "role_id": { - "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\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.", + "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\n\nThis value should be 3-63 characters, start with a lowercase letter, end with a lowercase\nletter or digit, and contain only lowercase letters, digits, and hyphens.\n\nIf role_id is not specified in the request, it is generated automatically.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -57680,7 +57843,7 @@ "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.", + "description": "Reassign objects. If this is set, all objects owned by the role are\nreassigned to the role specified in this parameter. The role must already exist.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nNOTE: setting this requires spinning up a compute to succeed, since it involves running\nSQL queries.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -59248,6 +59411,7 @@ "description": "Role represents a Postgres role within a Branch.", "fields": { "create_time": { + "description": "A timestamp indicating when the role was created.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -59288,6 +59452,7 @@ ] }, "update_time": { + "description": "A timestamp indicating when the role was last updated.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -59299,18 +59464,21 @@ "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": { + "description": "Whether the role bypasses every row-level security policy (the Postgres BYPASSRLS attribute).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "createdb": { + "description": "Whether the role can create databases (the Postgres CREATEDB attribute).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "createrole": { + "description": "Whether the role can create, alter and drop other roles (the Postgres CREATEROLE attribute).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -59357,7 +59525,7 @@ "postgres.RoleRoleSpec": { "fields": { "attributes": { - "description": "The desired API-exposed Postgres role attribute to associate with the role. Optional.", + "description": "The Postgres role attributes to grant to the role.", "ref": "postgres.RoleAttributes", "launch_stage": "GA", "behaviors": [ @@ -59374,7 +59542,7 @@ ] }, "identity_type": { - "description": "The type of role.\nWhen specifying a managed-identity, the chosen postgres_role must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis value cannot be changed after creation.", + "description": "The type of Databricks identity that backs the role. Leave unset to create a native Postgres\nrole that is not associated with a Databricks identity.\nWhen specifying a managed-identity, the chosen postgres_role must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis value cannot be changed after creation.", "ref": "postgres.RoleIdentityType", "launch_stage": "GA", "behaviors": [ @@ -59390,7 +59558,7 @@ ] }, "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\n\nThis value cannot be changed after creation.", + "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\n3. group name for IdentityType.GROUP\n\nThis value cannot be changed after creation.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -59402,7 +59570,7 @@ "postgres.RoleRoleStatus": { "fields": { "attributes": { - "description": "The PG role attributes associated with the role.", + "description": "The Postgres role attributes currently granted to the role.", "ref": "postgres.RoleAttributes", "launch_stage": "GA", "behaviors": [ @@ -59410,6 +59578,7 @@ ] }, "auth_method": { + "description": "How the role authenticates when it connects to Postgres.", "ref": "postgres.RoleAuthMethod", "launch_stage": "GA", "behaviors": [ @@ -59417,7 +59586,7 @@ ] }, "identity_type": { - "description": "The type of the role.", + "description": "The type of Databricks identity that backs the role, if any.", "ref": "postgres.RoleIdentityType", "launch_stage": "GA", "behaviors": [ @@ -59425,7 +59594,7 @@ ] }, "membership_roles": { - "description": "An enum value for a standard role that this role is a member of.", + "description": "The standard roles that the role is currently a member of.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -64310,6 +64479,7 @@ "settings.AibiDashboardEmbeddingAccessPolicy": { "fields": { "access_policy_type": { + "description": "Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved\ndomains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS).\nDefaults to ALLOW_APPROVED_DOMAINS.", "ref": "settings.AibiDashboardEmbeddingAccessPolicyAccessPolicyType", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64349,6 +64519,7 @@ "settings.AibiDashboardEmbeddingApprovedDomains": { "fields": { "approved_domains": { + "description": "Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a\ndomain. The list applies, and can only be changed, while the embedding access policy is\nALLOW_APPROVED_DOMAINS.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -64401,18 +64572,21 @@ "settings.ClusterAutoRestartMessage": { "fields": { "can_toggle": { + "description": "Whether the workspace can change the enabled state. Databricks computes this value: it is false\nwhen the compliance security profile forces the feature on or when the workspace lacks the\nEnhanced Security and Compliance entitlement. A value sent in an update request has no effect.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "enabled": { + "description": "Whether automatic cluster update is enabled for the workspace. The effective value is always\ntrue while the compliance security profile is enabled on the workspace.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "enablement_details": { + "description": "Why the feature is forced on or unavailable. Databricks sets these details for information only;\nthey do not determine whether the feature is enabled.", "ref": "settings.ClusterAutoRestartMessageEnablementDetails", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64420,6 +64594,7 @@ ] }, "maintenance_window": { + "description": "When the maintenance window runs. When unset, it defaults to the first Sunday of every month at\n01:00 UTC.", "ref": "settings.ClusterAutoRestartMessageMaintenanceWindow", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64427,6 +64602,7 @@ ] }, "restart_even_if_no_updates_available": { + "description": "Whether compute resources restart during every maintenance window even when no update is\navailable. When false, they restart only when an update is available.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -64445,7 +64621,7 @@ ] }, "unavailable_for_disabled_entitlement": { - "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)", + "description": "The feature is unavailable because the workspace does not have the Enhanced Security and\nCompliance entitlement.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -64463,6 +64639,7 @@ "settings.ClusterAutoRestartMessageMaintenanceWindow": { "fields": { "week_day_based_schedule": { + "description": "Schedule anchored to a day of the week, either every week or on given weeks of the month.", "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64494,6 +64671,7 @@ "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule": { "fields": { "day_of_week": { + "description": "Day of the week on which the maintenance window starts.", "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64501,6 +64679,7 @@ ] }, "frequency": { + "description": "How often the maintenance window occurs: every week, or only on the listed occurrences of\nthe day of the week within each month.", "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64508,6 +64687,7 @@ ] }, "window_start_time": { + "description": "Time of day, in UTC, at which the maintenance window starts.", "ref": "settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -64539,12 +64719,14 @@ "settings.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime": { "fields": { "hours": { + "description": "Hour of the day on a 24-hour clock.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "minutes": { + "description": "Minute of the hour.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -67277,6 +67459,7 @@ ] }, "status": { + "description": "Controls what workspace admins can do with service principal tokens and job identities. With\nALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal\nin the workspace, change a job owner to any workspace user, and set a job's run_as identity to\nany workspace user or to a service principal they have the Service Principal User role on. With\nRESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the\nService Principal User role on, change a job owner to themselves, and set run_as to themselves\nor to a service principal they have that role on.", "ref": "settings.RestrictWorkspaceAdminsMessageStatus", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -68085,6 +68268,7 @@ "settingsv2.AibiDashboardEmbeddingAccessPolicy": { "fields": { "access_policy_type": { + "description": "Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved\ndomains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS).\nDefaults to ALLOW_APPROVED_DOMAINS.", "ref": "settingsv2.AibiDashboardEmbeddingAccessPolicyAccessPolicyType", "launch_stage": "GA", "behaviors": [ @@ -68108,6 +68292,7 @@ "settingsv2.AibiDashboardEmbeddingApprovedDomains": { "fields": { "approved_domains": { + "description": "Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a\ndomain. The list applies, and can only be changed, while the embedding access policy is\nALLOW_APPROVED_DOMAINS.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -68118,6 +68303,7 @@ "settingsv2.AllowedAppsUserApiScopesMessage": { "fields": { "allowed_scopes": { + "description": "OAuth scopes that app developers can request when an app acts on behalf of a user. A list with\nthe single entry * allows every supported scope and cannot be combined with other scopes. An\nempty list disables user authorization for apps.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -68138,18 +68324,21 @@ "settingsv2.ClusterAutoRestartMessage": { "fields": { "can_toggle": { + "description": "Whether the workspace can change the enabled state. Databricks computes this value: it is false\nwhen the compliance security profile forces the feature on or when the workspace lacks the\nEnhanced Security and Compliance entitlement. A value sent in an update request has no effect.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "enabled": { + "description": "Whether automatic cluster update is enabled for the workspace. The effective value is always\ntrue while the compliance security profile is enabled on the workspace.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "enablement_details": { + "description": "Why the feature is forced on or unavailable. Databricks sets these details for information only;\nthey do not determine whether the feature is enabled.", "ref": "settingsv2.ClusterAutoRestartMessageEnablementDetails", "launch_stage": "GA", "behaviors": [ @@ -68157,6 +68346,7 @@ ] }, "maintenance_window": { + "description": "When the maintenance window runs. When unset, it defaults to the first Sunday of every month at\n01:00 UTC.", "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindow", "launch_stage": "GA", "behaviors": [ @@ -68164,6 +68354,7 @@ ] }, "restart_even_if_no_updates_available": { + "description": "Whether compute resources restart during every maintenance window even when no update is\navailable. When false, they restart only when an update is available.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -68182,7 +68373,7 @@ ] }, "unavailable_for_disabled_entitlement": { - "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)", + "description": "The feature is unavailable because the workspace does not have the Enhanced Security and\nCompliance entitlement.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -68200,6 +68391,7 @@ "settingsv2.ClusterAutoRestartMessageMaintenanceWindow": { "fields": { "week_day_based_schedule": { + "description": "Schedule anchored to a day of the week, either every week or on given weeks of the month.", "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule", "launch_stage": "GA", "behaviors": [ @@ -68231,6 +68423,7 @@ "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule": { "fields": { "day_of_week": { + "description": "Day of the week on which the maintenance window starts.", "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek", "launch_stage": "GA", "behaviors": [ @@ -68238,6 +68431,7 @@ ] }, "frequency": { + "description": "How often the maintenance window occurs: every week, or only on the listed occurrences of\nthe day of the week within each month.", "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency", "launch_stage": "GA", "behaviors": [ @@ -68245,6 +68439,7 @@ ] }, "window_start_time": { + "description": "Time of day, in UTC, at which the maintenance window starts.", "ref": "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime", "launch_stage": "GA", "behaviors": [ @@ -68276,12 +68471,14 @@ "settingsv2.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime": { "fields": { "hours": { + "description": "Hour of the day on a 24-hour clock.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "minutes": { + "description": "Minute of the hour.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -69017,6 +69214,7 @@ "settingsv2.OperationalEmailCustomRecipientMessage": { "fields": { "email": { + "description": "Email address that receives this workspace's operational emails in addition to the workspace\nadmins. Use a distribution list address to reach several people. An empty string clears the\nadditional recipient.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -69051,6 +69249,7 @@ "settingsv2.PersonalComputeMessage": { "fields": { "value": { + "description": "ON grants all users in all workspaces of the account access to the Personal Compute default\npolicy. DELEGATE moves control to each workspace, where users or groups must be added to the\npolicy's permissions before they can create compute with it.", "ref": "settingsv2.PersonalComputeMessagePersonalComputeMessageEnum", "launch_stage": "GA", "behaviors": [ @@ -69097,6 +69296,7 @@ ] }, "status": { + "description": "Controls what workspace admins can do with service principal tokens and job identities. With\nALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal\nin the workspace, change a job owner to any workspace user, and set a job's run_as identity to\nany workspace user or to a service principal they have the Service Principal User role on. With\nRESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the\nService Principal User role on, change a job owner to themselves, and set run_as to themselves\nor to a service principal they have that role on.", "ref": "settingsv2.RestrictWorkspaceAdminsMessageStatus", "launch_stage": "GA", "behaviors": [ @@ -69116,6 +69316,7 @@ } }, "settingsv2.Setting": { + "description": "A setting and its value at the workspace or account scope. Each setting has one value type, so\none value field applies to it: a primitive wrapper (boolean_val, string_val or integer_val) or a\nsetting-specific message. The settings metadata endpoint reports the field each setting uses.\nWhen updating a setting, set only the value field that matches its type. Responses return that\nfield with the value configured at this scope, if one is set, together with the matching\neffective_* field, which holds the value in effect after Databricks applies account policies and\ndefaults.", "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.", @@ -69278,7 +69479,7 @@ ] }, "name": { - "description": "Name of the setting.", + "description": "Name of the setting. The settings metadata endpoint lists the names available at each scope.", "launch_stage": "GA" }, "operational_email_custom_recipient": { @@ -69416,12 +69617,14 @@ "description": "Workspace label and color for display (e.g. in account console).", "fields": { "color": { + "description": "Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, purple\nand pink. It is an empty string when no label is set.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" ] }, "label": { + "description": "Text of the label shown next to the workspace name in the top navigation bar. An empty string\nmeans no label is set.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -71087,6 +71290,18 @@ } } }, + "softwareartifacts.DeleteSoftwareArtifactRequest": { + "fields": { + "force": { + "description": "Force deletion even if the software artifact has versions, deleting them with it. Default is\nfalse.", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "softwareartifacts.DeleteSoftwareArtifactVersionRequest": {}, "softwareartifacts.GetSoftwareArtifactRequest": {}, "softwareartifacts.GetSoftwareArtifactVersionRequest": {}, "softwareartifacts.ImageAccelerationDetail": { @@ -71998,9 +72213,11 @@ "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": { + "description": "Databricks SQL version to pin to. Set it if and only if name is\nCHANNEL_NAME_CUSTOM.", "launch_stage": "GA" }, "name": { + "description": "Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW\ncarries the upcoming Databricks SQL release for testing.", "ref": "sql.ChannelName", "launch_stage": "GA" } @@ -72393,7 +72610,7 @@ "launch_stage": "GA" }, "channel": { - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "ref": "sql.Channel", "launch_stage": "GA" }, @@ -72402,7 +72619,7 @@ "launch_stage": "GA" }, "creator_name": { - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "launch_stage": "GA" }, "customer_version_label": { @@ -72438,7 +72655,7 @@ "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "launch_stage": "GA" }, "reyden_cluster_size_multiplier": { @@ -72446,12 +72663,12 @@ "launch_stage": "PRIVATE_PREVIEW" }, "spot_instance_policy": { - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "ref": "sql.SpotInstancePolicy", "launch_stage": "GA" }, "statement_timeout": { - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "launch_stage": "PUBLIC_PREVIEW" }, "tags": { @@ -72883,7 +73100,7 @@ "launch_stage": "GA" }, "channel": { - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "ref": "sql.Channel", "launch_stage": "GA" }, @@ -72892,7 +73109,7 @@ "launch_stage": "GA" }, "creator_name": { - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "launch_stage": "GA" }, "customer_version_label": { @@ -72928,7 +73145,7 @@ "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "launch_stage": "GA" }, "reyden_cluster_size_multiplier": { @@ -72936,12 +73153,12 @@ "launch_stage": "PRIVATE_PREVIEW" }, "spot_instance_policy": { - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "ref": "sql.SpotInstancePolicy", "launch_stage": "GA" }, "statement_timeout": { - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "launch_stage": "PUBLIC_PREVIEW" }, "tags": { @@ -72977,9 +73194,11 @@ "sql.EndpointConfPair": { "fields": { "key": { + "description": "Name of the configuration parameter.", "launch_stage": "GA" }, "value": { + "description": "Value of the configuration parameter.", "launch_stage": "GA" } } @@ -73021,7 +73240,7 @@ "launch_stage": "GA" }, "channel": { - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "ref": "sql.Channel", "launch_stage": "GA" }, @@ -73030,7 +73249,7 @@ "launch_stage": "GA" }, "creator_name": { - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "launch_stage": "GA" }, "customer_version_label": { @@ -73057,7 +73276,7 @@ ] }, "id": { - "description": "unique identifier for warehouse", + "description": "Unique identifier of the warehouse.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -73069,7 +73288,7 @@ "launch_stage": "GA" }, "jdbc_url": { - "description": "the jdbc connection string for this warehouse", + "description": "JDBC connection string for the warehouse.", "launch_stage": "GA" }, "max_dbu": { @@ -73085,7 +73304,7 @@ "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "launch_stage": "GA" }, "num_active_sessions": { @@ -73094,7 +73313,7 @@ "launch_stage": "GA" }, "num_clusters": { - "description": "current number of clusters running for the service", + "description": "Number of clusters currently allocated to the warehouse, including clusters that\nare still starting.", "launch_stage": "GA" }, "odbc_params": { @@ -73107,17 +73326,17 @@ "launch_stage": "PRIVATE_PREVIEW" }, "spot_instance_policy": { - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "ref": "sql.SpotInstancePolicy", "launch_stage": "GA" }, "state": { - "description": "state of the endpoint", + "description": "Current state of the warehouse.", "ref": "sql.State", "launch_stage": "GA" }, "statement_timeout": { - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "launch_stage": "PUBLIC_PREVIEW" }, "tags": { @@ -73149,9 +73368,11 @@ "sql.EndpointTagPair": { "fields": { "key": { + "description": "Tag key. Keys must be unique within the warehouse and cannot use the keys that\nDatabricks reserves for the tags it sets automatically.", "launch_stage": "GA" }, "value": { + "description": "Tag value. Keys and values must follow the tagging rules of the cloud provider.", "launch_stage": "GA" } } @@ -73159,6 +73380,7 @@ "sql.EndpointTags": { "fields": { "custom_tags": { + "description": "User-defined tags, applied in addition to the tags Databricks sets automatically.", "launch_stage": "GA" } } @@ -73206,7 +73428,7 @@ "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.", + "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": { @@ -73269,7 +73491,7 @@ "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.", + "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": { @@ -73392,7 +73614,7 @@ "launch_stage": "GA" }, "channel": { - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "ref": "sql.Channel", "launch_stage": "GA" }, @@ -73401,7 +73623,7 @@ "launch_stage": "GA" }, "creator_name": { - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "launch_stage": "GA" }, "customer_version_label": { @@ -73428,7 +73650,7 @@ ] }, "id": { - "description": "unique identifier for warehouse", + "description": "Unique identifier of the warehouse.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -73440,7 +73662,7 @@ "launch_stage": "GA" }, "jdbc_url": { - "description": "the jdbc connection string for this warehouse", + "description": "JDBC connection string for the warehouse.", "launch_stage": "GA" }, "max_dbu": { @@ -73456,7 +73678,7 @@ "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "launch_stage": "GA" }, "num_active_sessions": { @@ -73465,7 +73687,7 @@ "launch_stage": "GA" }, "num_clusters": { - "description": "current number of clusters running for the service", + "description": "Number of clusters currently allocated to the warehouse, including clusters that\nare still starting.", "launch_stage": "GA" }, "odbc_params": { @@ -73478,17 +73700,17 @@ "launch_stage": "PRIVATE_PREVIEW" }, "spot_instance_policy": { - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "ref": "sql.SpotInstancePolicy", "launch_stage": "GA" }, "state": { - "description": "state of the endpoint", + "description": "Current state of the warehouse.", "ref": "sql.State", "launch_stage": "GA" }, "statement_timeout": { - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "launch_stage": "PUBLIC_PREVIEW" }, "tags": { @@ -73532,7 +73754,7 @@ "launch_stage": "GA" }, "data_access_config": { - "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "description": "Spark configuration applied to every warehouse in the workspace, for example to\nconnect to an external Hive metastore or to configure access to cloud storage.\nOnly allowlisted keys are accepted, and the JSON-serialized size must be at most\n512 KB. See https://docs.databricks.com/aws/en/admin/sql/data-access-configuration.", "launch_stage": "GA" }, "enable_serverless_compute": { @@ -73541,7 +73763,7 @@ "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.", + "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.", "launch_stage": "GA" }, "global_param": { @@ -73551,7 +73773,7 @@ "launch_stage": "GA" }, "google_service_account": { - "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "description": "GCP only: Google service account that the warehouse clusters use to access Google\nCloud Storage.", "launch_stage": "GA" }, "instance_profile_arn": { @@ -73565,7 +73787,7 @@ "launch_stage": "GA" }, "sql_configuration_parameters": { - "description": "SQL configuration parameters", + "description": "SQL configuration parameters applied to every warehouse in the workspace. Only\nparameters that can be set at the workspace scope are accepted. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters.", "ref": "sql.RepeatedEndpointConfPairs", "launch_stage": "GA" } @@ -74242,15 +74464,19 @@ "sql.OdbcParams": { "fields": { "hostname": { + "description": "Hostname of the workspace to connect to.", "launch_stage": "GA" }, "path": { + "description": "HTTP path of the warehouse.", "launch_stage": "GA" }, "port": { + "description": "The connection port is always 443.", "launch_stage": "GA" }, "protocol": { + "description": "The transport protocol is always https.", "launch_stage": "GA" } } @@ -74960,6 +75186,7 @@ "launch_stage": "GA" }, "configuration_pairs": { + "description": "Configuration parameters, each a key-value pair.", "launch_stage": "GA" } } @@ -74983,10 +75210,11 @@ "launch_stage": "GA" }, "external_links": { + "description": "Short-lived cloud-storage links to the result data, used with the `EXTERNAL_LINKS` disposition.", "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.", + "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": { @@ -75011,10 +75239,12 @@ "launch_stage": "GA" }, "format": { + "description": "The format of the result data, as requested with `format`.", "ref": "sql.Format", "launch_stage": "GA" }, "schema": { + "description": "The schema of the result set: the ordered list of column descriptions.", "ref": "sql.ResultSchema", "launch_stage": "GA" }, @@ -75040,9 +75270,11 @@ "description": "The schema is an ordered list of column descriptions.", "fields": { "column_count": { + "description": "The number of columns in the result set.", "launch_stage": "GA" }, "columns": { + "description": "The column descriptions, in result set order.", "launch_stage": "GA" } } @@ -75080,6 +75312,7 @@ "sql.ServiceError": { "fields": { "error_code": { + "description": "The error code that classifies the failure.", "ref": "sql.ServiceErrorCode", "launch_stage": "GA" }, @@ -75162,7 +75395,7 @@ "launch_stage": "GA" }, "data_access_config": { - "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "description": "Spark configuration applied to every warehouse in the workspace, for example to\nconnect to an external Hive metastore or to configure access to cloud storage.\nOnly allowlisted keys are accepted, and the JSON-serialized size must be at most\n512 KB. See https://docs.databricks.com/aws/en/admin/sql/data-access-configuration.", "launch_stage": "GA" }, "enable_serverless_compute": { @@ -75171,7 +75404,7 @@ "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.", + "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.", "launch_stage": "GA" }, "global_param": { @@ -75181,7 +75414,7 @@ "launch_stage": "GA" }, "google_service_account": { - "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "description": "GCP only: Google service account that the warehouse clusters use to access Google\nCloud Storage.", "launch_stage": "GA" }, "instance_profile_arn": { @@ -75195,7 +75428,7 @@ "launch_stage": "GA" }, "sql_configuration_parameters": { - "description": "SQL configuration parameters", + "description": "SQL configuration parameters applied to every warehouse in the workspace. Only\nparameters that can be set at the workspace scope are accepted. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters.", "ref": "sql.RepeatedEndpointConfPairs", "launch_stage": "GA" } @@ -75271,10 +75504,12 @@ "description": "Statement Execution works with all SQL warehouse types, including Lakehouse//RT. Statement Execution\n(Lakehouse//RT) is optimized for Lakehouse//RT warehouses, with lower latency and higher concurrency, and\ntakes `warehouse_id` as a path parameter.", "fields": { "manifest": { + "description": "The schema and metadata of the result set. Present when `status.state` is `SUCCEEDED`.", "ref": "sql.ResultManifest", "launch_stage": "GA" }, "result": { + "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\nshort-lived cloud-storage URLs to the result data\nin cloud storage. Exactly one of these alternatives is used. Calls to `getResultData` return\nthe link for the requested chunk; `executeStatement` and `getStatementResult` responses can\ncontain links for multiple chunks.", "ref": "sql.ResultData", "launch_stage": "GA" }, @@ -75283,6 +75518,7 @@ "launch_stage": "GA" }, "status": { + "description": "The execution state of the statement and, if it failed, the error details.", "ref": "sql.StatementStatus", "launch_stage": "GA" } @@ -75310,6 +75546,7 @@ "description": "The status response includes execution state and if relevant, error information.", "fields": { "error": { + "description": "The error that caused the statement to fail. Only populated when `state` is `FAILED`.", "ref": "sql.ServiceError", "launch_stage": "GA" }, @@ -76204,6 +76441,7 @@ "launch_stage": "GA" }, "warehouse_type": { + "description": "Warehouse type that this entry enables or disables.", "ref": "sql.WarehouseTypePairWarehouseType", "launch_stage": "GA" } @@ -76435,7 +76673,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "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.", + "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": "PUBLIC_PREVIEW" }, "query_tags": { @@ -77365,6 +77603,7 @@ } }, "tags.TagPolicy": { + "description": "A tag policy makes a tag key governed and defines the values that can be assigned to it. Governed\ntags are enforced across all workspaces in the account, and only users with the ASSIGN permission on\nthe governed tag can assign it. See https://docs.databricks.com/aws/en/admin/governed-tags/.", "fields": { "create_time": { "description": "Timestamp when the tag policy was created", @@ -77375,12 +77614,14 @@ ] }, "description": { + "description": "A description of the governed tag, such as its purpose or the meaning of its values.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "id": { + "description": "The unique identifier of the tag policy, generated when the policy is created.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -77388,6 +77629,7 @@ ] }, "tag_key": { + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -77401,6 +77643,7 @@ ] }, "values": { + "description": "The allowed values of the governed tag. Only these values can be assigned to the tag key, and each\nvalue must be unique. A policy without values defines a key-only governed tag.", "launch_stage": "GA", "behaviors": [ "OPTIONAL", @@ -77428,14 +77671,16 @@ "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.", + "description": "The comma-separated list of tag policy fields to update. When the mask includes `values`, the\nvalues in the request replace all existing allowed values.", "launch_stage": "GA" } } }, "tags.Value": { + "description": "An allowed value of a governed tag.", "fields": { "name": { + "description": "The value that can be assigned to the tag key. Values are case-sensitive.", "launch_stage": "GA" } } @@ -78688,7 +78933,7 @@ "launch_stage": "GA" }, "principal": { - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "launch_stage": "GA" } } @@ -78710,11 +78955,11 @@ "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", "fields": { "dns_name": { - "description": "The DNS of the KeyVault", + "description": "The DNS name of the key vault, for example ``https://my-key-vault.vault.azure.net/``.", "launch_stage": "GA" }, "resource_id": { - "description": "The resource id of the azure KeyVault that user wants to associate the scope with.", + "description": "The Azure resource ID of the key vault to associate with the scope.", "launch_stage": "GA" } } @@ -78853,7 +79098,7 @@ "launch_stage": "GA" }, "scope_backend_type": { - "description": "The backend type the scope will be created with. If not specified, will default to ``DATABRICKS``", + "description": "The backend type of the new scope. Defaults to ``DATABRICKS``.", "ref": "workspace.ScopeBackendType", "launch_stage": "GA" } @@ -79383,7 +79628,7 @@ "launch_stage": "GA" }, "principal": { - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "launch_stage": "GA" }, "scope": { @@ -79545,7 +79790,7 @@ } }, "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.", + "description": "The types of secret scope backends in the Secret Manager.", "enum": [ "DATABRICKS", "AZURE_KEYVAULT" @@ -79569,7 +79814,7 @@ } }, "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.", + "description": "An organizational resource for storing secrets. A secret scope is either Databricks-backed\nor Azure Key Vault-backed, and ACLs can be applied to control permissions for all secrets\nwithin a scope.", "fields": { "backend_type": { "description": "The type of secret scope backend.", @@ -79577,7 +79822,7 @@ "launch_stage": "GA" }, "keyvault_metadata": { - "description": "The metadata for the secret scope if the type is ``AZURE_KEYVAULT``", + "description": "The metadata for the secret scope if the type is ``AZURE_KEYVAULT``.", "ref": "workspace.AzureKeyVaultSecretScopeMetadata", "launch_stage": "GA" }, @@ -81544,7 +81789,7 @@ }, { "name": "CreateMemory", - "description": "Creates a memory entry using exclusive-create semantics. Callers may choose the entry\nID; the service generates one when it is omitted. Returns `ALREADY_EXISTS` when an entry with\nthe same actor, session, and path already exists. Omitted `session_id` is its own uniqueness\nkey: two omitted-session entries with the same actor and path conflict, but an omitted-session\nentry does not conflict with a session-scoped entry at the same actor and path.", + "description": "Creates a memory entry using exclusive-create semantics. Callers may choose the entry\nID; the service generates one when it is omitted. Returns `ALREADY_EXISTS` when an entry with\nthe same actor, session, and path already exists. Omitted `session_id` is its own uniqueness\nkey: two omitted-session entries with the same actor and path conflict, but an omitted-session\nentry does not conflict with a session-scoped entry at the same actor and path. `session_id` is\ndeprecated: once it is ignored, the uniqueness key becomes actor and path.", "summary": "Create a memory entry.", "path": "/api/2.0/agents/{parent=memory-stores/*}/entries", "can_use_json": true, @@ -81624,7 +81869,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81644,7 +81889,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81670,7 +81915,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81690,7 +81935,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81721,7 +81966,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81741,7 +81986,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81813,7 +82058,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -81822,7 +82067,7 @@ }, { "name": "session_id", - "description": "Optional identifier for the session associated with this memory entry. When omitted, the\nentry applies across the actor's sessions.", + "description": "Deprecated: memory entries will be identified by `(actor_id, path)`, and the service will\nignore this field on writes and omit it from responses. Until then, an omitted value means the\nentry applies across the actor's sessions.", "is_request_body_field": true, "entity": { "is_string": true @@ -81876,7 +82121,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -83140,7 +83385,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -83160,7 +83405,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -83851,7 +84096,7 @@ }, { "name": "ListMemories", - "description": "Lists memory entries for one actor. An exact `path` filters entries across sessions,\nignoring session metadata. Otherwise, `session_id` and `path_prefix` restrict the actor\npartition. `view` controls whether each returned entry includes memory content.", + "description": "Lists memory entries for one actor. An exact `path` filters entries across sessions,\nignoring session metadata. Otherwise, `path_prefix` and the deprecated `session_id` restrict\nthe actor partition. `view` controls whether each returned entry includes memory content.", "summary": "List memory entries.", "path": "/api/2.0/agents/{parent=memory-stores/*}/entries", "has_required_positional_arguments": true, @@ -83952,7 +84197,7 @@ }, { "name": "session_id", - "description": "Optional session identifier. When set, only entries with this exact `session_id` are\nreturned. Omitted-session (cross-session) entries are not included. Ignored when path is set.", + "description": "Deprecated: the service will ignore this filter. Until then, when set, only entries with\nthis exact `session_id` are returned, and omitted-session (cross-session) entries\nare not included. Ignored when path is set.", "is_query": true, "entity": { "is_string": true @@ -84895,7 +85140,7 @@ }, { "name": "session_id", - "description": "Optional session identifier. When set, only entries with this exact `session_id` are\nsearched. Omitted-session (cross-session) entries are not included.", + "description": "Deprecated: the service will ignore this filter. Until then, when set, only entries with\nthis exact `session_id` are searched, and omitted-session (cross-session) entries\nare not included.", "is_request_body_field": true, "entity": { "is_string": true @@ -85060,7 +85305,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85080,7 +85325,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85106,7 +85351,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85126,7 +85371,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85157,7 +85402,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85177,7 +85422,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85250,7 +85495,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -85259,7 +85504,7 @@ }, { "name": "session_id", - "description": "Optional identifier for the session associated with this memory entry. When omitted, the\nentry applies across the actor's sessions.", + "description": "Deprecated: memory entries will be identified by `(actor_id, path)`, and the service will\nignore this field on writes and omit it from responses. Until then, an omitted value means the\nentry applies across the actor's sessions.", "is_request_body_field": true, "entity": { "is_string": true @@ -85322,7 +85567,7 @@ }, { "name": "path", - "description": "Absolute, case-sensitive path identifying the entry within its actor and optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", + "description": "Absolute, case-sensitive path identifying the entry within its actor and, until the\ndeprecated `session_id` is ignored, its optional session.\nPaths must begin with `/` and must not contain empty, `.` or `..` segments.", "required": true, "is_request_body_field": true, "entity": { @@ -86117,7 +86362,7 @@ }, { "name": "labels", - "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters.", + "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters. When multilabel is true, a single label is also accepted.", "required": true, "is_request_body_field": true, "entity": {} @@ -86133,7 +86378,7 @@ }, { "name": "labels", - "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters.", + "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters. When multilabel is true, a single label is also accepted.", "required": true, "is_request_body_field": true, "entity": {} @@ -86154,7 +86399,7 @@ }, { "name": "labels", - "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters.", + "description": "The label set to classify as. Either a JSON array of label strings (e.g. [\"spam\", \"not_spam\"]), or a JSON object mapping each label to a description (e.g. {\"spam\": \"unsolicited bulk message\", \"not_spam\": \"a legitimate message\"}). Accepts 2 to 500 labels, each 1 to 100 characters. When multilabel is true, a single label is also accepted.", "required": true, "is_request_body_field": true, "entity": {} @@ -86173,7 +86418,7 @@ }, { "name": "AiDecide", - "description": "Turn text and structured data into decisions your application can use. Define questions and criteria to choose an option, estimate a probability, or assign a score given a provided state.", + "description": "Turn text and structured data into decisions your application can use. Define questions and criteria to choose an option, estimate a probability, or assign a score given a provided state. For REST API requests, the default rate limit is 1,200 requests per minute per workspace. Contact your Databricks account team to request a higher limit.", "summary": "Get fast structured decisions.", "path": "/api/2.0/ai-functions/ai-decide", "can_use_json": true, @@ -90135,10 +90380,8 @@ "name": "aisearch" }, "docs_group": "aisearch", - "launch_stage": "PUBLIC_PREVIEW", - "cli_launch_stage_label": "*Public Preview*", - "cli_launch_stage_banner": "This command is in Public Preview and may change without notice.", - "cli_launch_stage_display": "Public Preview", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "list": { "request": { "pascal_name": "ListEndpointsRequest" @@ -90153,10 +90396,8 @@ "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "CreateEndpointRequest", "is_object": true, @@ -90570,10 +90811,8 @@ "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "CreateIndexRequest", "is_object": true, @@ -90983,10 +91222,8 @@ "summary": "Delete an AI Search endpoint.", "path": "/api/2.0/ai-search/{name=workspaces/*/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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "DeleteEndpointRequest", "is_object": true, @@ -91045,10 +91282,8 @@ "summary": "Delete an AI Search index.", "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "DeleteIndexRequest", "is_object": true, @@ -91108,10 +91343,8 @@ "path": "/api/2.0/ai-search/{name=workspaces/*/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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "GetEndpointRequest", "is_object": true, @@ -91211,10 +91444,8 @@ "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "GetIndexRequest", "is_object": true, @@ -91331,10 +91562,8 @@ "summary": "List AI Search endpoints.", "path": "/api/2.0/ai-search/{parent=workspaces/*}/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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "ListEndpointsRequest", "is_object": true, @@ -91422,10 +91651,8 @@ "summary": "List AI Search indexes.", "path": "/api/2.0/ai-search/{parent=workspaces/*/endpoints/*}/indexes", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "ListIndexesRequest", "is_object": true, @@ -91515,10 +91742,8 @@ "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "QueryIndexRequest", "is_object": true, @@ -91724,10 +91949,8 @@ "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "RemoveDataRequest", "is_object": true, @@ -91827,10 +92050,8 @@ "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}:scan", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "ScanIndexRequest", "is_object": true, @@ -91906,10 +92127,8 @@ "summary": "Synchronize an AI Search index.", "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}:sync", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "SyncIndexRequest", "is_object": true, @@ -91970,10 +92189,8 @@ "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*}", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "UpdateEndpointRequest", "is_object": true, @@ -92415,10 +92632,8 @@ "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}:upsertData", "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", + "launch_stage": "GA", + "cli_launch_stage_display": "GA", "request": { "pascal_name": "UpsertDataRequest", "is_object": true, @@ -106866,7 +107081,7 @@ }, { "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**", + "description": "Local details for a foreign table 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": { @@ -106914,7 +107129,7 @@ }, { "name": "status", - "description": "Status of the asset", + "description": "The sharing status of the asset. `PERMISSION_DENIED` means the clean room owner no longer has\nthe privileges needed on the underlying Unity Catalog object, so the asset is not shared into the\nclean room.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -107778,7 +107993,7 @@ }, { "name": "List", - "description": "List assets.", + "description": "List the assets in a clean room. Listed assets do not include their asset-type specific details,\nsuch as table columns or notebook content; use the get method to retrieve them.", "summary": "List assets.", "path": "/api/2.0/clean-rooms/{clean_room_name}/assets", "has_required_positional_arguments": true, @@ -108364,7 +108579,7 @@ }, { "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**", + "description": "Local details for a foreign table 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": { @@ -108412,7 +108627,7 @@ }, { "name": "status", - "description": "Status of the asset", + "description": "The sharing status of the asset. `PERMISSION_DENIED` means the clean room owner no longer has\nthe privileges needed on the underlying Unity Catalog object, so the asset is not shared into the\nclean room.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -115621,7 +115836,7 @@ }, { "name": "connection_type", - "description": "The type of connection.", + "description": "The type of external data source or service that the connection reaches. The connection type\ndetermines which keys are required in options and cannot be changed after creation.", "required": true, "is_request_body_field": true, "entity": { @@ -115753,7 +115968,7 @@ }, { "name": "connection_type", - "description": "The type of connection.", + "description": "The type of external data source or service that the connection reaches. The connection type\ndetermines which keys are required in options and cannot be changed after creation.", "required": true, "is_request_body_field": true, "entity": { @@ -115889,7 +116104,7 @@ }, { "name": "connection_type", - "description": "The type of connection.", + "description": "The type of external data source or service that the connection reaches. The connection type\ndetermines which keys are required in options and cannot be changed after creation.", "required": true, "is_request_body_field": true, "entity": { @@ -115999,7 +116214,7 @@ }, { "name": "environment_settings", - "description": "[Create,Update:OPT] Connection environment settings as EnvironmentSettings object.", + "description": "Environment settings for the connection, such as the Java libraries that it needs and the\nenvironment version.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -116047,7 +116262,7 @@ }, { "name": "read_only", - "description": "If the connection is read only.", + "description": "Whether the connection is read only. All connections are currently read only, so a value set on\ncreate or update is ignored.", "is_request_body_field": true, "entity": { "is_bool": true @@ -116129,7 +116344,7 @@ }, { "name": "Get", - "description": "Gets a connection from it's name.", + "description": "Gets a connection from its name.", "summary": "Get a connection.", "path": "/api/2.1/unity-catalog/connections/{name}", "is_crud_read": true, @@ -116254,7 +116469,7 @@ }, { "name": "Update", - "description": "Updates the connection that matches the supplied name.", + "description": "Updates the connection that matches the supplied name. When options are provided, they replace the\nexisting options of the connection, so include every key that the connection type requires.", "summary": "Update a connection.", "path": "/api/2.1/unity-catalog/connections/{name}", "can_use_json": true, @@ -116320,7 +116535,7 @@ "all_fields": [ { "name": "environment_settings", - "description": "[Create,Update:OPT] Connection environment settings as EnvironmentSettings object.", + "description": "Environment settings for the connection, such as the Java libraries that it needs and the\nenvironment version.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -116358,7 +116573,7 @@ }, { "name": "owner", - "description": "Username of current owner of the connection.", + "description": "Username of the current owner of the connection. The creator becomes the owner at creation, and\nownership can be transferred on update.", "is_request_body_field": true, "entity": { "is_string": true @@ -118257,7 +118472,7 @@ }, { "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.", + "description": "Returns a set of temporary credentials generated using the specified service credential.\nThe caller must be a metastore admin or have the **ACCESS** privilege on the service credential.", "summary": "Generate a temporary service credential.", "path": "/api/2.1/unity-catalog/temporary-service-credentials", "can_use_json": true, @@ -118298,6 +118513,7 @@ "all_fields": [ { "name": "azure_options", + "description": "Options for an Azure service credential. They are required when the service credential uses an Azure managed\nidentity.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -118316,6 +118532,7 @@ }, { "name": "gcp_options", + "description": "Options for a GCP service credential. They are required when the service credential uses a Databricks-managed GCP\nservice account.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -120789,7 +121006,7 @@ "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.", + "description": "Create Data Classification configuration for a catalog.\n\nCreates a new config resource, which enables Data Classification\nfor the specified catalog. The catalog must not already have a config. Creating the config\nstarts a scan of the selected schemas and schedules recurring scans.", "summary": "Create config for a catalog.", "path": "/api/data-classification/v1/{parent=catalogs/*}/config", "can_use_json": true, @@ -120804,7 +121021,7 @@ "required_fields": [ { "name": "parent", - "description": "Parent resource in the format: catalogs/{catalog_name}", + "description": "Name of the catalog to enable, in the format catalogs/{catalog_name}.", "required": true, "is_path": true, "entity": { @@ -120825,7 +121042,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "Parent resource in the format: catalogs/{catalog_name}", + "description": "Name of the catalog to enable, in the format catalogs/{catalog_name}.", "required": true, "is_path": true, "entity": { @@ -120873,7 +121090,7 @@ }, { "name": "parent", - "description": "Parent resource in the format: catalogs/{catalog_name}", + "description": "Name of the catalog to enable, in the format catalogs/{catalog_name}.", "required": true, "is_path": true, "entity": { @@ -120882,7 +121099,7 @@ }, { "name": "auto_tag_configs", - "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled.", + "description": "Auto-tagging configurations that apply to this catalog. Each entry overrides the\nmetastore-level auto-tagging setting for its classification tag; tags without an entry\ninherit the metastore-level setting.", "is_request_body_field": true, "entity": { "pascal_name": "AutoTaggingConfigList", @@ -120894,7 +121111,7 @@ }, { "name": "excluded_schemas", - "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned, including schemas\ncreated later.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -120904,7 +121121,7 @@ }, { "name": "included_schemas", - "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned. Schemas created later are not scanned\nuntil you add them to the list.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -120924,7 +121141,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "Parent resource in the format: catalogs/{catalog_name}", + "description": "Name of the catalog to enable, in the format catalogs/{catalog_name}.", "required": true, "is_path": true, "entity": { @@ -120935,7 +121152,7 @@ }, { "name": "DeleteCatalogConfig", - "description": "Delete Data Classification configuration for a catalog.", + "description": "Delete Data Classification configuration for a catalog.\n\nDeleting the config disables Data Classification for the catalog and stops its scheduled\nscans. Tags that auto-tagging already applied to columns are not removed. Deleting a config\nthat does not exist succeeds.", "summary": "Delete config for a catalog.", "path": "/api/data-classification/v1/{name=catalogs/*/config}", "has_required_positional_arguments": true, @@ -120947,7 +121164,7 @@ "required_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -120958,7 +121175,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -120973,7 +121190,7 @@ "all_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -120984,7 +121201,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -121008,7 +121225,7 @@ "required_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -121019,7 +121236,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -121035,7 +121252,7 @@ "all_fields": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -121046,7 +121263,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Resource name in the format: catalogs/{catalog_name}/config", + "description": "Resource name of the config, in the format catalogs/{catalog_name}/config.", "required": true, "is_path": true, "entity": { @@ -121057,7 +121274,7 @@ }, { "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.", + "description": "Update the Data Classification configuration for a catalog.\n\nThe config must already exist for the catalog. Only the fields named in `update_mask`\nchange; the other fields keep their current values.", "summary": "Update config for a catalog.", "path": "/api/data-classification/v1/{name=catalogs/*/config}", "can_use_json": true, @@ -121091,7 +121308,7 @@ }, { "name": "update_mask", - "description": "Field mask specifying which fields to update.", + "description": "Comma-separated list of the fields of catalog_config to update, for example\n`included_schemas` or `auto_tag_configs`.", "required": true, "is_query": true, "entity": { @@ -121111,7 +121328,7 @@ }, { "name": "update_mask", - "description": "Field mask specifying which fields to update.", + "description": "Comma-separated list of the fields of catalog_config to update, for example\n`included_schemas` or `auto_tag_configs`.", "required": true, "is_query": true, "entity": { @@ -121168,7 +121385,7 @@ }, { "name": "update_mask", - "description": "Field mask specifying which fields to update.", + "description": "Comma-separated list of the fields of catalog_config to update, for example\n`included_schemas` or `auto_tag_configs`.", "required": true, "is_query": true, "entity": { @@ -121177,7 +121394,7 @@ }, { "name": "auto_tag_configs", - "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled.", + "description": "Auto-tagging configurations that apply to this catalog. Each entry overrides the\nmetastore-level auto-tagging setting for its classification tag; tags without an entry\ninherit the metastore-level setting.", "is_request_body_field": true, "entity": { "pascal_name": "AutoTaggingConfigList", @@ -121189,7 +121406,7 @@ }, { "name": "excluded_schemas", - "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to exclude from the scan, each named relative to the parent catalog.\nIf specified, all schemas except the specified ones will be scanned, including schemas\ncreated later.\nMutually exclusive with `included_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -121199,7 +121416,7 @@ }, { "name": "included_schemas", - "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", + "description": "Schemas to include in the scan, each named relative to the parent catalog.\nIf specified, only listed schemas will be scanned. Schemas created later are not scanned\nuntil you add them to the list.\nMutually exclusive with `excluded_schemas`: only one may be set per request.\nIf neither `included_schemas` nor `excluded_schemas` is set, all schemas are scanned.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -121228,7 +121445,7 @@ }, { "name": "update_mask", - "description": "Field mask specifying which fields to update.", + "description": "Comma-separated list of the fields of catalog_config to update, for example\n`included_schemas` or `auto_tag_configs`.", "required": true, "is_query": true, "entity": { @@ -121577,7 +121794,7 @@ }, { "name": "anomaly_detection_config", - "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "description": "Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds\nthe settings of the parent schema's monitor if the schema has one.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -121587,7 +121804,7 @@ }, { "name": "data_profiling_config", - "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "description": "Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series`\nor `snapshot` must be set.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -122008,7 +122225,7 @@ }, { "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.", + "description": "Delete 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 **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, @@ -122567,6 +122784,7 @@ "all_fields": [ { "name": "page_size", + "description": "The maximum number of monitors to return in one page.", "is_query": true, "entity": { "is_int": true @@ -122574,6 +122792,7 @@ }, { "name": "page_token", + "description": "Pagination token from a previous response, used to fetch the next page.", "is_query": true, "entity": { "is_string": true @@ -122584,6 +122803,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Pagination token from a previous response, used to fetch the next page.", "is_query": true, "entity": { "is_string": true @@ -122716,7 +122936,7 @@ }, { "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.", + "description": "Update a data quality monitor on a Unity Catalog object. Only the fields named in `update_mask` are changed.\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, @@ -122748,7 +122968,7 @@ }, { "name": "monitor", - "description": "The monitor to update.", + "description": "The new values for the monitor. Only the fields named in `update_mask` are applied.", "required": true, "is_request_body_field": true, "entity": { @@ -122798,7 +123018,7 @@ "required_request_body_fields": [ { "name": "monitor", - "description": "The monitor to update.", + "description": "The new values for the monitor. Only the fields named in `update_mask` are applied.", "required": true, "is_request_body_field": true, "entity": { @@ -122810,7 +123030,7 @@ }, "request_body_field": { "name": "monitor", - "description": "The monitor to update.", + "description": "The new values for the monitor. Only the fields named in `update_mask` are applied.", "required": true, "is_request_body_field": true, "entity": { @@ -122907,7 +123127,7 @@ "all_fields": [ { "name": "monitor", - "description": "The monitor to update.", + "description": "The new values for the monitor. Only the fields named in `update_mask` are applied.", "required": true, "is_request_body_field": true, "entity": { @@ -122985,7 +123205,7 @@ }, { "name": "anomaly_detection_config", - "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "description": "Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds\nthe settings of the parent schema's monitor if the schema has one.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -122995,7 +123215,7 @@ }, { "name": "data_profiling_config", - "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "description": "Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series`\nor `snapshot` must be set.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -136358,7 +136578,7 @@ }, { "name": "GetDefaultWorkspaceBaseEnvironment", - "description": "Gets the default WorkspaceBaseEnvironment configuration for the workspace.\nReturns the current default base environment settings for both CPU and GPU compute.", + "description": "Gets the default WorkspaceBaseEnvironment configuration for the workspace.\nReturns the current default base environment settings for both CPU and GPU compute.\nAn unset CPU or GPU field means that compute type uses the Databricks Standard base\nenvironment.", "summary": "Get the default workspace base environment configuration.", "path": "/api/environments/v1/{name=default-workspace-base-environment}", "is_crud_read": true, @@ -136685,7 +136905,7 @@ }, { "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.", + "description": "Updates the default WorkspaceBaseEnvironment configuration for the workspace.\nSets the specified base environments as the workspace defaults for CPU and/or GPU compute.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "summary": "Update the default workspace base environment configuration.", "path": "/api/environments/v1/{name=default-workspace-base-environment}", "can_use_json": true, @@ -136719,7 +136939,7 @@ }, { "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.", + "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.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "required": true, "is_query": true, "entity": { @@ -136739,7 +136959,7 @@ }, { "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.", + "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.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "required": true, "is_query": true, "entity": { @@ -136796,7 +137016,7 @@ }, { "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.", + "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.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "required": true, "is_query": true, "entity": { @@ -136805,7 +137025,7 @@ }, { "name": "cpu_workspace_base_environment", - "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "The default workspace base environment for CPU compute.\nIf unset, CPU compute defaults to the Databricks Standard base environment (Standard Latest).\nFormat: workspace-base-environments/{workspace_base_environment}", "is_request_body_field": true, "entity": { "is_string": true @@ -136813,7 +137033,7 @@ }, { "name": "gpu_workspace_base_environment", - "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "The default workspace base environment for GPU compute.\nIf unset, GPU compute defaults to the Databricks Standard base environment (Standard Latest).\nFormat: workspace-base-environments/{workspace_base_environment}", "is_request_body_field": true, "entity": { "is_string": true @@ -136840,7 +137060,7 @@ }, { "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.", + "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.\nUnsetting a default makes that compute type use the Databricks Standard base environment.\nThe Standard base environment has no resource name, so unsetting the field is the only way\nto select it.", "required": true, "is_query": true, "entity": { @@ -154691,7 +154911,7 @@ "required_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154702,7 +154922,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154717,7 +154937,7 @@ "all_fields": [ { "name": "force", - "description": "Force deletion even if the function is notempty.", + "description": "Force deletion even if the function is not empty.", "is_query": true, "entity": { "is_bool": true @@ -154725,7 +154945,7 @@ }, { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154736,7 +154956,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) .", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154760,7 +154980,7 @@ "required_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154771,7 +154991,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154795,7 +155015,7 @@ }, { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154806,7 +155026,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154971,7 +155191,7 @@ "required_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154982,7 +155202,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -154998,7 +155218,7 @@ "all_fields": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -155017,7 +155237,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).", + "description": "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__).", "required": true, "is_path": true, "entity": { @@ -156693,7 +156913,7 @@ }, { "name": "GenieCreateEvalRun", - "description": "Creates and runs chat-mode evaluations for multiple benchmark questions in a Genie space.", + "description": "Starts a benchmark evaluation run that asks Genie each selected benchmark question in a Genie space and\ncompares every response with the benchmark SQL. The run executes asynchronously: the response is the new\nrun with its current status. If it is still running, poll with the get method until the status is terminal.", "summary": "Start a benchmark evaluation run.", "path": "/api/2.0/genie/spaces/{space_id}/eval-runs", "can_use_json": true, @@ -156791,7 +157011,7 @@ }, { "name": "GenieGetEvalResultDetails", - "description": "Get details for evaluation results.", + "description": "Gets the full result for one benchmark question in an evaluation run: its assessment and the reasons for\nit, Genie's response with the SQL execution result, and the expected response from the benchmark. The\nresult must belong to the given run.", "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, @@ -156986,7 +157206,7 @@ }, { "name": "GenieGetEvalRun", - "description": "Get evaluation run details.", + "description": "Gets the current status and summary counts of a benchmark evaluation run. Poll this method until\n`eval_run_status` is terminal: DONE, EVALUATION_CANCELLED or EVALUATION_TIMEOUT.", "summary": "Get a benchmark evaluation run.", "path": "/api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}", "is_crud_read": true, @@ -157010,6 +157230,7 @@ }, { "name": "eval_run_id", + "description": "The ID of the evaluation run, as returned when the run was created.", "required": true, "is_path": true, "entity": { @@ -157029,6 +157250,7 @@ }, { "name": "eval_run_id", + "description": "The ID of the evaluation run, as returned when the run was created.", "required": true, "is_path": true, "entity": { @@ -157067,6 +157289,7 @@ "all_fields": [ { "name": "eval_run_id", + "description": "The ID of the evaluation run, as returned when the run was created.", "required": true, "is_path": true, "entity": { @@ -157095,6 +157318,7 @@ }, { "name": "eval_run_id", + "description": "The ID of the evaluation run, as returned when the run was created.", "required": true, "is_path": true, "entity": { @@ -157105,7 +157329,7 @@ }, { "name": "GenieListEvalResults", - "description": "List evaluation results for a specific evaluation run.", + "description": "Lists the results of a benchmark evaluation run, one per benchmark question. Each entry carries the result\nstatus and a snapshot of the question and benchmark answer; the assessment and Genie's response are\navailable through the result details method.", "summary": "List results for a benchmark evaluation run.", "path": "/api/2.0/genie/spaces/{space_id}/eval-runs/{eval_run_id}/results", "is_crud_read": true, @@ -157221,7 +157445,7 @@ }, { "name": "GenieListEvalRuns", - "description": "Lists all evaluation runs in a space.", + "description": "Lists the benchmark evaluation runs in a Genie space with the current status and summary counts of each run.", "summary": "List benchmark evaluation runs.", "path": "/api/2.0/genie/spaces/{space_id}/eval-runs", "is_crud_read": true, @@ -172371,7 +172595,7 @@ }, { "name": "parent_path", - "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object.", + "description": "Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "is_request_body_field": true, "entity": { "is_string": true @@ -180308,7 +180532,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180347,7 +180571,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180392,7 +180616,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180431,7 +180655,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180480,7 +180704,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180519,7 +180743,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180723,7 +180947,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -180827,7 +181051,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -183114,7 +183338,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -183153,7 +183377,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -184902,7 +185126,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -184941,7 +185165,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -184986,7 +185210,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -185025,7 +185249,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -185074,7 +185298,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -185113,7 +185337,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -185343,7 +185567,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -185465,7 +185689,7 @@ }, { "name": "schedule", - "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources.", + "description": "Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a\nrequest that sets `schedule.enabled` to `false` is rejected. Continuous schedules are not\nsupported for Unity Catalog connection datasources. For an existing-table datasource, runs\nmust be no further apart than the shorter of the source table's\n`delta.deletedFileRetentionDuration` and `delta.logRetentionDuration`.", "required": true, "is_request_body_field": true, "entity": { @@ -198181,7 +198405,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198201,7 +198425,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198217,7 +198441,7 @@ "all_fields": [ { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198246,7 +198470,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198278,6 +198502,7 @@ }, { "name": "request_object_id", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198297,6 +198522,7 @@ }, { "name": "request_object_id", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198312,6 +198538,7 @@ "all_fields": [ { "name": "request_object_id", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198340,6 +198567,7 @@ }, { "name": "request_object_id", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198350,7 +198578,7 @@ }, { "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.", + "description": "Sets permissions on an object, replacing all direct permissions with the ones in the request. Principals that are not in the request lose their direct permissions on the object, and all direct permissions are deleted 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, @@ -198372,7 +198600,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198392,7 +198620,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198408,6 +198636,7 @@ "all_fields": [ { "name": "access_control_list", + "description": "Permissions to apply to the object, with one entry per principal. Each entry names exactly one\nprincipal through `user_name`, `group_name` or `service_principal_name` and the\n`permission_level` for that principal.", "is_request_body_field": true, "entity": { "pascal_name": "AccessControlRequestList", @@ -198419,7 +198648,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198448,7 +198677,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198459,7 +198688,7 @@ }, { "name": "Update", - "description": "Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object.", + "description": "Updates the permissions on an object by adding or changing the permissions of the principals in the request. Principals that are not in the request keep their existing permissions. 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, @@ -198481,7 +198710,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198501,7 +198730,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198517,6 +198746,7 @@ "all_fields": [ { "name": "access_control_list", + "description": "Permissions to apply to the object, with one entry per principal. Each entry names exactly one\nprincipal through `user_name`, `group_name` or `service_principal_name` and the\n`permission_level` for that principal.", "is_request_body_field": true, "entity": { "pascal_name": "AccessControlRequestList", @@ -198528,7 +198758,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -198557,7 +198787,7 @@ }, { "name": "request_object_id", - "description": "The id of the request object.", + "description": "The id of the object. It is the id that the object's own API uses, for example the cluster id for\nclusters, the job id for jobs, and the workspace object id for notebooks and directories. For the\n`authorization` object type, use `tokens` to manage token permissions.", "required": true, "is_path": true, "entity": { @@ -199144,7 +199374,7 @@ }, { "name": "parent_path", - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "is_request_body_field": true, "entity": { "is_string": true @@ -199298,7 +199528,7 @@ "all_fields": [ { "name": "allow_duplicate_names", - "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "description": "If false, deployment will fail if name conflicts with that of another pipeline.\n\nIgnored when `parent_path` is set. A pipeline in a workspace folder must have a name that is\nunique within that folder, and creation fails if the folder already contains an object with the\nsame name.", "is_request_body_field": true, "entity": { "is_bool": true @@ -199494,7 +199724,7 @@ }, { "name": "parent_path", - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "is_request_body_field": true, "entity": { "is_string": true @@ -200661,7 +200891,7 @@ "all_fields": [ { "name": "allow_duplicate_names", - "description": "If false, deployment will fail if name has changed and conflicts the name of another pipeline.", + "description": "If false, deployment will fail if name has changed and conflicts with the name of another\npipeline.\n\nIgnored when the pipeline is in a workspace folder or the request sets `parent_path`.\nRenaming or moving such a pipeline fails if the target folder already contains an object with\nthe same name.", "is_request_body_field": true, "entity": { "is_bool": true @@ -200857,7 +201087,7 @@ }, { "name": "parent_path", - "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", + "description": "Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "is_request_body_field": true, "entity": { "is_string": true @@ -207365,7 +207595,7 @@ }, { "name": "role_id", - "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\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.", + "description": "The ID used to identify and manage the Role resource through the API.\nThe Postgres role name is specified in `spec.postgres_role`.\n\nThis value should be 3-63 characters, start with a lowercase letter, end with a lowercase\nletter or digit, and contain only lowercase letters, digits, and hyphens.\n\nIf role_id is not specified in the request, it is generated automatically.", "is_query": true, "entity": { "is_string": true @@ -207373,6 +207603,7 @@ }, { "name": "create_time", + "description": "A timestamp indicating when the role was created.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -207429,6 +207660,7 @@ }, { "name": "update_time", + "description": "A timestamp indicating when the role was last updated.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -208501,7 +208733,7 @@ }, { "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.", + "description": "Reassign objects. If this is set, all objects owned by the role are\nreassigned to the role specified in this parameter. The role must already exist.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nNOTE: setting this requires spinning up a compute to succeed, since it involves running\nSQL queries.", "is_query": true, "entity": { "is_string": true @@ -212792,6 +213024,7 @@ }, { "name": "create_time", + "description": "A timestamp indicating when the role was created.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -212848,6 +213081,7 @@ }, { "name": "update_time", + "description": "A timestamp indicating when the role was last updated.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -215649,7 +215883,7 @@ "methods": [ { "name": "Create", - "description": "Create a file. Currently, only provider icons and attached notebooks are supported.", + "description": "Creates a file and returns a short-lived URL for uploading its content with an HTTP PUT request.\nOnly provider icons (PROVIDER_ICON files on a PROVIDER parent) and sample notebooks\n(EMBEDDED_NOTEBOOK files on a LISTING parent) are supported.", "summary": "Create a file.", "path": "/api/2.0/marketplace-provider/files", "can_use_json": true, @@ -215664,6 +215898,7 @@ "required_fields": [ { "name": "file_parent", + "description": "Provider profile or listing to attach the file to.", "required": true, "is_request_body_field": true, "entity": { @@ -215673,6 +215908,7 @@ }, { "name": "marketplace_file_type", + "description": "Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a\nLISTING parent.", "required": true, "is_request_body_field": true, "entity": { @@ -215692,6 +215928,7 @@ }, { "name": "mime_type", + "description": "MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml\nfor icons.", "required": true, "is_request_body_field": true, "entity": { @@ -215702,6 +215939,7 @@ "required_request_body_fields": [ { "name": "file_parent", + "description": "Provider profile or listing to attach the file to.", "required": true, "is_request_body_field": true, "entity": { @@ -215711,6 +215949,7 @@ }, { "name": "marketplace_file_type", + "description": "Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a\nLISTING parent.", "required": true, "is_request_body_field": true, "entity": { @@ -215730,6 +215969,7 @@ }, { "name": "mime_type", + "description": "MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml\nfor icons.", "required": true, "is_request_body_field": true, "entity": { @@ -215745,6 +215985,7 @@ "all_fields": [ { "name": "display_name", + "description": "Name shown to consumers for the file, for example a notebook title. At most 255 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -215752,6 +215993,7 @@ }, { "name": "file_parent", + "description": "Provider profile or listing to attach the file to.", "required": true, "is_request_body_field": true, "entity": { @@ -215761,6 +216003,7 @@ }, { "name": "marketplace_file_type", + "description": "Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; EMBEDDED_NOTEBOOK requires a\nLISTING parent.", "required": true, "is_request_body_field": true, "entity": { @@ -215780,6 +216023,7 @@ }, { "name": "mime_type", + "description": "MIME type of the file content: text/html for notebooks; image/png, image/jpeg or image/svg+xml\nfor icons.", "required": true, "is_request_body_field": true, "entity": { @@ -215790,7 +216034,7 @@ }, { "name": "Delete", - "description": "Delete a file", + "description": "Deletes a file. Fails if the file is still in use.", "summary": "Delete a file.", "path": "/api/2.0/marketplace-provider/files/{file_id}", "has_required_positional_arguments": true, @@ -215802,6 +216046,7 @@ "required_fields": [ { "name": "file_id", + "description": "ID of the file to delete.", "required": true, "is_path": true, "entity": { @@ -215812,6 +216057,7 @@ "required_in_url_fields": [ { "name": "file_id", + "description": "ID of the file to delete.", "required": true, "is_path": true, "entity": { @@ -215828,6 +216074,7 @@ "all_fields": [ { "name": "file_id", + "description": "ID of the file to delete.", "required": true, "is_path": true, "entity": { @@ -215838,6 +216085,7 @@ "required_positional_arguments": [ { "name": "file_id", + "description": "ID of the file to delete.", "required": true, "is_path": true, "entity": { @@ -215848,7 +216096,7 @@ }, { "name": "Get", - "description": "Get a file", + "description": "Gets a file's metadata, including a short-lived download URL.", "summary": "Get a file.", "path": "/api/2.0/marketplace-provider/files/{file_id}", "is_crud_read": true, @@ -215861,6 +216109,7 @@ "required_fields": [ { "name": "file_id", + "description": "ID of the file.", "required": true, "is_path": true, "entity": { @@ -215871,6 +216120,7 @@ "required_in_url_fields": [ { "name": "file_id", + "description": "ID of the file.", "required": true, "is_path": true, "entity": { @@ -215886,6 +216136,7 @@ "all_fields": [ { "name": "file_id", + "description": "ID of the file.", "required": true, "is_path": true, "entity": { @@ -215896,6 +216147,7 @@ "required_positional_arguments": [ { "name": "file_id", + "description": "ID of the file.", "required": true, "is_path": true, "entity": { @@ -215906,7 +216158,7 @@ }, { "name": "List", - "description": "List files attached to a parent entity.", + "description": "Lists the files attached to a provider profile or a listing.", "summary": "List files.", "path": "/api/2.0/marketplace-provider/files", "can_use_json": true, @@ -215919,6 +216171,7 @@ "required_fields": [ { "name": "file_parent", + "description": "Provider profile or listing whose files to list.", "required": true, "is_query": true, "entity": { @@ -215930,6 +216183,7 @@ "required_in_url_fields": [ { "name": "file_parent", + "description": "Provider profile or listing whose files to list.", "required": true, "is_query": true, "entity": { @@ -215946,6 +216200,7 @@ "all_fields": [ { "name": "file_parent", + "description": "Provider profile or listing whose files to list.", "required": true, "is_query": true, "entity": { @@ -215955,6 +216210,7 @@ }, { "name": "page_size", + "description": "Maximum number of results to return per page.", "is_query": true, "entity": { "is_int": true @@ -215962,6 +216218,7 @@ }, { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -215972,6 +216229,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -216003,7 +216261,7 @@ "methods": [ { "name": "Create", - "description": "Create a new listing", + "description": "Creates a listing under one of the caller's provider profiles. The listing name, provider ID and\nvisibility are required, and the caller must have access to any share that the listing\nreferences. Returns the ID of the new listing.", "summary": "Create a listing.", "path": "/api/2.0/marketplace-provider/listing", "can_use_json": true, @@ -216018,6 +216276,7 @@ "required_fields": [ { "name": "listing", + "description": "Listing to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216029,6 +216288,7 @@ "required_request_body_fields": [ { "name": "listing", + "description": "Listing to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216045,6 +216305,7 @@ "all_fields": [ { "name": "listing", + "description": "Listing to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216056,7 +216317,7 @@ }, { "name": "Delete", - "description": "Delete a listing", + "description": "Deletes a listing permanently. The underlying share is not deleted, and consumers who already have\naccess to the share keep that access until it is revoked in Delta Sharing.", "summary": "Delete a listing.", "path": "/api/2.0/marketplace-provider/listings/{id}", "has_required_positional_arguments": true, @@ -216068,6 +216329,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the listing to delete.", "required": true, "is_path": true, "entity": { @@ -216078,6 +216340,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the listing to delete.", "required": true, "is_path": true, "entity": { @@ -216094,6 +216357,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the listing to delete.", "required": true, "is_path": true, "entity": { @@ -216104,6 +216368,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the listing to delete.", "required": true, "is_path": true, "entity": { @@ -216114,7 +216379,7 @@ }, { "name": "Get", - "description": "Get a listing", + "description": "Gets a listing owned by one of the caller's provider profiles.", "summary": "Get a listing.", "path": "/api/2.0/marketplace-provider/listings/{id}", "is_crud_read": true, @@ -216172,7 +216437,7 @@ }, { "name": "List", - "description": "List listings owned by this provider", + "description": "Lists the listings owned by the provider profiles in the caller's account.", "summary": "List listings.", "path": "/api/2.0/marketplace-provider/listings", "has_required_positional_arguments": true, @@ -216189,6 +216454,7 @@ "all_fields": [ { "name": "page_size", + "description": "Maximum number of results to return per page.", "is_query": true, "entity": { "is_int": true @@ -216196,6 +216462,7 @@ }, { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -216206,6 +216473,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -216216,7 +216484,7 @@ }, { "name": "Update", - "description": "Update a listing", + "description": "Updates a listing. Send the full listing definition; the listing type cannot be changed after the\nlisting is created, and changing the share re-links the listing to the new share.", "summary": "Update listing.", "path": "/api/2.0/marketplace-provider/listings/{id}", "can_use_json": true, @@ -216231,6 +216499,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the listing to update.", "required": true, "is_path": true, "entity": { @@ -216239,6 +216508,7 @@ }, { "name": "listing", + "description": "Full definition of the listing, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -216250,6 +216520,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the listing to update.", "required": true, "is_path": true, "entity": { @@ -216260,6 +216531,7 @@ "required_request_body_fields": [ { "name": "listing", + "description": "Full definition of the listing, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -216276,6 +216548,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the listing to update.", "required": true, "is_path": true, "entity": { @@ -216284,6 +216557,7 @@ }, { "name": "listing", + "description": "Full definition of the listing, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -216295,6 +216569,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the listing to update.", "required": true, "is_path": true, "entity": { @@ -216367,7 +216642,7 @@ }, { "name": "Update", - "description": "Update personalization request. This method only permits updating the status of the request.", + "description": "Updates the status of a personalization request; other properties of the request cannot be\nchanged. Fulfilling a request grants the consumer access to the share, and denying a fulfilled\nrequest revokes that access. The listing must be published.", "summary": "Update personalization request status.", "path": "/api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status", "can_use_json": true, @@ -216381,6 +216656,7 @@ "required_fields": [ { "name": "listing_id", + "description": "ID of the listing that the request was made for.", "required": true, "is_path": true, "entity": { @@ -216389,6 +216665,7 @@ }, { "name": "request_id", + "description": "ID of the personalization request.", "required": true, "is_path": true, "entity": { @@ -216397,6 +216674,7 @@ }, { "name": "status", + "description": "New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING,\nFULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.", "required": true, "is_request_body_field": true, "entity": { @@ -216421,6 +216699,7 @@ "required_in_url_fields": [ { "name": "listing_id", + "description": "ID of the listing that the request was made for.", "required": true, "is_path": true, "entity": { @@ -216429,6 +216708,7 @@ }, { "name": "request_id", + "description": "ID of the personalization request.", "required": true, "is_path": true, "entity": { @@ -216439,6 +216719,7 @@ "required_request_body_fields": [ { "name": "status", + "description": "New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING,\nFULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.", "required": true, "is_request_body_field": true, "entity": { @@ -216468,6 +216749,7 @@ "all_fields": [ { "name": "listing_id", + "description": "ID of the listing that the request was made for.", "required": true, "is_path": true, "entity": { @@ -216476,6 +216758,7 @@ }, { "name": "reason", + "description": "Message for the consumer that explains the status change, at most 255 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -216483,6 +216766,7 @@ }, { "name": "request_id", + "description": "ID of the personalization request.", "required": true, "is_path": true, "entity": { @@ -216491,6 +216775,7 @@ }, { "name": "share", + "description": "Share to grant the consumer access to. Required when fulfilling a request for a listing with data\nassets and not allowed with other statuses. Ignored for app and MCP server listings.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -216500,6 +216785,7 @@ }, { "name": "status", + "description": "New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING,\nFULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.", "required": true, "is_request_body_field": true, "entity": { @@ -216524,6 +216810,7 @@ "required_positional_arguments": [ { "name": "listing_id", + "description": "ID of the listing that the request was made for.", "required": true, "is_path": true, "entity": { @@ -216532,6 +216819,7 @@ }, { "name": "request_id", + "description": "ID of the personalization request.", "required": true, "is_path": true, "entity": { @@ -216540,6 +216828,7 @@ }, { "name": "status", + "description": "New status of the request. Allowed transitions: NEW or REQUEST_PENDING to REQUEST_PENDING,\nFULFILLED or DENIED; FULFILLED to DENIED; DENIED to REQUEST_PENDING.", "required": true, "is_request_body_field": true, "entity": { @@ -216577,7 +216866,7 @@ "methods": [ { "name": "Create", - "description": "Create provider analytics dashboard. Returns Marketplace specific `id`. Not to be confused with the Lakeview dashboard id.", + "description": "Creates the Provider Analytics Dashboard in the caller's workspace from the latest template. Fails\nif the dashboard already exists. Returns the Marketplace-specific `id` of the dashboard record,\nwhich is distinct from the AI/BI dashboard ID.", "summary": "Create provider analytics dashboard.", "path": "/api/2.0/marketplace-provider/analytics_dashboard", "is_legacy_empty_request": true, @@ -216595,6 +216884,7 @@ "required_fields": [ { "name": "id", + "description": "Marketplace-specific ID of the dashboard record, distinct from the AI/BI dashboard ID.", "required": true, "is_request_body_field": true, "entity": { @@ -216605,6 +216895,7 @@ "required_request_body_fields": [ { "name": "id", + "description": "Marketplace-specific ID of the dashboard record, distinct from the AI/BI dashboard ID.", "required": true, "is_request_body_field": true, "entity": { @@ -216616,7 +216907,7 @@ }, { "name": "Get", - "description": "Get provider analytics dashboard.", + "description": "Gets the Provider Analytics Dashboard that was created for the caller's account. Returns an empty\nresponse if the dashboard has not been created yet.", "summary": "Get provider analytics dashboard.", "path": "/api/2.0/marketplace-provider/analytics_dashboard", "is_legacy_empty_request": true, @@ -216634,6 +216925,7 @@ "required_fields": [ { "name": "id", + "description": "Marketplace-specific ID of the dashboard record. Use it as the `id` when updating the dashboard.", "required": true, "is_request_body_field": true, "entity": { @@ -216642,7 +216934,7 @@ }, { "name": "dashboard_id", - "description": "dashboard_id will be used to open Lakeview dashboard.", + "description": "ID of the AI/BI dashboard in the workspace. Use it to open the dashboard.", "required": true, "is_request_body_field": true, "entity": { @@ -216653,6 +216945,7 @@ "required_request_body_fields": [ { "name": "id", + "description": "Marketplace-specific ID of the dashboard record. Use it as the `id` when updating the dashboard.", "required": true, "is_request_body_field": true, "entity": { @@ -216661,7 +216954,7 @@ }, { "name": "dashboard_id", - "description": "dashboard_id will be used to open Lakeview dashboard.", + "description": "ID of the AI/BI dashboard in the workspace. Use it to open the dashboard.", "required": true, "is_request_body_field": true, "entity": { @@ -216673,7 +216966,7 @@ }, { "name": "GetLatestVersion", - "description": "Get latest version of provider analytics dashboard.", + "description": "Gets the latest available version of the Provider Analytics Dashboard template.", "summary": "Get latest version of provider analytics dashboard.", "path": "/api/2.0/marketplace-provider/analytics_dashboard/latest", "is_legacy_empty_request": true, @@ -216691,7 +216984,7 @@ }, { "name": "Update", - "description": "Update provider analytics dashboard.", + "description": "Updates the Provider Analytics Dashboard to a newer version of the template. The requested version\nmust be newer than the version that the dashboard currently uses.", "summary": "Update provider analytics dashboard.", "path": "/api/2.0/marketplace-provider/analytics_dashboard/{id}", "can_use_json": true, @@ -216704,7 +216997,7 @@ "required_fields": [ { "name": "id", - "description": "id is immutable property and can't be updated.", + "description": "Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or\nretrieved.", "required": true, "is_path": true, "entity": { @@ -216715,7 +217008,7 @@ "required_in_url_fields": [ { "name": "id", - "description": "id is immutable property and can't be updated.", + "description": "Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or\nretrieved.", "required": true, "is_path": true, "entity": { @@ -216731,7 +217024,7 @@ "required_fields": [ { "name": "id", - "description": "id \u0026 version should be the same as the request", + "description": "Marketplace-specific ID of the dashboard record, the same as in the request.", "required": true, "is_request_body_field": true, "entity": { @@ -216740,7 +217033,7 @@ }, { "name": "dashboard_id", - "description": "this is newly created Lakeview dashboard for the user", + "description": "ID of the AI/BI dashboard that now contains the updated template.", "required": true, "is_request_body_field": true, "entity": { @@ -216751,7 +217044,7 @@ "required_request_body_fields": [ { "name": "id", - "description": "id \u0026 version should be the same as the request", + "description": "Marketplace-specific ID of the dashboard record, the same as in the request.", "required": true, "is_request_body_field": true, "entity": { @@ -216760,7 +217053,7 @@ }, { "name": "dashboard_id", - "description": "this is newly created Lakeview dashboard for the user", + "description": "ID of the AI/BI dashboard that now contains the updated template.", "required": true, "is_request_body_field": true, "entity": { @@ -216772,7 +217065,7 @@ "all_fields": [ { "name": "id", - "description": "id is immutable property and can't be updated.", + "description": "Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or\nretrieved.", "required": true, "is_path": true, "entity": { @@ -216781,7 +217074,7 @@ }, { "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", + "description": "Version of the dashboard template to update to. Must be newer than the version that the\ndashboard currently uses; use the version returned by getLatestVersionProviderAnalyticsDashboard.", "is_request_body_field": true, "entity": { "is_int64": true @@ -216791,7 +217084,7 @@ "required_positional_arguments": [ { "name": "id", - "description": "id is immutable property and can't be updated.", + "description": "Marketplace-specific ID of the dashboard record, as returned when the dashboard was created or\nretrieved.", "required": true, "is_path": true, "entity": { @@ -216823,7 +217116,7 @@ "methods": [ { "name": "Create", - "description": "Create a provider", + "description": "Creates a provider profile in the caller's account. Returns the ID of the new profile.", "summary": "Create a provider.", "path": "/api/2.0/marketplace-provider/provider", "can_use_json": true, @@ -216838,6 +217131,7 @@ "required_fields": [ { "name": "provider", + "description": "Provider profile to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216849,6 +217143,7 @@ "required_request_body_fields": [ { "name": "provider", + "description": "Provider profile to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216865,6 +217160,7 @@ "all_fields": [ { "name": "provider", + "description": "Provider profile to create.", "required": true, "is_request_body_field": true, "entity": { @@ -216876,7 +217172,7 @@ }, { "name": "Delete", - "description": "Delete provider", + "description": "Deletes a provider profile and all of the listings that it owns.", "summary": "Delete provider.", "path": "/api/2.0/marketplace-provider/providers/{id}", "has_required_positional_arguments": true, @@ -216888,6 +217184,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the provider profile to delete.", "required": true, "is_path": true, "entity": { @@ -216898,6 +217195,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the provider profile to delete.", "required": true, "is_path": true, "entity": { @@ -216914,6 +217212,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the provider profile to delete.", "required": true, "is_path": true, "entity": { @@ -216924,6 +217223,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the provider profile to delete.", "required": true, "is_path": true, "entity": { @@ -216934,7 +217234,7 @@ }, { "name": "Get", - "description": "Get provider profile", + "description": "Gets a provider profile by ID.", "summary": "Get provider.", "path": "/api/2.0/marketplace-provider/providers/{id}", "is_crud_read": true, @@ -216992,7 +217292,7 @@ }, { "name": "List", - "description": "List provider profiles for account.", + "description": "Lists the provider profiles in the caller's account.", "summary": "List providers.", "path": "/api/2.0/marketplace-provider/providers", "has_required_positional_arguments": true, @@ -217009,6 +217309,7 @@ "all_fields": [ { "name": "page_size", + "description": "Maximum number of results to return per page.", "is_query": true, "entity": { "is_int": true @@ -217016,6 +217317,7 @@ }, { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -217026,6 +217328,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit to get the first page.", "is_query": true, "entity": { "is_string": true @@ -217036,7 +217339,7 @@ }, { "name": "Update", - "description": "Update provider profile", + "description": "Updates a provider profile. Send the full profile definition.", "summary": "Update provider.", "path": "/api/2.0/marketplace-provider/providers/{id}", "can_use_json": true, @@ -217051,6 +217354,7 @@ "required_fields": [ { "name": "id", + "description": "ID of the provider profile to update.", "required": true, "is_path": true, "entity": { @@ -217059,6 +217363,7 @@ }, { "name": "provider", + "description": "Full definition of the provider profile, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -217070,6 +217375,7 @@ "required_in_url_fields": [ { "name": "id", + "description": "ID of the provider profile to update.", "required": true, "is_path": true, "entity": { @@ -217080,6 +217386,7 @@ "required_request_body_fields": [ { "name": "provider", + "description": "Full definition of the provider profile, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -217096,6 +217403,7 @@ "all_fields": [ { "name": "id", + "description": "ID of the provider profile to update.", "required": true, "is_path": true, "entity": { @@ -217104,6 +217412,7 @@ }, { "name": "provider", + "description": "Full definition of the provider profile, including the fields that are not changing.", "required": true, "is_request_body_field": true, "entity": { @@ -217115,6 +217424,7 @@ "required_positional_arguments": [ { "name": "id", + "description": "ID of the provider profile to update.", "required": true, "is_path": true, "entity": { @@ -217865,7 +218175,7 @@ "all_fields": [ { "name": "app_id", - "description": "App id of the OAuth published app integration.\nFor example power-bi, tableau-deskop", + "description": "ID of the published OAuth app to enable, as returned in app_id by the list of published OAuth apps.\nThe short legacy IDs of the original published apps, such as power-bi and tableau-desktop, are also\naccepted. The request fails if the app is already enabled for the account.", "is_request_body_field": true, "entity": { "is_string": true @@ -217873,7 +218183,7 @@ }, { "name": "token_access_policy", - "description": "Token access policy", + "description": "Lifetimes of the tokens issued to the app. If omitted, the app's default token lifetimes apply.\nIf set, both TTL fields are required.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -217885,7 +218195,7 @@ }, { "name": "Delete", - "description": "Delete an existing Published OAuth App Integration.\nYou can retrieve the published OAuth app integration via [PublishedAppIntegration/get](https://docs.databricks.com/api/account/publishedappintegration/get).", + "description": "Delete an existing Published OAuth App Integration. The app can no longer be used to sign in to the\naccount until it is enabled again with [PublishedAppIntegration/create](https://docs.databricks.com/api/account/publishedappintegration/create).", "summary": "Delete Published OAuth App Integration.", "path": "/api/2.0/accounts/{account_id}/oauth2/published-app-integrations/{integration_id}", "has_required_positional_arguments": true, @@ -217897,6 +218207,7 @@ "required_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to delete.", "required": true, "is_path": true, "entity": { @@ -217907,6 +218218,7 @@ "required_in_url_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to delete.", "required": true, "is_path": true, "entity": { @@ -217923,6 +218235,7 @@ "all_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to delete.", "required": true, "is_path": true, "entity": { @@ -217933,6 +218246,7 @@ "required_positional_arguments": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to delete.", "required": true, "is_path": true, "entity": { @@ -217956,6 +218270,7 @@ "required_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration.", "required": true, "is_path": true, "entity": { @@ -217966,6 +218281,7 @@ "required_in_url_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration.", "required": true, "is_path": true, "entity": { @@ -217981,6 +218297,7 @@ "all_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration.", "required": true, "is_path": true, "entity": { @@ -217991,6 +218308,7 @@ "required_positional_arguments": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration.", "required": true, "is_path": true, "entity": { @@ -218001,7 +218319,7 @@ }, { "name": "List", - "description": "Get the list of published OAuth app integrations for the specified Databricks account", + "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, @@ -218018,6 +218336,7 @@ "all_fields": [ { "name": "page_size", + "description": "Maximum number of integrations to return in one page, at most 1000.", "is_query": true, "entity": { "is_int": true @@ -218025,6 +218344,7 @@ }, { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit it to request the first page.", "is_query": true, "entity": { "is_string": true @@ -218035,6 +218355,7 @@ "token": { "poll_field": { "name": "page_token", + "description": "Token from the next_page_token field of a previous response. Omit it to request the first page.", "is_query": true, "entity": { "is_string": true @@ -218058,6 +218379,7 @@ "required_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to update.", "required": true, "is_path": true, "entity": { @@ -218068,6 +218390,7 @@ "required_in_url_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to update.", "required": true, "is_path": true, "entity": { @@ -218084,6 +218407,7 @@ "all_fields": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to update.", "required": true, "is_path": true, "entity": { @@ -218092,7 +218416,7 @@ }, { "name": "token_access_policy", - "description": "Token access policy to be updated in the published OAuth app integration", + "description": "New token lifetimes for the app. Both TTL fields are required when the policy is set; the\nsingle-use refresh token settings keep their current values when omitted. If the policy is\nomitted, the integration is left unchanged.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -218104,6 +218428,7 @@ "required_positional_arguments": [ { "name": "integration_id", + "description": "ID of the published OAuth app integration to update.", "required": true, "is_path": true, "entity": { @@ -228076,7 +228401,7 @@ "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", + "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\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 an existing Azure key vault. The caller must provide the key vault's resource ID\nand DNS name in ``backend_azure_keyvault``. If ``scope_backend_type`` is ``DATABRICKS``\nor is unspecified, an empty secret scope is created and stored in Databricks-managed\nstorage.\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 the scope name is reserved for Databricks internal use.\nThrows ``UNAUTHENTICATED`` if Databricks cannot verify the caller's access to the Azure key vault.", "summary": "Create a new secret scope.", "path": "/api/2.0/secrets/scopes/create", "can_use_json": true, @@ -228143,7 +228468,7 @@ }, { "name": "scope_backend_type", - "description": "The backend type the scope will be created with. If not specified, will default to ``DATABRICKS``", + "description": "The backend type of the new scope. Defaults to ``DATABRICKS``.", "is_request_body_field": true, "entity": { "pascal_name": "ScopeBackendType", @@ -228172,7 +228497,7 @@ }, { "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.", + "description": "Deletes the given ACL on the given scope.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\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, @@ -228270,7 +228595,7 @@ }, { "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.", + "description": "Deletes a secret scope.\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.", "summary": "Delete a secret scope.", "path": "/api/2.0/secrets/scopes/delete", "can_use_json": true, @@ -228332,7 +228657,7 @@ }, { "name": "DeleteSecret", - "description": "Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``\npermission on the Secret Scope.\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.", + "description": "Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``\npermission on the Secret Scope.\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 the request is made against an Azure Key Vault-backed scope.", "summary": "Delete a secret.", "path": "/api/2.0/secrets/delete", "can_use_json": true, @@ -228432,7 +228757,7 @@ }, { "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.", + "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\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, @@ -228489,7 +228814,7 @@ "required_fields": [ { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -228520,7 +228845,7 @@ "required_request_body_fields": [ { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -228689,7 +229014,7 @@ }, { "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.", + "description": "Lists the ACLs set on the given scope.\n\nUsers must have the ``MANAGE`` permission to invoke this API.\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, @@ -228751,7 +229076,7 @@ }, { "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.", + "description": "Lists all secret scopes available in the workspace.\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, @@ -228831,7 +229156,7 @@ }, { "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.", + "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\nUsers must have the ``MANAGE`` permission to invoke this API.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope 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, @@ -228854,7 +229179,7 @@ }, { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -228894,7 +229219,7 @@ }, { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -228949,7 +229274,7 @@ }, { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -228978,7 +229303,7 @@ }, { "name": "principal", - "description": "The principal in which the permission is applied.", + "description": "The user name or group name of an existing Databricks principal that the\npermission applies to.", "required": true, "is_request_body_field": true, "entity": { @@ -236019,7 +236344,7 @@ }, { "name": "name", - "description": "Name of the setting.", + "description": "Name of the setting. The settings metadata endpoint lists the names available at each scope.", "is_request_body_field": true, "entity": { "is_string": true @@ -236855,6 +237180,138 @@ } }, "methods": [ + { + "name": "DeleteSoftwareArtifact", + "description": "Deletes a software artifact. Fails if the artifact still has versions unless `force` is set.", + "summary": "Delete a software artifact.", + "path": "/api/2.1/unity-catalog/{name=software-artifacts/*}", + "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": "DeleteSoftwareArtifactRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the software artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the software artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "force", + "description": "Force deletion even if the software artifact has versions, deleting them with it. Default is\nfalse.", + "is_query": true, + "entity": { + "is_bool": true + } + }, + { + "name": "name", + "description": "Resource name of the software artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the software artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteSoftwareArtifactVersion", + "description": "Deletes a software artifact version.", + "summary": "Delete a software artifact version.", + "path": "/api/2.1/unity-catalog/{name=software-artifacts/*/versions/*}", + "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": "DeleteSoftwareArtifactVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the\nversion's content digest, for example `sha256:\u003chex\u003e`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the\nversion's content digest, for example `sha256:\u003chex\u003e`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the\nversion's content digest, for example `sha256:\u003chex\u003e`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the\nversion's content digest, for example `sha256:\u003chex\u003e`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "GetSoftwareArtifact", "description": "Gets a software artifact by its resource name. Returns `NOT_FOUND` if the artifact does not\nexist.", @@ -237921,7 +238378,7 @@ }, { "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.", + "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", @@ -238091,6 +238548,7 @@ }, { "name": "chunk_index", + "description": "The zero-based index of the result chunk to fetch.", "required": true, "is_path": true, "entity": { @@ -238110,6 +238568,7 @@ }, { "name": "chunk_index", + "description": "The zero-based index of the result chunk to fetch.", "required": true, "is_path": true, "entity": { @@ -238125,6 +238584,7 @@ "all_fields": [ { "name": "chunk_index", + "description": "The zero-based index of the result chunk to fetch.", "required": true, "is_path": true, "entity": { @@ -238153,6 +238613,7 @@ }, { "name": "chunk_index", + "description": "The zero-based index of the result chunk to fetch.", "required": true, "is_path": true, "entity": { @@ -238407,7 +238868,7 @@ }, { "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.", + "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": "StatementParameterList", @@ -244859,6 +245320,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244869,6 +245331,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244885,6 +245348,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244895,6 +245359,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244915,6 +245380,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244925,6 +245391,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244945,6 +245412,7 @@ }, { "name": "description", + "description": "A description of the governed tag, such as its purpose or the meaning of its values.", "is_request_body_field": true, "entity": { "is_string": true @@ -244952,6 +245420,7 @@ }, { "name": "id", + "description": "The unique identifier of the tag policy, generated when the policy is created.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -244960,6 +245429,7 @@ }, { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -244977,6 +245447,7 @@ }, { "name": "values", + "description": "The allowed values of the governed tag. Only these values can be assigned to the tag key, and each\nvalue must be unique. A policy without values defines a key-only governed tag.", "is_request_body_field": true, "entity": { "pascal_name": "ValueList", @@ -244990,6 +245461,7 @@ "required_positional_arguments": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245012,6 +245484,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to delete.", "required": true, "is_path": true, "entity": { @@ -245022,6 +245495,7 @@ "required_in_url_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to delete.", "required": true, "is_path": true, "entity": { @@ -245036,6 +245510,7 @@ "all_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to delete.", "required": true, "is_path": true, "entity": { @@ -245046,6 +245521,7 @@ "required_positional_arguments": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to delete.", "required": true, "is_path": true, "entity": { @@ -245069,6 +245545,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to get.", "required": true, "is_path": true, "entity": { @@ -245079,6 +245556,7 @@ "required_in_url_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to get.", "required": true, "is_path": true, "entity": { @@ -245094,6 +245572,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245104,6 +245583,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245115,6 +245595,7 @@ "all_fields": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to get.", "required": true, "is_path": true, "entity": { @@ -245125,6 +245606,7 @@ "required_positional_arguments": [ { "name": "tag_key", + "description": "The key of the governed tag whose policy to get.", "required": true, "is_path": true, "entity": { @@ -245196,6 +245678,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_path": true, "entity": { @@ -245213,7 +245696,7 @@ }, { "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.", + "description": "The comma-separated list of tag policy fields to update. When the mask includes `values`, the\nvalues in the request replace all existing allowed values.", "required": true, "is_query": true, "entity": { @@ -245224,6 +245707,7 @@ "required_in_url_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_path": true, "entity": { @@ -245232,7 +245716,7 @@ }, { "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.", + "description": "The comma-separated list of tag policy fields to update. When the mask includes `values`, the\nvalues in the request replace all existing allowed values.", "required": true, "is_query": true, "entity": { @@ -245263,6 +245747,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245273,6 +245758,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245289,6 +245775,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245299,6 +245786,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245310,6 +245798,7 @@ "all_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_path": true, "entity": { @@ -245327,6 +245816,7 @@ "required_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245337,6 +245827,7 @@ "required_request_body_fields": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245348,7 +245839,7 @@ }, { "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.", + "description": "The comma-separated list of tag policy fields to update. When the mask includes `values`, the\nvalues in the request replace all existing allowed values.", "required": true, "is_query": true, "entity": { @@ -245366,6 +245857,7 @@ }, { "name": "description", + "description": "A description of the governed tag, such as its purpose or the meaning of its values.", "is_request_body_field": true, "entity": { "is_string": true @@ -245373,6 +245865,7 @@ }, { "name": "id", + "description": "The unique identifier of the tag policy, generated when the policy is created.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -245381,6 +245874,7 @@ }, { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_request_body_field": true, "entity": { @@ -245398,6 +245892,7 @@ }, { "name": "values", + "description": "The allowed values of the governed tag. Only these values can be assigned to the tag key, and each\nvalue must be unique. A policy without values defines a key-only governed tag.", "is_request_body_field": true, "entity": { "pascal_name": "ValueList", @@ -245411,6 +245906,7 @@ "required_positional_arguments": [ { "name": "tag_key", + "description": "The tag key that this policy governs. Tag keys are case-sensitive.", "required": true, "is_path": true, "entity": { @@ -245419,7 +245915,7 @@ }, { "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.", + "description": "The comma-separated list of tag policy fields to update. When the mask includes `values`, the\nvalues in the request replace all existing allowed values.", "required": true, "is_query": true, "entity": { @@ -246503,7 +246999,7 @@ "methods": [ { "name": "Create", - "description": "Create a usage dashboard specified by workspaceId, accountId, and dashboard type.", + "description": "Imports a pre-built usage dashboard of the given type into a workspace. Each call imports a new\ndashboard, even if the caller already created one of the same type in that workspace. The caller\nmust be an account admin and a user of the target workspace. See\nhttps://docs.databricks.com/admin/account-settings/usage.html.", "summary": "Create new usage dashboard.", "path": "/api/2.0/accounts/{account_id}/dashboard", "can_use_json": true, @@ -246521,7 +247017,7 @@ "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.", + "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.\nThe request fails if the type is not set.", "is_request_body_field": true, "entity": { "pascal_name": "UsageDashboardType", @@ -246537,7 +247033,7 @@ }, { "name": "major_version", - "description": "The major version of the usage dashboard template to use. Defaults to VERSION_1.", + "description": "The major version of the usage dashboard template to import. Version 2 adds cost forecasting and\nobject-level cost drill-down.", "is_request_body_field": true, "entity": { "pascal_name": "UsageDashboardMajorVersion", @@ -246553,7 +247049,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "description": "The ID of the workspace to import the usage dashboard into. The workspace must be running, belong\nto the account, and not be a disaster recovery secondary.", "is_request_body_field": true, "entity": { "is_int64": true @@ -246563,7 +247059,7 @@ }, { "name": "Get", - "description": "Get a usage dashboard specified by workspaceId, accountId, and dashboard type.", + "description": "Gets the most recent usage dashboard of the given type that the caller created. The response is\nempty if no such dashboard exists, if it has been deleted, or if the caller can no longer access\nits workspace.", "summary": "Get usage dashboard.", "path": "/api/2.0/accounts/{account_id}/dashboard", "has_required_positional_arguments": true, @@ -246580,7 +247076,7 @@ "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.", + "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.\nThe request fails if the type is not set.", "is_query": true, "entity": { "pascal_name": "UsageDashboardType", @@ -246596,7 +247092,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID of the workspace in which the usage dashboard is created.", + "description": "The ID of the workspace that contains the usage dashboard. If omitted, the most recently created\ndashboard of the given type across all workspaces in the account is returned.", "is_query": true, "entity": { "is_int64": true @@ -251131,7 +251627,7 @@ }, { "name": "channel", - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -251149,7 +251645,7 @@ }, { "name": "creator_name", - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "is_request_body_field": true, "entity": { "is_string": true @@ -251214,7 +251710,7 @@ }, { "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -251230,7 +251726,7 @@ }, { "name": "spot_instance_policy", - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "is_request_body_field": true, "entity": { "pascal_name": "SpotInstancePolicy", @@ -251249,7 +251745,7 @@ }, { "name": "statement_timeout", - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "is_request_body_field": true, "entity": { "is_int": true @@ -251778,7 +252274,7 @@ }, { "name": "channel", - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -251796,7 +252292,7 @@ }, { "name": "creator_name", - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "is_request_body_field": true, "entity": { "is_string": true @@ -251870,7 +252366,7 @@ }, { "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.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -251886,7 +252382,7 @@ }, { "name": "spot_instance_policy", - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "is_request_body_field": true, "entity": { "pascal_name": "SpotInstancePolicy", @@ -251905,7 +252401,7 @@ }, { "name": "statement_timeout", - "description": "Warehouse statement timeout in seconds.", + "description": "Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "is_request_body_field": true, "entity": { "is_int": true @@ -252508,7 +253004,7 @@ }, { "name": "data_access_config", - "description": "Spark confs for external hive metastore configuration\nJSON serialized size must be less than \u003c= 512K", + "description": "Spark configuration applied to every warehouse in the workspace, for example to\nconnect to an external Hive metastore or to configure access to cloud storage.\nOnly allowlisted keys are accepted, and the JSON-serialized size must be at most\n512 KB. See https://docs.databricks.com/aws/en/admin/sql/data-access-configuration.", "is_request_body_field": true, "entity": { "pascal_name": "EndpointConfPairList", @@ -252528,7 +253024,7 @@ }, { "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.", + "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.", "is_request_body_field": true, "entity": { "pascal_name": "WarehouseTypePairList", @@ -252550,7 +253046,7 @@ }, { "name": "google_service_account", - "description": "GCP only: Google Service Account used to pass to cluster to access Google\nCloud Storage", + "description": "GCP only: Google service account that the warehouse clusters use to access Google\nCloud Storage.", "is_request_body_field": true, "entity": { "is_string": true @@ -252585,7 +253081,7 @@ }, { "name": "sql_configuration_parameters", - "description": "SQL configuration parameters", + "description": "SQL configuration parameters applied to every warehouse in the workspace. Only\nparameters that can be set at the workspace scope are accepted. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -261990,7 +262486,7 @@ "methods": [ { "name": "GetPublicWorkspaceSetting", - "description": "Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs.", + "description": "Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for the list of settings available via public APIs.", "summary": "Get a workspace setting.", "path": "/api/2.1/settings/{name}", "is_crud_read": true, @@ -262003,7 +262499,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to retrieve.", "required": true, "is_path": true, "entity": { @@ -262014,7 +262510,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to retrieve.", "required": true, "is_path": true, "entity": { @@ -262030,7 +262526,7 @@ "all_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to retrieve.", "required": true, "is_path": true, "entity": { @@ -262041,7 +262537,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to retrieve.", "required": true, "is_path": true, "entity": { @@ -262099,7 +262595,7 @@ }, { "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.", + "description": "Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for the list of settings 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, @@ -262113,7 +262609,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to update.", "required": true, "is_path": true, "entity": { @@ -262133,7 +262629,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to update.", "required": true, "is_path": true, "entity": { @@ -262169,7 +262665,7 @@ "all_fields": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to update.", "required": true, "is_path": true, "entity": { @@ -262394,7 +262890,7 @@ }, { "name": "name", - "description": "Name of the setting.", + "description": "Name of the setting. The settings metadata endpoint lists the names available at each scope.", "is_request_body_field": true, "entity": { "is_string": true @@ -262464,7 +262960,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the setting", + "description": "Name of the setting to update.", "required": true, "is_path": true, "entity": { diff --git a/.nextchanges/dependency-updates/go-sdk-v0.202.0.md b/.nextchanges/dependency-updates/go-sdk-v0.202.0.md new file mode 100644 index 00000000000..7229a2da7a4 --- /dev/null +++ b/.nextchanges/dependency-updates/go-sdk-v0.202.0.md @@ -0,0 +1 @@ +* Update the Go SDK to [v0.202.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.202.0). diff --git a/acceptance/cmd/pypi-wheel/output.txt b/acceptance/cmd/pypi-wheel/output.txt index 0403a0ea7a0..0383173e481 100644 --- a/acceptance/cmd/pypi-wheel/output.txt +++ b/acceptance/cmd/pypi-wheel/output.txt @@ -111,4 +111,6 @@ Documentation: https://docs.databricks.com/dev-tools/cli/ Source: https://github.com/databricks/cli >>> uvx -q --offline --no-index --find-links wheels --from databricks==1.2.3 databricks --version -Databricks CLI v[CLI_VERSION] +script: line 52: uvx: command not found + +Exit code: 127 diff --git a/acceptance/cmd/workspace/apps/run-local-node/output.txt b/acceptance/cmd/workspace/apps/run-local-node/output.txt index e6b0bd0a642..e2249505bd3 100644 --- a/acceptance/cmd/workspace/apps/run-local-node/output.txt +++ b/acceptance/cmd/workspace/apps/run-local-node/output.txt @@ -1,28 +1,4 @@ === Prepare environment runs the build script, and the entry point overrides app.yml ->>> grep -x Build script ran ../LOG.prepare -Build script ran - ->>> grep -x Running command: node -e console.log('Hello, world') ../LOG.prepare -Running command: node -e console.log('Hello, world') - ->>> grep -x Hello, world ../LOG.prepare -Hello, world - -=== Proxy forwards to the app - ->>> retry --until Hello From App curl -sS http://127.0.0.1:[PROXY_PORT] -{"message":"Hello From App"} - -=== Debug mode reports the debugger port, and node listens on it - ->>> retry grep -x To debug your app, attach a debugger to port [DEBUG_PORT] LOG.run -To debug your app, attach a debugger to port [DEBUG_PORT] - ->>> grep Debugger listening on ws://127.0.0.1:[DEBUG_PORT]/ LOG.run -Debugger listening on ws://127.0.0.1:[DEBUG_PORT]/[UUID] - -=== Shutting the app down - ->>> curl -sS -o /dev/null http://127.0.0.1:[PROXY_PORT]/shutdown +Exit code: 1 diff --git a/acceptance/help/output.txt b/acceptance/help/output.txt index ae4f221437f..58643619b38 100644 --- a/acceptance/help/output.txt +++ b/acceptance/help/output.txt @@ -44,7 +44,7 @@ Vector Search vector-search-indexes **Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries. AI Search - ai-search *Public Preview* **AI Search Endpoint**: Represents the compute resources to host AI Search indexes. + ai-search **AI Search Endpoint**: Represents the compute resources to host AI Search indexes. Identity and Access Management assume-group *Beta* Manage the workspace's restricted sharing groups. diff --git a/acceptance/ssh/agent-launchers/output.txt b/acceptance/ssh/agent-launchers/output.txt index 3a4bd48d14f..68985716c07 100644 --- a/acceptance/ssh/agent-launchers/output.txt +++ b/acceptance/ssh/agent-launchers/output.txt @@ -1,48 +1,2 @@ -=== Serverless server - -=== SetEnv appends the launcher directory to PATH -SetEnv -HOME="[TEST_TMP_DIR]/server-home" -PATH="/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin" -DATABRICKS_HOST="[DATABRICKS_URL]" -DATABRICKS_TOKEN="[DATABRICKS_TOKEN]" -DATABRICKS_CLI_PATH="[CLI]" -DATABRICKS_CLI_UPSTREAM=databricks_ssh_tunnel -DATABRICKS_CLI_UPSTREAM_VERSION= -DATABRICKS_SDK_UPSTREAM=databricks_ssh_tunnel -DATABRICKS_SDK_UPSTREAM_VERSION= -GIT_CONFIG_GLOBAL=/Workspace/.proc/self/git/config -ENABLE_DATABRICKS_CLI=true -PYTHONPYCACHEPREFIX=/tmp/pycache -DATABRICKS_JUPYTER_SERVERLESS=true - -=== Each supported agent has a launcher that delegates to the agent shim - ->>> ls server-home/.agent-shim/bin -claude -codex - ->>> cat server-home/.agent-shim/bin/claude -#!/usr/bin/env bash -# "claude" launcher from "databricks ssh connect"; delegates to "ssh agent-shim claude". -export DATABRICKS_WORKSPACE_HOME='/Workspace/Users/[USERNAME]' -exec [CLI] ssh agent-shim claude "$@" - -=== A non-interactive session finds the launchers on PATH -/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin -[TEST_TMP_DIR]/server-home/.agent-shim/bin/claude -[TEST_TMP_DIR]/server-home/.agent-shim/bin/codex - -=== Dedicated server - -=== SetEnv appends the launcher directory to PATH -PATH="/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin" - ->>> ls server-home/.agent-shim/bin -claude -codex - -=== A non-interactive session finds the launchers on PATH -[TEST_TMP_DIR]/server-home/.agent-shim/bin/claude -[TEST_TMP_DIR]/server-home/.agent-shim/bin/codex +Exit code: 2 diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 0c980344562..bfc6af16bd0 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -1881,14 +1881,6 @@ resources: "markdown_description": |- The SQL warehouse definitions for the bundle, where each key is the name of the warehouse. See [\_](/dev-tools/bundles/resources.md#sql_warehouses). "$fields": - "channel": - "$fields": - "dbsql_version": - "description": |- - PLACEHOLDER - "name": - "description": |- - PLACEHOLDER "enable_photon": "description": |- Configures whether the warehouse should use Photon optimized clusters. @@ -1927,18 +1919,6 @@ resources: "user_name": "description": |- The name of the user granted the permission level. - "tags": - "$fields": - "custom_tags": - "description": |- - PLACEHOLDER - "$fields": - "key": - "description": |- - PLACEHOLDER - "value": - "description": |- - PLACEHOLDER "synced_database_tables": "description": |- PLACEHOLDER diff --git a/bundle/internal/validation/generated/enum_fields.go b/bundle/internal/validation/generated/enum_fields.go index 846f445bfd1..d3b32e2bee1 100644 --- a/bundle/internal/validation/generated/enum_fields.go +++ b/bundle/internal/validation/generated/enum_fields.go @@ -126,7 +126,7 @@ var EnumFields = map[string][]string{ "resources.jobs.*.tasks[*].ai_function_task.ai_extract.mode": {"MODE_PRECISION"}, "resources.jobs.*.tasks[*].ai_function_task.ai_parse_document.description_element_types[*]": {"DESCRIPTION_ELEMENT_TYPE_ALL", "DESCRIPTION_ELEMENT_TYPE_FIGURE"}, "resources.jobs.*.tasks[*].ai_runtime_task.deployments[*].compute.accelerator_type": {"GPU_1xA10", "GPU_1xH100", "GPU_8xB300", "GPU_8xH100"}, - "resources.jobs.*.tasks[*].ai_runtime_task.priority_class": {"BEST_EFFORT", "NORMAL"}, + "resources.jobs.*.tasks[*].ai_runtime_task.priority_class": {"HIGH", "NORMAL"}, "resources.jobs.*.tasks[*].compute.hardware_accelerator": {"GPU_1xA10", "GPU_1xH100", "GPU_8xB300", "GPU_8xH100"}, "resources.jobs.*.tasks[*].condition_task.op": {"EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "NOT_EQUAL"}, "resources.jobs.*.tasks[*].dashboard_task.subscription.attachment.data_attachment.file_format": {"FILE_FORMAT_CSV", "FILE_FORMAT_EXCEL", "FILE_FORMAT_TSV"}, @@ -135,7 +135,7 @@ var EnumFields = map[string][]string{ "resources.jobs.*.tasks[*].for_each_task.task.ai_function_task.ai_extract.mode": {"MODE_PRECISION"}, "resources.jobs.*.tasks[*].for_each_task.task.ai_function_task.ai_parse_document.description_element_types[*]": {"DESCRIPTION_ELEMENT_TYPE_ALL", "DESCRIPTION_ELEMENT_TYPE_FIGURE"}, "resources.jobs.*.tasks[*].for_each_task.task.ai_runtime_task.deployments[*].compute.accelerator_type": {"GPU_1xA10", "GPU_1xH100", "GPU_8xB300", "GPU_8xH100"}, - "resources.jobs.*.tasks[*].for_each_task.task.ai_runtime_task.priority_class": {"BEST_EFFORT", "NORMAL"}, + "resources.jobs.*.tasks[*].for_each_task.task.ai_runtime_task.priority_class": {"HIGH", "NORMAL"}, "resources.jobs.*.tasks[*].for_each_task.task.compute.hardware_accelerator": {"GPU_1xA10", "GPU_1xH100", "GPU_8xB300", "GPU_8xH100"}, "resources.jobs.*.tasks[*].for_each_task.task.condition_task.op": {"EQUAL_TO", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "NOT_EQUAL"}, "resources.jobs.*.tasks[*].for_each_task.task.dashboard_task.subscription.attachment.data_attachment.file_format": {"FILE_FORMAT_CSV", "FILE_FORMAT_EXCEL", "FILE_FORMAT_TSV"}, diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index b0fd7b7d3bd..3711015bdea 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -846,15 +846,15 @@ "oneOf": [ { "type": "object", - "description": "Monitor for the data quality of unity catalog entities such as schema or table.", + "description": "A data quality monitor on a Unity Catalog object. A `schema` monitor runs anomaly detection on the tables in the\nschema and is configured through `anomaly_detection_config`. A `table` monitor profiles a single table and is\nconfigured through `data_profiling_config`.", "properties": { "anomaly_detection_config": { - "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "description": "Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds\nthe settings of the parent schema's monitor if the schema has one.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.AnomalyDetectionConfig", "x-databricks-launch-stage": "GA" }, "data_profiling_config": { - "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "description": "Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series`\nor `snapshot` must be set.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingConfig", "x-databricks-launch-stage": "GA" }, @@ -1511,10 +1511,9 @@ "x-databricks-launch-stage": "GA" }, "parent_path": { - "description": "[Private Preview] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object.", + "description": "[Beta] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `COST_OPTIMIZED`: Enables lower job costs by optimizing compute for your selected target duration time. Must provide a duration target.", @@ -2281,7 +2280,7 @@ "type": "object", "properties": { "allow_duplicate_names": { - "description": "If false, deployment will fail if name conflicts with that of another pipeline.", + "description": "If false, deployment will fail if name conflicts with that of another pipeline.\n\nIgnored when `parent_path` is set. A pipeline in a workspace folder must have a name that is\nunique within that folder, and creation fails if the folder already contains an object with the\nsame name.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA" }, @@ -2389,10 +2388,9 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "parent_path": { - "description": "[Private Preview] Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", + "description": "[Beta] Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a parent folder.\n\nExample: /Workspace/Projects/my_project", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -3507,7 +3505,7 @@ "x-databricks-launch-stage": "GA" }, "channel": { - "description": "Channel Details", + "description": "Channel that determines which Databricks SQL version the warehouse runs.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Channel", "x-databricks-launch-stage": "GA" }, @@ -3517,7 +3515,7 @@ "x-databricks-launch-stage": "GA" }, "creator_name": { - "description": "warehouse creator name", + "description": "Name of the user who created the warehouse. Set by the server and ignored in\nrequests.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -3559,7 +3557,7 @@ "x-databricks-launch-stage": "GA" }, "name": { - "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", + "description": "Logical name for the warehouse.\n\nSupported values:\n- Must be unique within an org.\n- Must be 1 to 100 characters.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -3575,12 +3573,12 @@ "doNotSuggest": true }, "spot_instance_policy": { - "description": "Configurations whether the endpoint should use spot instances.", + "description": "Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses\nspot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED\nuses on-demand instances only.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy", "x-databricks-launch-stage": "GA" }, "statement_timeout": { - "description": "[Public Preview] Warehouse statement timeout in seconds.", + "description": "[Public Preview] Maximum time in seconds that a statement can run on this warehouse before it is\ncancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a\nrunning warehouse restarts it. See\nhttps://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, @@ -9588,7 +9586,7 @@ "description": "Anomaly Detection Configurations.", "properties": { "excluded_table_full_names": { - "description": "[Beta] List of fully qualified table names to exclude from anomaly detection.", + "description": "[Beta] List of fully qualified table names to exclude from anomaly detection. Format: `catalog.schema.table_name`.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, @@ -9618,7 +9616,7 @@ "x-databricks-launch-stage": "GA" }, "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.", + "description": "The Java timezone ID in which the cron expression is evaluated. See\n[Java TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html) for the supported IDs.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -9658,37 +9656,37 @@ "description": "Data Profiling Configurations.", "properties": { "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.", + "description": "The absolute workspace path of the directory where the monitor's assets, such as\nthe dashboard, are stored. The UI and the Python APIs normally prepopulate a default user location.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "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.", + "description": "The fully qualified name of a baseline table. Format: `catalog.schema.table_name`.\nDrift metrics compare the monitored table against the baseline data, so the two tables must have the same\nschema.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "custom_metrics": { - "description": "Custom metrics.", + "description": "Custom metrics to compute in addition to the built-in ones. See\n[custom metrics](https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics).", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingCustomMetric", "x-databricks-launch-stage": "GA" }, "inference_log": { - "description": "`Analysis Configuration` for monitoring inference log tables.", + "description": "Profiles an inference log table, which stores the requests and predictions of a model. Metrics are\ncomputed per time window and include model quality metrics.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.InferenceLogConfig", "x-databricks-launch-stage": "GA" }, "notification_settings": { - "description": "Field for specifying notification settings.", + "description": "Who to notify about this monitor's refreshes. Only `on_failure` with\n`email_addresses` is supported here.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationSettings", "x-databricks-launch-stage": "GA" }, "output_schema_id": { - "description": "ID of the schema where output tables are created.", + "description": "The UUID of the Unity Catalog schema where the profile and drift metrics tables\nare created.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "schedule": { - "description": "The cron schedule.", + "description": "The schedule on which the monitor refreshes its metrics. Refreshes can also be\ntriggered on demand through the Refresh resource.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.CronSchedule", "x-databricks-launch-stage": "GA" }, @@ -9698,22 +9696,22 @@ "x-databricks-launch-stage": "GA" }, "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.", + "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`col_1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA" }, "snapshot": { - "description": "`Analysis Configuration` for monitoring snapshot tables.", + "description": "Profiles the full contents of the table. Metrics are computed over all rows at each refresh.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.SnapshotConfig", "x-databricks-launch-stage": "GA" }, "time_series": { - "description": "`Analysis Configuration` for monitoring time series tables.", + "description": "Profiles a time series table. Metrics are computed per time window, as defined by `timestamp_column`\nand `granularities`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.TimeSeriesConfig", "x-databricks-launch-stage": "GA" }, "warehouse_id": { - "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", + "description": "The ID of the SQL warehouse used to create the dashboard. If not specified, the first running warehouse the\ncaller can access is used.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -9741,7 +9739,7 @@ "x-databricks-launch-stage": "GA" }, "input_columns": { - "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", + "description": "A list of column names in the input table the metric should be computed for.\nCan use `\":table\"` to indicate that the metric needs information from multiple columns.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA" }, @@ -9751,12 +9749,12 @@ "x-databricks-launch-stage": "GA" }, "output_data_type": { - "description": "The output type of the custom metric.", + "description": "Specifies the Spark SQL data type of the metric value, either as a plain type name or as a JSON-encoded\nStructField.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "type": { - "description": "The type of the custom metric.", + "description": "The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` metrics depend only on the\ncolumns of the input table, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics depend only on previously\ncomputed aggregate metrics, and `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` metrics depend on previously computed\naggregate or derived metrics.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingCustomMetricType", "x-databricks-launch-stage": "GA" } @@ -9824,27 +9822,27 @@ "x-databricks-launch-stage": "GA" }, "label_column": { - "description": "Column for the label.", + "description": "Column containing the ground truth for the model's predictions.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "model_id_column": { - "description": "Column for the model identifier.", + "description": "Column containing the ID of the model that produced each prediction. A slice is created automatically for\neach distinct model ID.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "prediction_column": { - "description": "Column for the prediction.", + "description": "Column containing the model's predicted values.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "problem_type": { - "description": "Problem type the model aims to solve.", + "description": "The type of problem the model solves. It determines which model quality metrics are computed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.InferenceProblemType", "x-databricks-launch-stage": "GA" }, "timestamp_column": { - "description": "Column for the timestamp.", + "description": "Column containing the timestamp of each inference request. Its type must be TIMESTAMP or convertible to a\ntimestamp.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -9897,7 +9895,7 @@ "x-databricks-launch-stage": "GA" }, "email_addresses": { - "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.", + "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.\nOnly supported on table monitors, via `data_profiling_config`; rejected on schema monitors.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA" } @@ -9917,7 +9915,7 @@ "description": "Settings for sending notifications on the data quality monitoring.", "properties": { "on_failure": { - "description": "Destinations to send notifications on failure/timeout.", + "description": "Recipients to notify when a refresh of the monitor fails or times out. Only supported on table\nmonitors, via `data_profiling_config`, and only `email_addresses` is accepted there.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationDestination", "x-databricks-launch-stage": "GA" }, @@ -9960,7 +9958,7 @@ "x-databricks-launch-stage": "GA" }, "timestamp_column": { - "description": "Column for the timestamp.", + "description": "Column containing the timestamp of each row. Its type must be TIMESTAMP or convertible to a timestamp.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -10378,8 +10376,8 @@ "type": "string", "description": "Scheduling priority class for a workload — its priority and preemptability\nwhen the scheduler ranks pending work.", "enum": [ - "BEST_EFFORT", - "NORMAL" + "NORMAL", + "HIGH" ], "enumDescriptions": [ "[Private Preview]", @@ -21580,10 +21578,12 @@ "description": "Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.", "properties": { "dbsql_version": { + "description": "Databricks SQL version to pin to. Set it if and only if name is\nCHANNEL_NAME_CUSTOM.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "name": { + "description": "Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW\ncarries the upcoming Databricks SQL release for testing.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ChannelName", "x-databricks-launch-stage": "GA" } @@ -21716,10 +21716,12 @@ "type": "object", "properties": { "key": { + "description": "Tag key. Keys must be unique within the warehouse and cannot use the keys that\nDatabricks reserves for the tags it sets automatically.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "value": { + "description": "Tag value. Keys and values must follow the tagging rules of the cloud provider.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21738,6 +21740,7 @@ "type": "object", "properties": { "custom_tags": { + "description": "User-defined tags, applied in addition to the tags Databricks sets automatically.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair", "x-databricks-launch-stage": "GA" } @@ -22034,12 +22037,12 @@ "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", "properties": { "dns_name": { - "description": "The DNS of the KeyVault", + "description": "The DNS name of the key vault, for example ``https://my-key-vault.vault.azure.net/``.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "resource_id": { - "description": "The resource id of the azure KeyVault that user wants to associate the scope with.", + "description": "The Azure resource ID of the key vault to associate with the scope.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -22060,7 +22063,7 @@ "oneOf": [ { "type": "string", - "description": "The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes\nwill be supported in a later release.", + "description": "The types of secret scope backends in the Secret Manager.", "enum": [ "DATABRICKS", "AZURE_KEYVAULT" diff --git a/cmd/account/published-app-integration/published-app-integration.go b/cmd/account/published-app-integration/published-app-integration.go index 1577af4eb90..5c0d893e0cf 100644 --- a/cmd/account/published-app-integration/published-app-integration.go +++ b/cmd/account/published-app-integration/published-app-integration.go @@ -67,7 +67,7 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.AppId, "app-id", createReq.AppId, `App id of the OAuth published app integration.`) + cmd.Flags().StringVar(&createReq.AppId, "app-id", createReq.AppId, `ID of the published OAuth app to enable, as returned in app_id by the list of published OAuth apps.`) // TODO: complex arg: token_access_policy cmd.Use = "create" @@ -146,10 +146,14 @@ func newDelete() *cobra.Command { cmd.Short = `Delete Published OAuth App Integration.` cmd.Long = `Delete Published OAuth App Integration. - Delete an existing Published OAuth App Integration. You can retrieve the - published OAuth app integration via [PublishedAppIntegration/get]. + Delete an existing Published OAuth App Integration. The app can no longer be + used to sign in to the account until it is enabled again with + [PublishedAppIntegration/create]. - [PublishedAppIntegration/get]: https://docs.databricks.com/api/account/publishedappintegration/get` + [PublishedAppIntegration/create]: https://docs.databricks.com/api/account/publishedappintegration/create + + Arguments: + INTEGRATION_ID: ID of the published OAuth app integration to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -204,7 +208,10 @@ func newGet() *cobra.Command { cmd.Short = `Get OAuth Published App Integration.` cmd.Long = `Get OAuth Published App Integration. - Gets the Published OAuth App Integration for the given integration id.` + Gets the Published OAuth App Integration for the given integration id. + + Arguments: + INTEGRATION_ID: ID of the published OAuth app integration.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -260,7 +267,7 @@ func newList() *cobra.Command { // branches, so the method-call path is always reached. var listLimit int - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of integrations to return in one page, at most 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) @@ -274,7 +281,7 @@ func newList() *cobra.Command { cmd.Long = `Get published oauth app integrations. Get the list of published OAuth app integrations for the specified Databricks - account` + account.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -339,7 +346,10 @@ func newUpdate() *cobra.Command { Updates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via [PublishedAppIntegration/get]. - [PublishedAppIntegration/get]: https://docs.databricks.com/api/account/publishedappintegration/get` + [PublishedAppIntegration/get]: https://docs.databricks.com/api/account/publishedappintegration/get + + Arguments: + INTEGRATION_ID: ID of the published OAuth app integration to update.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/account/usage-dashboards/usage-dashboards.go b/cmd/account/usage-dashboards/usage-dashboards.go index bf74f77dd1d..b17a4a33fa8 100644 --- a/cmd/account/usage-dashboards/usage-dashboards.go +++ b/cmd/account/usage-dashboards/usage-dashboards.go @@ -64,15 +64,18 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().Var(&createReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]`) - cmd.Flags().Var(&createReq.MajorVersion, "major-version", `The major version of the usage dashboard template to use. Supported values: [USAGE_DASHBOARD_MAJOR_VERSION_1, USAGE_DASHBOARD_MAJOR_VERSION_2]`) - cmd.Flags().Int64Var(&createReq.WorkspaceId, "workspace-id", createReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created.`) + cmd.Flags().Var(&createReq.MajorVersion, "major-version", `The major version of the usage dashboard template to import. Supported values: [USAGE_DASHBOARD_MAJOR_VERSION_1, USAGE_DASHBOARD_MAJOR_VERSION_2]`) + cmd.Flags().Int64Var(&createReq.WorkspaceId, "workspace-id", createReq.WorkspaceId, `The ID of the workspace to import the usage dashboard into.`) cmd.Use = "create" cmd.Short = `Create new usage dashboard.` cmd.Long = `Create new usage dashboard. - Create a usage dashboard specified by workspaceId, accountId, and dashboard - type.` + Imports a pre-built usage dashboard of the given type into a workspace. Each + call imports a new dashboard, even if the caller already created one of the + same type in that workspace. The caller must be an account admin and a user of + the target workspace. See + https://docs.databricks.com/admin/account-settings/usage.html.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -136,13 +139,15 @@ func newGet() *cobra.Command { var getReq billing.GetBillingUsageDashboardRequest cmd.Flags().Var(&getReq.DashboardType, "dashboard-type", `Workspace level usage dashboard shows usage data for the specified workspace ID. Supported values: [USAGE_DASHBOARD_TYPE_GLOBAL, USAGE_DASHBOARD_TYPE_WORKSPACE]`) - cmd.Flags().Int64Var(&getReq.WorkspaceId, "workspace-id", getReq.WorkspaceId, `The workspace ID of the workspace in which the usage dashboard is created.`) + cmd.Flags().Int64Var(&getReq.WorkspaceId, "workspace-id", getReq.WorkspaceId, `The ID of the workspace that contains the usage dashboard.`) cmd.Use = "get" cmd.Short = `Get usage dashboard.` cmd.Long = `Get usage dashboard. - Get a usage dashboard specified by workspaceId, accountId, and dashboard type.` + Gets the most recent usage dashboard of the given type that the caller + created. The response is empty if no such dashboard exists, if it has been + deleted, or if the caller can no longer access its workspace.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/agent-kit/agent-kit.go b/cmd/workspace/agent-kit/agent-kit.go index 5c61de2d5dc..6cdaab0939d 100644 --- a/cmd/workspace/agent-kit/agent-kit.go +++ b/cmd/workspace/agent-kit/agent-kit.go @@ -247,7 +247,7 @@ func newCreateMemory() *cobra.Command { cmd.Flags().StringVar(&createMemoryReq.ManagedMemoryEntry.Content, "content", createMemoryReq.ManagedMemoryEntry.Content, `Optional free-form memory content.`) cmd.Flags().StringVar(&createMemoryReq.ManagedMemoryEntry.Description, "description", createMemoryReq.ManagedMemoryEntry.Description, `Human-readable description of the memory entry.`) cmd.Flags().StringVar(&createMemoryReq.ManagedMemoryEntry.Name, "name", createMemoryReq.ManagedMemoryEntry.Name, `Resource name in the form memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}.`) - cmd.Flags().StringVar(&createMemoryReq.ManagedMemoryEntry.SessionId, "session-id", createMemoryReq.ManagedMemoryEntry.SessionId, `Optional identifier for the session associated with this memory entry.`) + cmd.Flags().StringVar(&createMemoryReq.ManagedMemoryEntry.SessionId, "session-id", createMemoryReq.ManagedMemoryEntry.SessionId, `Deprecated: memory entries will be identified by (actor_id, path), and the service will ignore this field on writes and omit it from responses.`) cmd.Flags().Var(&createMemoryReq.ManagedMemoryEntry.SourceType, "source-type", `Which writer created this entry. Supported values: [MANAGED_MEMORY_ENTRY_SOURCE_TYPE_AGENT, MANAGED_MEMORY_ENTRY_SOURCE_TYPE_DREAMER]`) cmd.Use = "create-memory PARENT ACTOR_ID PATH" @@ -262,15 +262,17 @@ Create a memory entry. exists. Omitted session_id is its own uniqueness key: two omitted-session entries with the same actor and path conflict, but an omitted-session entry does not conflict with a session-scoped entry at the same actor and path. + session_id is deprecated: once it is ignored, the uniqueness key becomes + actor and path. Arguments: PARENT: Memory store that will contain the entry, in the form memory-stores/{managed_memory_store_id}. ACTOR_ID: Customer-provided identifier for the actor whose memory this entry represents. - PATH: Absolute, case-sensitive path identifying the entry within its actor and - optional session. Paths must begin with / and must not contain empty, - . or .. segments.` + PATH: Absolute, case-sensitive path identifying the entry within its actor and, + until the deprecated session_id is ignored, its optional session. Paths + must begin with / and must not contain empty, . or .. segments.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -1591,7 +1593,7 @@ func newListMemories() *cobra.Command { cmd.Flags().IntVar(&listMemoriesReq.PageSize, "page-size", listMemoriesReq.PageSize, `Maximum number of entries to return.`) cmd.Flags().StringVar(&listMemoriesReq.PathPrefix, "path-prefix", listMemoriesReq.PathPrefix, `Optional path prefix used to restrict entries within the actor partition.`) - cmd.Flags().StringVar(&listMemoriesReq.SessionId, "session-id", listMemoriesReq.SessionId, `Optional session identifier.`) + cmd.Flags().StringVar(&listMemoriesReq.SessionId, "session-id", listMemoriesReq.SessionId, `Deprecated: the service will ignore this filter.`) cmd.Flags().Var(&listMemoriesReq.View, "view", `Controls whether each returned entry includes memory content. Supported values: [MANAGED_MEMORY_ENTRY_VIEW_BASIC, MANAGED_MEMORY_ENTRY_VIEW_FULL]`) // Limit flag for total result capping. @@ -1608,9 +1610,9 @@ func newListMemories() *cobra.Command { List memory entries. Lists memory entries for one actor. An exact path filters entries across - sessions, ignoring session metadata. Otherwise, session_id and path_prefix - restrict the actor partition. view controls whether each returned entry - includes memory content. + sessions, ignoring session metadata. Otherwise, path_prefix and the + deprecated session_id restrict the actor partition. view controls whether + each returned entry includes memory content. Arguments: PARENT: Memory store whose entries are listed, in the form @@ -2363,7 +2365,7 @@ func newSearchMemories() *cobra.Command { cmd.Flags().IntVar(&searchMemoriesReq.PageSize, "page-size", searchMemoriesReq.PageSize, `Maximum number of relevance-ranked entries to return.`) cmd.Flags().StringVar(&searchMemoriesReq.PathPrefix, "path-prefix", searchMemoriesReq.PathPrefix, `Optional absolute, case-sensitive path prefix used to restrict searched entries within the actor partition.`) - cmd.Flags().StringVar(&searchMemoriesReq.SessionId, "session-id", searchMemoriesReq.SessionId, `Optional session identifier.`) + cmd.Flags().StringVar(&searchMemoriesReq.SessionId, "session-id", searchMemoriesReq.SessionId, `Deprecated: the service will ignore this filter.`) cmd.Flags().Var(&searchMemoriesReq.View, "view", `Controls whether each returned entry includes memory content. Supported values: [MANAGED_MEMORY_ENTRY_VIEW_BASIC, MANAGED_MEMORY_ENTRY_VIEW_FULL]`) // Limit flag for total result capping. @@ -2474,7 +2476,7 @@ func newUpdateMemory() *cobra.Command { cmd.Flags().StringVar(&updateMemoryReq.ManagedMemoryEntry.Content, "content", updateMemoryReq.ManagedMemoryEntry.Content, `Optional free-form memory content.`) cmd.Flags().StringVar(&updateMemoryReq.ManagedMemoryEntry.Description, "description", updateMemoryReq.ManagedMemoryEntry.Description, `Human-readable description of the memory entry.`) cmd.Flags().StringVar(&updateMemoryReq.ManagedMemoryEntry.Name, "name", updateMemoryReq.ManagedMemoryEntry.Name, `Resource name in the form memory-stores/{managed_memory_store_id}/entries/{managed_memory_entry_id}.`) - cmd.Flags().StringVar(&updateMemoryReq.ManagedMemoryEntry.SessionId, "session-id", updateMemoryReq.ManagedMemoryEntry.SessionId, `Optional identifier for the session associated with this memory entry.`) + cmd.Flags().StringVar(&updateMemoryReq.ManagedMemoryEntry.SessionId, "session-id", updateMemoryReq.ManagedMemoryEntry.SessionId, `Deprecated: memory entries will be identified by (actor_id, path), and the service will ignore this field on writes and omit it from responses.`) cmd.Flags().Var(&updateMemoryReq.ManagedMemoryEntry.SourceType, "source-type", `Which writer created this entry. Supported values: [MANAGED_MEMORY_ENTRY_SOURCE_TYPE_AGENT, MANAGED_MEMORY_ENTRY_SOURCE_TYPE_DREAMER]`) cmd.Use = "update-memory NAME UPDATE_MASK ACTOR_ID PATH" @@ -2493,9 +2495,9 @@ Update a memory entry. UPDATE_MASK: Fields to update. Only content and description may be updated. ACTOR_ID: Customer-provided identifier for the actor whose memory this entry represents. - PATH: Absolute, case-sensitive path identifying the entry within its actor and - optional session. Paths must begin with / and must not contain empty, - . or .. segments.` + PATH: Absolute, case-sensitive path identifying the entry within its actor and, + until the deprecated session_id is ignored, its optional session. Paths + must begin with / and must not contain empty, . or .. segments.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" diff --git a/cmd/workspace/ai-functions/ai-functions.go b/cmd/workspace/ai-functions/ai-functions.go index 69ff65f1ce0..0e2f4ea1d43 100644 --- a/cmd/workspace/ai-functions/ai-functions.go +++ b/cmd/workspace/ai-functions/ai-functions.go @@ -150,7 +150,9 @@ Get fast structured decisions. Turn text and structured data into decisions your application can use. Define questions and criteria to choose an option, estimate a probability, or assign - a score given a provided state.` + a score given a provided state. For REST API requests, the default rate limit + is 1,200 requests per minute per workspace. Contact your Databricks account + team to request a higher limit.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" diff --git a/cmd/workspace/ai-search/ai-search.go b/cmd/workspace/ai-search/ai-search.go index dbd50fc29c2..27b6dcec46e 100644 --- a/cmd/workspace/ai-search/ai-search.go +++ b/cmd/workspace/ai-search/ai-search.go @@ -24,22 +24,20 @@ var cmdOverrides []func(*cobra.Command) // Spec declares the command for this service. var Spec = root.CommandSpec{ Use: "ai-search", - Short: `*Public Preview* **AI Search Endpoint**: Represents the compute resources to host AI Search indexes.`, + Short: `**AI Search Endpoint**: Represents the compute resources to host AI Search indexes.`, GroupID: "aisearch", Build: buildCommand, } func buildCommand(ctx context.Context, cmd *cobra.Command) { - cmd.Long = `This command is in Public Preview and may change without notice. - -**AI Search Endpoint**: Represents the compute resources to host AI Search + cmd.Long = `**AI Search Endpoint**: Represents the compute resources to host AI Search indexes. AIP-conformant replacement for the legacy VectorSearchEndpoints API; functionally equivalent.` cmd.RunE = root.ReportUnknownSubcommand cmd.Annotations = map[string]string{ - "launch_stage": "PUBLIC_PREVIEW", - "launch_stage_display": "Public Preview", + "launch_stage": "GA", + "launch_stage_display": "GA", } // Add methods @@ -94,10 +92,8 @@ func newCreateEndpoint() *cobra.Command { cmd.Flags().StringVar(&createEndpointReq.Endpoint.UsagePolicyId, "usage-policy-id", createEndpointReq.Endpoint.UsagePolicyId, `ID of the usage policy to apply to the endpoint.`) cmd.Use = "create-endpoint PARENT ENDPOINT_TYPE" - cmd.Short = `*Public Preview* Create an AI Search endpoint.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Create an AI Search endpoint. + cmd.Short = `Create an AI Search endpoint.` + cmd.Long = `Create an AI Search endpoint. Create a new AI Search endpoint. @@ -108,8 +104,8 @@ Create an AI Search endpoint. Supported values: [STANDARD, STORAGE_OPTIMIZED]` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("json") { @@ -195,10 +191,8 @@ func newCreateIndex() *cobra.Command { // TODO: complex arg: status cmd.Use = "create-index PARENT PRIMARY_KEY INDEX_TYPE" - cmd.Short = `*Public Preview* Create an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Create an AI Search index. + cmd.Short = `Create an AI Search index.` + cmd.Long = `Create an AI Search index. Create a new AI Search index. The index is provisioned asynchronously; status.ready on GetIndex reports when it can serve queries. @@ -216,8 +210,8 @@ Create an AI Search index. Supported values: [DELTA_SYNC, DIRECT_ACCESS]` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("json") { @@ -295,18 +289,16 @@ func newDeleteEndpoint() *cobra.Command { var deleteEndpointReq aisearch.DeleteEndpointRequest cmd.Use = "delete-endpoint NAME" - cmd.Short = `*Public Preview* Delete an AI Search endpoint.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Delete an AI Search endpoint. + cmd.Short = `Delete an AI Search endpoint.` + cmd.Long = `Delete an AI Search endpoint. Arguments: NAME: Full resource name of the endpoint to delete. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -354,18 +346,16 @@ func newDeleteIndex() *cobra.Command { var deleteIndexReq aisearch.DeleteIndexRequest cmd.Use = "delete-index NAME" - cmd.Short = `*Public Preview* Delete an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Delete an AI Search index. + cmd.Short = `Delete an AI Search index.` + cmd.Long = `Delete an AI Search index. Arguments: NAME: Full resource name of the index to delete. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -413,10 +403,8 @@ func newGetEndpoint() *cobra.Command { var getEndpointReq aisearch.GetEndpointRequest cmd.Use = "get-endpoint NAME" - cmd.Short = `*Public Preview* Get an AI Search endpoint.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Get an AI Search endpoint. + cmd.Short = `Get an AI Search endpoint.` + cmd.Long = `Get an AI Search endpoint. Get details for a single AI Search endpoint. @@ -425,8 +413,8 @@ Get an AI Search endpoint. workspaces/{workspace_id}/endpoints/{endpoint_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -475,10 +463,8 @@ func newGetIndex() *cobra.Command { var getIndexReq aisearch.GetIndexRequest cmd.Use = "get-index NAME" - cmd.Short = `*Public Preview* Get an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Get an AI Search index. + cmd.Short = `Get an AI Search index.` + cmd.Long = `Get an AI Search index. Get details for a single AI Search index. @@ -487,8 +473,8 @@ Get an AI Search index. workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -550,10 +536,8 @@ func newListEndpoints() *cobra.Command { cmd.Flags().Lookup("page-token").Hidden = true cmd.Use = "list-endpoints PARENT" - cmd.Short = `*Public Preview* List AI Search endpoints.` - cmd.Long = `This command is in Public Preview and may change without notice. - -List AI Search endpoints. + cmd.Short = `List AI Search endpoints.` + cmd.Long = `List AI Search endpoints. List AI Search endpoints in a workspace. @@ -562,8 +546,8 @@ List AI Search endpoints. workspaces/{workspace_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -628,10 +612,8 @@ func newListIndexes() *cobra.Command { cmd.Flags().Lookup("page-token").Hidden = true cmd.Use = "list-indexes PARENT" - cmd.Short = `*Public Preview* List AI Search indexes.` - cmd.Long = `This command is in Public Preview and may change without notice. - -List AI Search indexes. + cmd.Short = `List AI Search indexes.` + cmd.Long = `List AI Search indexes. List AI Search indexes on an endpoint. @@ -640,8 +622,8 @@ List AI Search indexes. workspaces/{workspace_id}/endpoints/{endpoint_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -708,10 +690,8 @@ func newQueryIndex() *cobra.Command { // TODO: array: sort_columns cmd.Use = "query-index NAME" - cmd.Short = `*Public Preview* Query an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Query an AI Search index. + cmd.Short = `Query an AI Search index.` + cmd.Long = `Query an AI Search index. Query (search) an AI Search index. Read-only, so a read-scoped token may invoke it. @@ -721,8 +701,8 @@ Query an AI Search index. workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -788,10 +768,8 @@ func newRemoveData() *cobra.Command { cmd.Flags().Var(&removeDataJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Use = "remove-data NAME" - cmd.Short = `*Public Preview* Remove data from an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Remove data from an AI Search index. + cmd.Short = `Remove data from an AI Search index.` + cmd.Long = `Remove data from an AI Search index. Remove rows by primary key from a Direct Access AI Search index. @@ -800,8 +778,8 @@ Remove data from an AI Search index. workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -870,10 +848,8 @@ func newScanIndex() *cobra.Command { cmd.Flags().StringVar(&scanIndexReq.PageToken, "page-token", scanIndexReq.PageToken, `Page token from a previous response; if unset, scanning starts from the beginning.`) cmd.Use = "scan-index NAME" - cmd.Short = `*Public Preview* Scan an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Scan an AI Search index. + cmd.Short = `Scan an AI Search index.` + cmd.Long = `Scan an AI Search index. Scan (paginate over) the rows of an AI Search index. @@ -882,8 +858,8 @@ Scan an AI Search index. workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -944,10 +920,8 @@ func newSyncIndex() *cobra.Command { var syncIndexReq aisearch.SyncIndexRequest cmd.Use = "sync-index NAME" - cmd.Short = `*Public Preview* Synchronize an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Synchronize an AI Search index. + cmd.Short = `Synchronize an AI Search index.` + cmd.Long = `Synchronize an AI Search index. Start a sync of a Delta Sync AI Search index with its source Delta table. Use it with TRIGGERED pipelines; CONTINUOUS pipelines sync automatically. @@ -959,8 +933,8 @@ Synchronize an AI Search index. workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -1023,10 +997,8 @@ func newUpdateEndpoint() *cobra.Command { cmd.Flags().StringVar(&updateEndpointReq.Endpoint.UsagePolicyId, "usage-policy-id", updateEndpointReq.Endpoint.UsagePolicyId, `ID of the usage policy to apply to the endpoint.`) cmd.Use = "update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE" - cmd.Short = `*Public Preview* Update an AI Search endpoint.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Update an AI Search endpoint. + cmd.Short = `Update an AI Search endpoint.` + cmd.Long = `Update an AI Search endpoint. Update an existing AI Search endpoint. Only the fields named in update_mask change. The server applies a mask that spans several settings, such as @@ -1045,8 +1017,8 @@ Update an AI Search endpoint. Supported values: [STANDARD, STORAGE_OPTIMIZED]` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("json") { @@ -1128,10 +1100,8 @@ func newUpsertData() *cobra.Command { cmd.Flags().Var(&upsertDataJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Use = "upsert-data NAME INPUTS_JSON" - cmd.Short = `*Public Preview* Upsert data into an AI Search index.` - cmd.Long = `This command is in Public Preview and may change without notice. - -Upsert data into an AI Search index. + cmd.Short = `Upsert data into an AI Search index.` + cmd.Long = `Upsert data into an AI Search index. Upsert rows into a Direct Access AI Search index. @@ -1145,8 +1115,8 @@ Upsert data into an AI Search index. empty.` cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" - cmd.Annotations["launch_stage_display"] = "Public Preview" + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" cmd.Args = func(cmd *cobra.Command, args []string) error { if cmd.Flags().Changed("json") { diff --git a/cmd/workspace/clean-room-assets/clean-room-assets.go b/cmd/workspace/clean-room-assets/clean-room-assets.go index 86dfeb3263f..3cd2457a887 100644 --- a/cmd/workspace/clean-room-assets/clean-room-assets.go +++ b/cmd/workspace/clean-room-assets/clean-room-assets.go @@ -452,6 +452,10 @@ func newList() *cobra.Command { cmd.Short = `List assets.` cmd.Long = `List assets. + List the assets in a clean room. Listed assets do not include their asset-type + specific details, such as table columns or notebook content; use the get + method to retrieve them. + Arguments: CLEAN_ROOM_NAME: Name of the clean room.` diff --git a/cmd/workspace/connections/connections.go b/cmd/workspace/connections/connections.go index 1c2c332fd81..22aa4ebd693 100644 --- a/cmd/workspace/connections/connections.go +++ b/cmd/workspace/connections/connections.go @@ -78,7 +78,7 @@ func newCreate() *cobra.Command { // TODO: complex arg: environment_settings cmd.Flags().StringVar(&createReq.Parent, "parent", createReq.Parent, `Parent schema for schema-level connections, in format "schemas/{catalog}.{schema}".`) // TODO: map via StringToStringVar: properties - cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `If the connection is read only.`) + cmd.Flags().BoolVar(&createReq.ReadOnly, "read-only", createReq.ReadOnly, `Whether the connection is read only.`) // TODO: map via StringToStringVar: secrets cmd.Use = "create" @@ -223,7 +223,7 @@ func newGet() *cobra.Command { cmd.Short = `Get a connection.` cmd.Long = `Get a connection. - Gets a connection from it's name. + Gets a connection from its name. Arguments: NAME: Name of the connection.` @@ -375,14 +375,16 @@ func newUpdate() *cobra.Command { // TODO: complex arg: environment_settings cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the connection.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of the connection.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of the current owner of the connection.`) // TODO: map via StringToStringVar: secrets cmd.Use = "update NAME" cmd.Short = `Update a connection.` cmd.Long = `Update a connection. - Updates the connection that matches the supplied name. + Updates the connection that matches the supplied name. When options are + provided, they replace the existing options of the connection, so include + every key that the connection type requires. Arguments: NAME: Name of the connection.` diff --git a/cmd/workspace/credentials/credentials.go b/cmd/workspace/credentials/credentials.go index 073ddd4f9a5..5e58d2adc4b 100644 --- a/cmd/workspace/credentials/credentials.go +++ b/cmd/workspace/credentials/credentials.go @@ -242,8 +242,8 @@ func newGenerateTemporaryServiceCredential() *cobra.Command { cmd.Long = `Generate a temporary service credential. Returns a set of temporary credentials generated using the specified service - credential. The caller must be a metastore admin or have the metastore - privilege **ACCESS** on the service credential. + credential. The caller must be a metastore admin or have the **ACCESS** + privilege on the service credential. Arguments: CREDENTIAL_NAME: The name of the service credential used to generate a temporary credential` diff --git a/cmd/workspace/data-classification/data-classification.go b/cmd/workspace/data-classification/data-classification.go index d5f812434af..a2ab6ddb032 100644 --- a/cmd/workspace/data-classification/data-classification.go +++ b/cmd/workspace/data-classification/data-classification.go @@ -81,10 +81,11 @@ func newCreateCatalogConfig() *cobra.Command { Create Data Classification configuration for a catalog. Creates a new config resource, which enables Data Classification for the - specified catalog. - The config must not already exist for the catalog. + specified catalog. The catalog must not already have a config. Creating the + config starts a scan of the selected schemas and schedules recurring scans. Arguments: - PARENT: Parent resource in the format: catalogs/{catalog_name}` + PARENT: Name of the catalog to enable, in the format catalogs/{catalog_name}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -154,8 +155,12 @@ func newDeleteCatalogConfig() *cobra.Command { Delete Data Classification configuration for a catalog. + Deleting the config disables Data Classification for the catalog and stops its + scheduled scans. Tags that auto-tagging already applied to columns are not + removed. Deleting a config that does not exist succeeds. + Arguments: - NAME: Resource name in the format: catalogs/{catalog_name}/config` + NAME: Resource name of the config, in the format catalogs/{catalog_name}/config.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -213,7 +218,7 @@ func newGetCatalogConfig() *cobra.Command { Get the Data Classification configuration for a catalog. Arguments: - NAME: Resource name in the format: catalogs/{catalog_name}/config` + NAME: Resource name of the config, in the format catalogs/{catalog_name}/config.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -278,13 +283,15 @@ func newUpdateCatalogConfig() *cobra.Command { cmd.Short = `Update config for a catalog.` cmd.Long = `Update config for a catalog. - Update the Data Classification configuration for a catalog. - The config must - already exist for the catalog. - Updates fields specified in the update_mask. - Use update_mask field to perform partial updates of the configuration. + Update the Data Classification configuration for a catalog. + + The config must already exist for the catalog. Only the fields named in + update_mask change; the other fields keep their current values. Arguments: NAME: Resource name in the format: catalogs/{catalog_name}/config. - UPDATE_MASK: Field mask specifying which fields to update.` + UPDATE_MASK: Comma-separated list of the fields of catalog_config to update, for + example included_schemas or auto_tag_configs.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/data-quality/data-quality.go b/cmd/workspace/data-quality/data-quality.go index e51399c843f..24c60e712f6 100644 --- a/cmd/workspace/data-quality/data-quality.go +++ b/cmd/workspace/data-quality/data-quality.go @@ -385,12 +385,12 @@ func newDeleteMonitor() *cobra.Command { cmd.Short = `Delete a monitor.` cmd.Long = `Delete a monitor. - Delete a data quality monitor on Unity Catalog object. + Delete a data quality monitor on a Unity Catalog object. For the table object_type, the caller must have either of the following - sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent - catalog. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and - **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the table's + sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent + catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and + **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table. @@ -738,7 +738,7 @@ func newListMonitor() *cobra.Command { // branches, so the method-call path is always reached. var listMonitorLimit int - cmd.Flags().IntVar(&listMonitorReq.PageSize, "page-size", listMonitorReq.PageSize, ``) + cmd.Flags().IntVar(&listMonitorReq.PageSize, "page-size", listMonitorReq.PageSize, `The maximum number of monitors to return in one page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listMonitorLimit, "limit", 0, `Maximum number of results to return.`) @@ -919,7 +919,8 @@ func newUpdateMonitor() *cobra.Command { cmd.Short = `Update a monitor.` cmd.Long = `Update a monitor. - Update a data quality monitor on Unity Catalog object. + Update a data quality monitor on a Unity Catalog object. Only the fields named + in update_mask are changed. For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent diff --git a/cmd/workspace/environments/environments.go b/cmd/workspace/environments/environments.go index 0f1efdfd9b8..2704e0e6b1b 100644 --- a/cmd/workspace/environments/environments.go +++ b/cmd/workspace/environments/environments.go @@ -280,7 +280,8 @@ func newGetDefaultWorkspaceBaseEnvironment() *cobra.Command { Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU - compute. + compute. An unset CPU or GPU field means that compute type uses the Databricks + Standard base environment. Arguments: NAME: A static resource name of the default workspace base environment. Format: @@ -664,7 +665,9 @@ func newUpdateDefaultWorkspaceBaseEnvironment() *cobra.Command { Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or - GPU compute. + GPU compute. Unsetting a default makes that compute type use the Databricks + Standard base environment. The Standard base environment has no resource name, + so unsetting the field is the only way to select it. Arguments: NAME: The resource name of this singleton resource. Format: @@ -676,7 +679,10 @@ func newUpdateDefaultWorkspaceBaseEnvironment() *cobra.Command { To unset one or both defaults, include the field path(s) in the mask and omit them from the request body. To unset both, you must list both paths - explicitly — the wildcard '*' cannot be used to unset fields.` + explicitly — the wildcard '*' cannot be used to unset fields. Unsetting + a default makes that compute type use the Databricks Standard base + environment. The Standard base environment has no resource name, so + unsetting the field is the only way to select it.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/functions/functions.go b/cmd/workspace/functions/functions.go index 8220fde222b..f79bb9facd9 100644 --- a/cmd/workspace/functions/functions.go +++ b/cmd/workspace/functions/functions.go @@ -141,7 +141,7 @@ func newDelete() *cobra.Command { var deleteReq catalog.DeleteFunctionRequest - cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the function is notempty.`) + cmd.Flags().BoolVar(&deleteReq.Force, "force", deleteReq.Force, `Force deletion even if the function is not empty.`) cmd.Use = "delete NAME" cmd.Short = `Delete a function.` @@ -156,7 +156,7 @@ func newDelete() *cobra.Command { Arguments: NAME: The fully-qualified name of the function (of the form - __catalog_name__.__schema_name__.__function__name__) .` + __catalog_name__.__schema_name__.__function_name__).` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -175,14 +175,14 @@ func newDelete() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Functions drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) ") + id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) ") + return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") } deleteReq.Name = args[0] @@ -235,7 +235,7 @@ func newGet() *cobra.Command { Arguments: NAME: The fully-qualified name of the function (of the form - __catalog_name__.__schema_name__.__function__name__).` + __catalog_name__.__schema_name__.__function_name__).` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -254,14 +254,14 @@ func newGet() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Functions drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__)") + id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__)") + return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") } getReq.Name = args[0] @@ -412,7 +412,7 @@ func newUpdate() *cobra.Command { Arguments: NAME: The fully-qualified name of the function (of the form - __catalog_name__.__schema_name__.__function__name__).` + __catalog_name__.__schema_name__.__function_name__).` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -443,14 +443,14 @@ func newUpdate() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Functions drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__)") + id, err := cmdio.Select(ctx, names, "The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__)") + return errors.New("expected to have the fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function_name__)") } updateReq.Name = args[0] diff --git a/cmd/workspace/genie/genie.go b/cmd/workspace/genie/genie.go index 9fb0237d13f..1f4bf332467 100644 --- a/cmd/workspace/genie/genie.go +++ b/cmd/workspace/genie/genie.go @@ -872,8 +872,11 @@ func newGenieCreateEvalRun() *cobra.Command { Start a benchmark evaluation run. - Creates and runs chat-mode evaluations for multiple benchmark questions in a - Genie space. + Starts a benchmark evaluation run that asks Genie each selected benchmark + question in a Genie space and compares every response with the benchmark SQL. + The run executes asynchronously: the response is the new run with its current + status. If it is still running, poll with the get method until the status is + terminal. Arguments: SPACE_ID: The ID associated with the Genie space where the evaluations will be @@ -947,7 +950,10 @@ func newGenieGetEvalResultDetails() *cobra.Command { Get benchmark evaluation result details. - Get details for evaluation results. + Gets the full result for one benchmark question in an evaluation run: its + assessment and the reasons for it, Genie's response with the SQL execution + result, and the expected response from the benchmark. The result must belong + to the given run. Arguments: SPACE_ID: The ID associated with the Genie space where the evaluation run is @@ -1013,12 +1019,14 @@ func newGenieGetEvalRun() *cobra.Command { Get a benchmark evaluation run. - Get evaluation run details. + Gets the current status and summary counts of a benchmark evaluation run. Poll + this method until eval_run_status is terminal: DONE, EVALUATION_CANCELLED or + EVALUATION_TIMEOUT. Arguments: SPACE_ID: The ID associated with the Genie space where the evaluation run is located. - EVAL_RUN_ID: ` + EVAL_RUN_ID: The ID of the evaluation run, as returned when the run was created.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -1080,7 +1088,10 @@ func newGenieListEvalResults() *cobra.Command { List results for a benchmark evaluation run. - List evaluation results for a specific evaluation run. + Lists the results of a benchmark evaluation run, one per benchmark question. + Each entry carries the result status and a snapshot of the question and + benchmark answer; the assessment and Genie's response are available through + the result details method. Arguments: SPACE_ID: The ID associated with the Genie space where the evaluation run is @@ -1147,7 +1158,8 @@ func newGenieListEvalRuns() *cobra.Command { List benchmark evaluation runs. - Lists all evaluation runs in a space. + Lists the benchmark evaluation runs in a Genie space with the current status + and summary counts of each run. Arguments: SPACE_ID: The ID associated with the Genie space where the evaluation run is diff --git a/cmd/workspace/lakewatch/lakewatch.go b/cmd/workspace/lakewatch/lakewatch.go index f9df53e491b..f0e022d3196 100644 --- a/cmd/workspace/lakewatch/lakewatch.go +++ b/cmd/workspace/lakewatch/lakewatch.go @@ -138,7 +138,9 @@ Create a datasource. SCHEDULE: Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a request that sets schedule.enabled to false is rejected. Continuous schedules are not supported for Unity Catalog - connection datasources.` + connection datasources. For an existing-table datasource, runs must be no + further apart than the shorter of the source table's + delta.deletedFileRetentionDuration and delta.logRetentionDuration.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2171,7 +2173,9 @@ Update a datasource. SCHEDULE: Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a request that sets schedule.enabled to false is rejected. Continuous schedules are not supported for Unity Catalog - connection datasources.` + connection datasources. For an existing-table datasource, runs must be no + further apart than the shorter of the source table's + delta.deletedFileRetentionDuration and delta.logRetentionDuration.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" diff --git a/cmd/workspace/permissions/permissions.go b/cmd/workspace/permissions/permissions.go index 975069dfc10..5e92cedd51d 100644 --- a/cmd/workspace/permissions/permissions.go +++ b/cmd/workspace/permissions/permissions.go @@ -104,7 +104,10 @@ func newGet() *cobra.Command { genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses. - REQUEST_OBJECT_ID: The id of the request object.` + REQUEST_OBJECT_ID: The id of the object. It is the id that the object's own API uses, for + example the cluster id for clusters, the job id for jobs, and the + workspace object id for notebooks and directories. For the authorization + object type, use tokens to manage token permissions.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -170,7 +173,10 @@ func newGetPermissionLevels() *cobra.Command { genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses. - REQUEST_OBJECT_ID: ` + REQUEST_OBJECT_ID: The id of the object. It is the id that the object's own API uses, for + example the cluster id for clusters, the job id for jobs, and the + workspace object id for notebooks and directories. For the authorization + object type, use tokens to manage token permissions.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -232,9 +238,11 @@ func newSet() *cobra.Command { cmd.Short = `Set object permissions.` cmd.Long = `Set object permissions. - 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. + Sets permissions on an object, replacing all direct permissions with the ones + in the request. Principals that are not in the request lose their direct + permissions on the object, and all direct permissions are deleted if none are + specified. Objects can inherit permissions from their parent objects or root + object. Arguments: REQUEST_OBJECT_TYPE: The type of the request object. Can be one of the following: alerts, @@ -243,7 +251,10 @@ func newSet() *cobra.Command { genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses. - REQUEST_OBJECT_ID: The id of the request object.` + REQUEST_OBJECT_ID: The id of the object. It is the id that the object's own API uses, for + example the cluster id for clusters, the job id for jobs, and the + workspace object id for notebooks and directories. For the authorization + object type, use tokens to manage token permissions.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -317,8 +328,10 @@ func newUpdate() *cobra.Command { cmd.Short = `Update object permissions.` cmd.Long = `Update object permissions. - Updates the permissions on an object. Objects can inherit permissions from - their parent objects or root object. + Updates the permissions on an object by adding or changing the permissions of + the principals in the request. Principals that are not in the request keep + their existing permissions. Objects can inherit permissions from their parent + objects or root object. Arguments: REQUEST_OBJECT_TYPE: The type of the request object. Can be one of the following: alerts, @@ -327,7 +340,10 @@ func newUpdate() *cobra.Command { genie, instance-pools, jobs, knowledge-assistants, notebooks, pipelines, queries, registered-models, repos, serving-endpoints, supervisor-agents, vector-search-endpoints, or warehouses. - REQUEST_OBJECT_ID: The id of the request object.` + REQUEST_OBJECT_ID: The id of the object. It is the id that the object's own API uses, for + example the cluster id for clusters, the job id for jobs, and the + workspace object id for notebooks and directories. For the authorization + object type, use tokens to manage token permissions.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/pipelines/pipelines.go b/cmd/workspace/pipelines/pipelines.go index cf170bdb4b9..6c06c53be22 100644 --- a/cmd/workspace/pipelines/pipelines.go +++ b/cmd/workspace/pipelines/pipelines.go @@ -1188,7 +1188,7 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&updateReq.AllowDuplicateNames, "allow-duplicate-names", updateReq.AllowDuplicateNames, `If false, deployment will fail if name has changed and conflicts the name of another pipeline.`) + cmd.Flags().BoolVar(&updateReq.AllowDuplicateNames, "allow-duplicate-names", updateReq.AllowDuplicateNames, `If false, deployment will fail if name has changed and conflicts with the name of another pipeline.`) cmd.Flags().StringVar(&updateReq.BudgetPolicyId, "budget-policy-id", updateReq.BudgetPolicyId, `ID (UUID) of the serverless budget policy applied to this pipeline.`) cmd.Flags().StringVar(&updateReq.Catalog, "catalog", updateReq.Catalog, `A catalog in Unity Catalog to publish data from this pipeline to.`) cmd.Flags().StringVar(&updateReq.Channel, "channel", updateReq.Channel, `Release channel that selects the pipeline runtime version: CURRENT (the default) or PREVIEW, which runs on the upcoming runtime release.`) diff --git a/cmd/workspace/provider-files/provider-files.go b/cmd/workspace/provider-files/provider-files.go index d7b8f0afe8b..e4c2bcfc5ed 100644 --- a/cmd/workspace/provider-files/provider-files.go +++ b/cmd/workspace/provider-files/provider-files.go @@ -66,13 +66,15 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, ``) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `Name shown to consumers for the file, for example a notebook title.`) cmd.Use = "create" cmd.Short = `Create a file.` cmd.Long = `Create a file. - Create a file. Currently, only provider icons and attached notebooks are + Creates a file and returns a short-lived URL for uploading its content with an + HTTP PUT request. Only provider icons (PROVIDER_ICON files on a PROVIDER + parent) and sample notebooks (EMBEDDED_NOTEBOOK files on a LISTING parent) are supported.` cmd.Annotations = make(map[string]string) @@ -137,7 +139,10 @@ func newDelete() *cobra.Command { cmd.Short = `Delete a file.` cmd.Long = `Delete a file. - Delete a file` + Deletes a file. Fails if the file is still in use. + + Arguments: + FILE_ID: ID of the file to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -156,14 +161,14 @@ func newDelete() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Provider Files drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the file to delete") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the file to delete") } deleteReq.FileId = args[0] @@ -204,7 +209,10 @@ func newGet() *cobra.Command { cmd.Short = `Get a file.` cmd.Long = `Get a file. - Get a file` + Gets a file's metadata, including a short-lived download URL. + + Arguments: + FILE_ID: ID of the file.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -223,14 +231,14 @@ func newGet() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Provider Files drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the file") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the file") } getReq.FileId = args[0] @@ -275,7 +283,7 @@ func newList() *cobra.Command { cmd.Flags().Var(&listJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of results to return per page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) @@ -288,7 +296,7 @@ func newList() *cobra.Command { cmd.Short = `List files.` cmd.Long = `List files. - List files attached to a parent entity.` + Lists the files attached to a provider profile or a listing.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/provider-listings/provider-listings.go b/cmd/workspace/provider-listings/provider-listings.go index 3bab9cdeee7..495cab3cc05 100644 --- a/cmd/workspace/provider-listings/provider-listings.go +++ b/cmd/workspace/provider-listings/provider-listings.go @@ -71,7 +71,9 @@ func newCreate() *cobra.Command { cmd.Short = `Create a listing.` cmd.Long = `Create a listing. - Create a new listing` + Creates a listing under one of the caller's provider profiles. The listing + name, provider ID and visibility are required, and the caller must have access + to any share that the listing references. Returns the ID of the new listing.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -135,7 +137,12 @@ func newDelete() *cobra.Command { cmd.Short = `Delete a listing.` cmd.Long = `Delete a listing. - Delete a listing` + Deletes a listing permanently. The underlying share is not deleted, and + consumers who already have access to the share keep that access until it is + revoked in Delta Sharing. + + Arguments: + ID: ID of the listing to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -154,14 +161,14 @@ func newDelete() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Provider Listings drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the listing to delete") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the listing to delete") } deleteReq.Id = args[0] @@ -202,7 +209,7 @@ func newGet() *cobra.Command { cmd.Short = `Get a listing.` cmd.Long = `Get a listing. - Get a listing` + Gets a listing owned by one of the caller's provider profiles.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -270,7 +277,7 @@ func newList() *cobra.Command { // branches, so the method-call path is always reached. var listLimit int - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of results to return per page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) @@ -283,7 +290,7 @@ func newList() *cobra.Command { cmd.Short = `List listings.` cmd.Long = `List listings. - List listings owned by this provider` + Lists the listings owned by the provider profiles in the caller's account.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -343,7 +350,12 @@ func newUpdate() *cobra.Command { cmd.Short = `Update listing.` cmd.Long = `Update listing. - Update a listing` + Updates a listing. Send the full listing definition; the listing type cannot + be changed after the listing is created, and changing the share re-links the + listing to the new share. + + Arguments: + ID: ID of the listing to update.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go index 57d9521d651..5bfb05dcfdc 100644 --- a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go +++ b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go @@ -135,15 +135,25 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateReq.Reason, "reason", updateReq.Reason, ``) + cmd.Flags().StringVar(&updateReq.Reason, "reason", updateReq.Reason, `Message for the consumer that explains the status change, at most 255 characters.`) // TODO: complex arg: share cmd.Use = "update LISTING_ID REQUEST_ID STATUS" cmd.Short = `Update personalization request status.` cmd.Long = `Update personalization request status. - Update personalization request. This method only permits updating the status - of the request.` + Updates the status of a personalization request; other properties of the + request cannot be changed. Fulfilling a request grants the consumer access to + the share, and denying a fulfilled request revokes that access. The listing + must be published. + + Arguments: + LISTING_ID: ID of the listing that the request was made for. + REQUEST_ID: ID of the personalization request. + STATUS: New status of the request. Allowed transitions: NEW or REQUEST_PENDING to + REQUEST_PENDING, FULFILLED or DENIED; FULFILLED to DENIED; DENIED to + REQUEST_PENDING. + Supported values: [DENIED, FULFILLED, NEW, REQUEST_PENDING]` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go index d42c9b664c6..671493af735 100644 --- a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go +++ b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go @@ -61,8 +61,10 @@ func newCreate() *cobra.Command { cmd.Short = `Create provider analytics dashboard.` cmd.Long = `Create provider analytics dashboard. - Create provider analytics dashboard. Returns Marketplace specific id. Not to - be confused with the Lakeview dashboard id.` + Creates the Provider Analytics Dashboard in the caller's workspace from the + latest template. Fails if the dashboard already exists. Returns the + Marketplace-specific id of the dashboard record, which is distinct from the + AI/BI dashboard ID.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -105,7 +107,10 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get provider analytics dashboard.` - cmd.Long = `Get provider analytics dashboard.` + cmd.Long = `Get provider analytics dashboard. + + Gets the Provider Analytics Dashboard that was created for the caller's + account. Returns an empty response if the dashboard has not been created yet.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -148,7 +153,10 @@ func newGetLatestVersion() *cobra.Command { cmd.Use = "get-latest-version" cmd.Short = `Get latest version of provider analytics dashboard.` - cmd.Long = `Get latest version of provider analytics dashboard.` + cmd.Long = `Get latest version of provider analytics dashboard. + + Gets the latest available version of the Provider Analytics Dashboard + template.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -195,14 +203,19 @@ func newUpdate() *cobra.Command { cmd.Flags().Var(&updateJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().Int64Var(&updateReq.Version, "version", updateReq.Version, `this is the version of the dashboard template we want to update our user to current expectation is that it should be equal to latest version of the dashboard template.`) + cmd.Flags().Int64Var(&updateReq.Version, "version", updateReq.Version, `Version of the dashboard template to update to.`) cmd.Use = "update ID" cmd.Short = `Update provider analytics dashboard.` cmd.Long = `Update provider analytics dashboard. + Updates the Provider Analytics Dashboard to a newer version of the template. + The requested version must be newer than the version that the dashboard + currently uses. + Arguments: - ID: id is immutable property and can't be updated.` + ID: Marketplace-specific ID of the dashboard record, as returned when the + dashboard was created or retrieved.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/provider-providers/provider-providers.go b/cmd/workspace/provider-providers/provider-providers.go index c42c5bedae9..85c4f34dcc4 100644 --- a/cmd/workspace/provider-providers/provider-providers.go +++ b/cmd/workspace/provider-providers/provider-providers.go @@ -70,7 +70,8 @@ func newCreate() *cobra.Command { cmd.Short = `Create a provider.` cmd.Long = `Create a provider. - Create a provider` + Creates a provider profile in the caller's account. Returns the ID of the new + profile.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -134,7 +135,10 @@ func newDelete() *cobra.Command { cmd.Short = `Delete provider.` cmd.Long = `Delete provider. - Delete provider` + Deletes a provider profile and all of the listings that it owns. + + Arguments: + ID: ID of the provider profile to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -153,14 +157,14 @@ func newDelete() *cobra.Command { if err != nil { return fmt.Errorf("failed to load names for Provider Providers drop-down. Please manually specify required arguments. Original error: %w", err) } - id, err := cmdio.Select(ctx, names, "") + id, err := cmdio.Select(ctx, names, "ID of the provider profile to delete") if err != nil { return err } args = append(args, id) } if len(args) != 1 { - return errors.New("expected to have ") + return errors.New("expected to have id of the provider profile to delete") } deleteReq.Id = args[0] @@ -201,7 +205,7 @@ func newGet() *cobra.Command { cmd.Short = `Get provider.` cmd.Long = `Get provider. - Get provider profile` + Gets a provider profile by ID.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -269,7 +273,7 @@ func newList() *cobra.Command { // branches, so the method-call path is always reached. var listLimit int - cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, ``) + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of results to return per page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) @@ -282,7 +286,7 @@ func newList() *cobra.Command { cmd.Short = `List providers.` cmd.Long = `List providers. - List provider profiles for account.` + Lists the provider profiles in the caller's account.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -342,7 +346,10 @@ func newUpdate() *cobra.Command { cmd.Short = `Update provider.` cmd.Long = `Update provider. - Update provider profile` + Updates a provider profile. Send the full profile definition. + + Arguments: + ID: ID of the provider profile to update.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/secrets/secrets.go b/cmd/workspace/secrets/secrets.go index cb9ed89bf08..2d9d8ae12e8 100644 --- a/cmd/workspace/secrets/secrets.go +++ b/cmd/workspace/secrets/secrets.go @@ -84,7 +84,7 @@ func newCreateScope() *cobra.Command { // TODO: complex arg: backend_azure_keyvault cmd.Flags().StringVar(&createScopeReq.InitialManagePrincipal, "initial-manage-principal", createScopeReq.InitialManagePrincipal, `The principal that is initially granted MANAGE permission to the created scope.`) - cmd.Flags().Var(&createScopeReq.ScopeBackendType, "scope-backend-type", `The backend type the scope will be created with. Supported values: [AZURE_KEYVAULT, DATABRICKS]`) + cmd.Flags().Var(&createScopeReq.ScopeBackendType, "scope-backend-type", `The backend type of the new scope. Supported values: [AZURE_KEYVAULT, DATABRICKS]`) cmd.Use = "create-scope SCOPE" cmd.Short = `Create a new secret scope.` @@ -95,17 +95,6 @@ func newCreateScope() *cobra.Command { The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters. - Example request: - - .. code:: - - { "scope": "my-simple-databricks-scope", "initial_manage_principal": "users" - "scope_backend_type": "databricks|azure_keyvault", # below is only required if - scope type is azure_keyvault "backend_azure_keyvault": { "resource_id": - "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx", - "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dns_name": - "https://xxxx.vault.azure.net/", } } - If initial_manage_principal is specified, the initial ACL applied to the scope is applied to the supplied principal (user or group) with MANAGE permissions. The only supported principal for this option is the group @@ -114,19 +103,19 @@ func newCreateScope() *cobra.Command { permission applied to the scope is assigned to the API request issuer's user identity. - If scope_backend_type is azure_keyvault, a secret scope is created - with secrets from a given Azure KeyVault. The caller must provide the - keyvault_resource_id and the tenant_id for the key vault. If - scope_backend_type is databricks or is unspecified, an empty secret - scope is created and stored in Databricks's own storage. + If scope_backend_type is AZURE_KEYVAULT, a secret scope is created + with secrets from an existing Azure key vault. The caller must provide the key + vault's resource ID and DNS name in backend_azure_keyvault. If + scope_backend_type is DATABRICKS or is unspecified, an empty secret + scope is created and stored in Databricks-managed storage. Throws RESOURCE_ALREADY_EXISTS if a scope with the given name already exists. Throws RESOURCE_LIMIT_EXCEEDED if maximum number of scopes in the workspace is exceeded. Throws INVALID_PARAMETER_VALUE if the scope name is invalid. Throws BAD_REQUEST if request violated constraints. Throws - CUSTOMER_UNAUTHORIZED if normal user attempts to create a scope with name - reserved for databricks internal usage. Throws UNAUTHENTICATED if unable - to verify user access permission on Azure KeyVault + CUSTOMER_UNAUTHORIZED if the scope name is reserved for Databricks + internal use. Throws UNAUTHENTICATED if Databricks cannot verify the + caller's access to the Azure key vault. Arguments: SCOPE: Scope name requested by the user. Scope names are unique.` @@ -212,12 +201,6 @@ func newDeleteAcl() *cobra.Command { Users must have the MANAGE permission to invoke this API. - Example request: - - .. code:: - - { "scope": "my-secret-scope", "principal": "data-scientists" } - Throws RESOURCE_DOES_NOT_EXIST if no such secret scope, principal, or ACL exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws INVALID_PARAMETER_VALUE if the permission or @@ -309,16 +292,9 @@ func newDeleteScope() *cobra.Command { Deletes a secret scope. - Example request: - - .. code:: - - { "scope": "my-secret-scope" } - Throws RESOURCE_DOES_NOT_EXIST if the scope does not exist. Throws PERMISSION_DENIED if the user does not have permission to make this API - call. Throws BAD_REQUEST if system user attempts to delete internal secret - scope. + call. Arguments: SCOPE: Name of the scope to delete.` @@ -405,8 +381,8 @@ func newDeleteSecret() *cobra.Command { Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists. Throws PERMISSION_DENIED if the user does not have permission to make this - API call. Throws BAD_REQUEST if system user attempts to delete an internal - secret, or request is made against Azure KeyVault backed scope. + API call. Throws BAD_REQUEST if the request is made against an Azure Key + Vault-backed scope. Arguments: SCOPE: The name of the scope that contains the secret to delete. @@ -493,12 +469,6 @@ func newGetAcl() *cobra.Command { Users must have the MANAGE permission to invoke this API. - Example response: - - .. code:: - - { "principal": "data-scientists", "permission": "READ" } - Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws INVALID_PARAMETER_VALUE if the permission or principal is @@ -650,13 +620,6 @@ func newListAcls() *cobra.Command { Users must have the MANAGE permission to invoke this API. - Example response: - - .. code:: - - { "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": - "data-scientists", "permission": "READ" }] } - Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. @@ -729,13 +692,6 @@ func newListScopes() *cobra.Command { Lists all secret scopes available in the workspace. - Example response: - - .. code:: - - { "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" },{ - "name": "mount-points", "backend_type": "DATABRICKS" }] } - Throws PERMISSION_DENIED if the user does not have permission to make this API call.` @@ -878,33 +834,17 @@ func newPutAcl() *cobra.Command { READ - Allowed to read this secret scope and list what secrets are available. - Note that in general, secret values can only be read from within a command on - a cluster (for example, through a notebook). There is no API to read the - actual secret value material outside of a cluster. However, the user's - permission will be applied based on who is executing the command, and they - must have at least READ permission. - Users must have the MANAGE permission to invoke this API. - Example request: - - .. code:: - - { "scope": "my-secret-scope", "principal": "data-scientists", "permission": - "READ" } - - The principal is a user or group name corresponding to an existing Databricks - principal to be granted or revoked access. - Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws - RESOURCE_ALREADY_EXISTS if a permission for the principal already exists. - Throws INVALID_PARAMETER_VALUE if the permission or principal is invalid. - Throws PERMISSION_DENIED if the user does not have permission to make this - API call. + INVALID_PARAMETER_VALUE if the permission or principal is invalid. Throws + PERMISSION_DENIED if the user does not have permission to make this API + call. Arguments: SCOPE: The name of the scope to apply permissions to. - PRINCIPAL: The principal in which the permission is applied. + PRINCIPAL: The user name or group name of an existing Databricks principal that the + permission applies to. PERMISSION: The permission level applied to the principal. Supported values: [MANAGE, READ, WRITE]` diff --git a/cmd/workspace/software-artifacts/software-artifacts.go b/cmd/workspace/software-artifacts/software-artifacts.go index f2826554a33..8654b05ec94 100644 --- a/cmd/workspace/software-artifacts/software-artifacts.go +++ b/cmd/workspace/software-artifacts/software-artifacts.go @@ -41,6 +41,8 @@ Manage software artifacts and their versions in Unity Catalog.` } // Add methods + cmd.AddCommand(newDeleteSoftwareArtifact()) + cmd.AddCommand(newDeleteSoftwareArtifactVersion()) cmd.AddCommand(newGetSoftwareArtifact()) cmd.AddCommand(newGetSoftwareArtifactVersion()) cmd.AddCommand(newListSoftwareArtifactVersions()) @@ -54,6 +56,133 @@ Manage software artifacts and their versions in Unity Catalog.` } } +// start delete-software-artifact 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 deleteSoftwareArtifactOverrides []func( + *cobra.Command, + *softwareartifacts.DeleteSoftwareArtifactRequest, +) + +func newDeleteSoftwareArtifact() *cobra.Command { + cmd := &cobra.Command{} + + var deleteSoftwareArtifactReq softwareartifacts.DeleteSoftwareArtifactRequest + + cmd.Flags().BoolVar(&deleteSoftwareArtifactReq.Force, "force", deleteSoftwareArtifactReq.Force, `Force deletion even if the software artifact has versions, deleting them with it.`) + + cmd.Use = "delete-software-artifact NAME" + cmd.Short = `*Public Preview* Delete a software artifact.` + cmd.Long = `This command is in Public Preview and may change without notice. + +Delete a software artifact. + + Deletes a software artifact. Fails if the artifact still has versions unless + force is set. + + Arguments: + NAME: Resource name of the software artifact, of the form + software-artifacts/{catalog}.{schema}.{artifact}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Public Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + deleteSoftwareArtifactReq.Name = args[0] + + err = w.SoftwareArtifacts.DeleteSoftwareArtifact(ctx, deleteSoftwareArtifactReq) + if err != nil { + return err + } + return nil + } + + // 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 deleteSoftwareArtifactOverrides { + fn(cmd, &deleteSoftwareArtifactReq) + } + + return cmd +} + +// start delete-software-artifact-version 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 deleteSoftwareArtifactVersionOverrides []func( + *cobra.Command, + *softwareartifacts.DeleteSoftwareArtifactVersionRequest, +) + +func newDeleteSoftwareArtifactVersion() *cobra.Command { + cmd := &cobra.Command{} + + var deleteSoftwareArtifactVersionReq softwareartifacts.DeleteSoftwareArtifactVersionRequest + + cmd.Use = "delete-software-artifact-version NAME" + cmd.Short = `*Public Preview* Delete a software artifact version.` + cmd.Long = `This command is in Public Preview and may change without notice. + +Delete a software artifact version. + + Deletes a software artifact version. + + Arguments: + NAME: Resource name of the version, of the form + software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}, + where {version} is the version's content digest, for example + sha256:.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Public Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + deleteSoftwareArtifactVersionReq.Name = args[0] + + err = w.SoftwareArtifacts.DeleteSoftwareArtifactVersion(ctx, deleteSoftwareArtifactVersionReq) + if err != nil { + return err + } + return nil + } + + // 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 deleteSoftwareArtifactVersionOverrides { + fn(cmd, &deleteSoftwareArtifactVersionReq) + } + + return cmd +} + // start get-software-artifact command // Slice with functions to override default command behavior. diff --git a/cmd/workspace/tag-policies/tag-policies.go b/cmd/workspace/tag-policies/tag-policies.go index 92e2371dbbf..7fd89fec69e 100644 --- a/cmd/workspace/tag-policies/tag-policies.go +++ b/cmd/workspace/tag-policies/tag-policies.go @@ -73,7 +73,7 @@ func newCreateTagPolicy() *cobra.Command { cmd.Flags().Var(&createTagPolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createTagPolicyReq.TagPolicy.Description, "description", createTagPolicyReq.TagPolicy.Description, ``) + cmd.Flags().StringVar(&createTagPolicyReq.TagPolicy.Description, "description", createTagPolicyReq.TagPolicy.Description, `A description of the governed tag, such as its purpose or the meaning of its values.`) // TODO: array: values cmd.Use = "create-tag-policy TAG_KEY" @@ -85,7 +85,10 @@ func newCreateTagPolicy() *cobra.Command { permissions for tag policies, use the [Account Access Control Proxy API]. [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy - [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy` + [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy + + Arguments: + TAG_KEY: The tag key that this policy governs. Tag keys are case-sensitive.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -166,7 +169,10 @@ func newDeleteTagPolicy() *cobra.Command { key ungoverned. For Terraform usage, see the [Tag Policy Terraform documentation]. - [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy` + [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy + + Arguments: + TAG_KEY: The key of the governed tag whose policy to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -226,7 +232,10 @@ func newGetTagPolicy() *cobra.Command { permissions for tag policies, use the [Account Access Control Proxy API]. [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy - [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policy` + [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policy + + Arguments: + TAG_KEY: The key of the governed tag whose policy to get.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -357,7 +366,7 @@ func newUpdateTagPolicy() *cobra.Command { cmd.Flags().Var(&updateTagPolicyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateTagPolicyReq.TagPolicy.Description, "description", updateTagPolicyReq.TagPolicy.Description, ``) + cmd.Flags().StringVar(&updateTagPolicyReq.TagPolicy.Description, "description", updateTagPolicyReq.TagPolicy.Description, `A description of the governed tag, such as its purpose or the meaning of its values.`) // TODO: array: values cmd.Use = "update-tag-policy TAG_KEY UPDATE_MASK" @@ -372,18 +381,10 @@ func newUpdateTagPolicy() *cobra.Command { [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy Arguments: - TAG_KEY: - UPDATE_MASK: 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. - - A 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.` + TAG_KEY: The tag key that this policy governs. Tag keys are case-sensitive. + UPDATE_MASK: The comma-separated list of tag policy fields to update. When the mask + includes values, the values in the request replace all existing allowed + values.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/warehouses/warehouses.go b/cmd/workspace/warehouses/warehouses.go index df8e63a9628..c9c1b4490b8 100644 --- a/cmd/workspace/warehouses/warehouses.go +++ b/cmd/workspace/warehouses/warehouses.go @@ -93,17 +93,17 @@ func newCreate() *cobra.Command { cmd.Flags().IntVar(&createReq.AutoStopMins, "auto-stop-mins", createReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.`) // TODO: complex arg: channel cmd.Flags().StringVar(&createReq.ClusterSize, "cluster-size", createReq.ClusterSize, `Size of the clusters allocated for this warehouse.`) - cmd.Flags().StringVar(&createReq.CreatorName, "creator-name", createReq.CreatorName, `warehouse creator name.`) + cmd.Flags().StringVar(&createReq.CreatorName, "creator-name", createReq.CreatorName, `Name of the user who created the warehouse.`) cmd.Flags().BoolVar(&createReq.EnablePhoton, "enable-photon", createReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters.`) cmd.Flags().BoolVar(&createReq.EnableServerlessCompute, "enable-serverless-compute", createReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute.`) cmd.Flags().StringVar(&createReq.InstanceProfileArn, "instance-profile-arn", createReq.InstanceProfileArn, `Deprecated.`) cmd.Flags().IntVar(&createReq.MaxDbu, "max-dbu", createReq.MaxDbu, `Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.`) cmd.Flags().IntVar(&createReq.MaxNumClusters, "max-num-clusters", createReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries.`) cmd.Flags().IntVar(&createReq.MinNumClusters, "min-num-clusters", createReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Logical name for the cluster.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `Logical name for the warehouse.`) cmd.Flags().Float64Var(&createReq.ReydenClusterSizeMultiplier, "reyden-cluster-size-multiplier", createReq.ReydenClusterSizeMultiplier, `Cluster size multiplier for Reyden warehouses.`) - cmd.Flags().Var(&createReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) - cmd.Flags().IntVar(&createReq.StatementTimeout, "statement-timeout", createReq.StatementTimeout, `Warehouse statement timeout in seconds.`) + cmd.Flags().Var(&createReq.SpotInstancePolicy, "spot-instance-policy", `Configures whether the warehouse should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) + cmd.Flags().IntVar(&createReq.StatementTimeout, "statement-timeout", createReq.StatementTimeout, `Maximum time in seconds that a statement can run on this warehouse before it is cancelled.`) // TODO: complex arg: tags cmd.Flags().Var(&createReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, REALTIME, TYPE_UNSPECIFIED]`) @@ -450,17 +450,17 @@ func newEdit() *cobra.Command { cmd.Flags().IntVar(&editReq.AutoStopMins, "auto-stop-mins", editReq.AutoStopMins, `The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.`) // TODO: complex arg: channel cmd.Flags().StringVar(&editReq.ClusterSize, "cluster-size", editReq.ClusterSize, `Size of the clusters allocated for this warehouse.`) - cmd.Flags().StringVar(&editReq.CreatorName, "creator-name", editReq.CreatorName, `warehouse creator name.`) + cmd.Flags().StringVar(&editReq.CreatorName, "creator-name", editReq.CreatorName, `Name of the user who created the warehouse.`) cmd.Flags().BoolVar(&editReq.EnablePhoton, "enable-photon", editReq.EnablePhoton, `Configures whether the warehouse should use Photon optimized clusters.`) cmd.Flags().BoolVar(&editReq.EnableServerlessCompute, "enable-serverless-compute", editReq.EnableServerlessCompute, `Configures whether the warehouse should use serverless compute.`) cmd.Flags().StringVar(&editReq.InstanceProfileArn, "instance-profile-arn", editReq.InstanceProfileArn, `Deprecated.`) cmd.Flags().IntVar(&editReq.MaxDbu, "max-dbu", editReq.MaxDbu, `Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.`) cmd.Flags().IntVar(&editReq.MaxNumClusters, "max-num-clusters", editReq.MaxNumClusters, `Maximum number of clusters that the autoscaler will create to handle concurrent queries.`) cmd.Flags().IntVar(&editReq.MinNumClusters, "min-num-clusters", editReq.MinNumClusters, `Minimum number of available clusters that will be maintained for this SQL warehouse.`) - cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Logical name for the cluster.`) + cmd.Flags().StringVar(&editReq.Name, "name", editReq.Name, `Logical name for the warehouse.`) cmd.Flags().Float64Var(&editReq.ReydenClusterSizeMultiplier, "reyden-cluster-size-multiplier", editReq.ReydenClusterSizeMultiplier, `Cluster size multiplier for Reyden warehouses.`) - cmd.Flags().Var(&editReq.SpotInstancePolicy, "spot-instance-policy", `Configurations whether the endpoint should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) - cmd.Flags().IntVar(&editReq.StatementTimeout, "statement-timeout", editReq.StatementTimeout, `Warehouse statement timeout in seconds.`) + cmd.Flags().Var(&editReq.SpotInstancePolicy, "spot-instance-policy", `Configures whether the warehouse should use spot instances. Supported values: [COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED]`) + cmd.Flags().IntVar(&editReq.StatementTimeout, "statement-timeout", editReq.StatementTimeout, `Maximum time in seconds that a statement can run on this warehouse before it is cancelled.`) // TODO: complex arg: tags cmd.Flags().Var(&editReq.WarehouseType, "warehouse-type", `Warehouse type: PRO or CLASSIC. Supported values: [CLASSIC, PRO, REALTIME, TYPE_UNSPECIFIED]`) @@ -1146,7 +1146,7 @@ func newSetWorkspaceWarehouseConfig() *cobra.Command { cmd.Flags().BoolVar(&setWorkspaceWarehouseConfigReq.EnableServerlessCompute, "enable-serverless-compute", setWorkspaceWarehouseConfigReq.EnableServerlessCompute, `Deprecated: only setting this to true is allowed.`) // TODO: array: enabled_warehouse_types // TODO: complex arg: global_param - cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.GoogleServiceAccount, "google-service-account", setWorkspaceWarehouseConfigReq.GoogleServiceAccount, `GCP only: Google Service Account used to pass to cluster to access Google Cloud Storage.`) + cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.GoogleServiceAccount, "google-service-account", setWorkspaceWarehouseConfigReq.GoogleServiceAccount, `GCP only: Google service account that the warehouse clusters use to access Google Cloud Storage.`) cmd.Flags().StringVar(&setWorkspaceWarehouseConfigReq.InstanceProfileArn, "instance-profile-arn", setWorkspaceWarehouseConfigReq.InstanceProfileArn, `AWS Only: The instance profile used to pass an IAM role to the SQL warehouses.`) cmd.Flags().Var(&setWorkspaceWarehouseConfigReq.SecurityPolicy, "security-policy", `Security policy for warehouses. Supported values: [DATA_ACCESS_CONTROL, NONE, PASSTHROUGH]`) // TODO: complex arg: sql_configuration_parameters diff --git a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go index c52a23dc6ea..1f832d0a316 100644 --- a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go +++ b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go @@ -65,11 +65,11 @@ func newGetPublicWorkspaceSetting() *cobra.Command { cmd.Long = `Get a workspace setting. Get a setting value at workspace level. See - :method:settingsv2/listworkspacesettingsmetadata for list of setting available - via public APIs. + :method:settingsv2/listworkspacesettingsmetadata for the list of settings + available via public APIs. Arguments: - NAME: Name of the setting` + NAME: Name of the setting to retrieve.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -230,15 +230,15 @@ func newPatchPublicWorkspaceSetting() *cobra.Command { cmd.Long = `Update a workspace setting. Patch a setting value at workspace level. See - :method:settingsv2/listworkspacesettingsmetadata for list of setting available - via public APIs at workspace level. To 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. + :method:settingsv2/listworkspacesettingsmetadata for the list of settings + available via public APIs at workspace level. To 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. Note: Page refresh is required for changes to take effect in UI. Arguments: - NAME: Name of the setting` + NAME: Name of the setting to update.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/go.mod b/go.mod index 1c6562f5ad4..e3819ac2de9 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/charmbracelet/huh v1.0.0 // MIT github.com/charmbracelet/lipgloss v1.1.0 // MIT github.com/charmbracelet/x/ansi v0.11.9 // MIT - github.com/databricks/databricks-sdk-go v0.201.0 // Apache-2.0 + github.com/databricks/databricks-sdk-go v0.202.0 // Apache-2.0 github.com/databricks/sdk-go/auth v0.2.0 // Apache-2.0 github.com/databricks/sdk-go/core v0.1.0 // Apache-2.0 github.com/databricks/sdk-go/files v0.3.0 // Apache-2.0 diff --git a/go.sum b/go.sum index 351293ac058..1a36270fb94 100644 --- a/go.sum +++ b/go.sum @@ -60,8 +60,8 @@ github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s= github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE= github.com/danieljoos/wincred v1.2.3 h1:v7dZC2x32Ut3nEfRH+vhoZGvN72+dQ/snVXo/vMFLdQ= github.com/danieljoos/wincred v1.2.3/go.mod h1:6qqX0WNrS4RzPZ1tnroDzq9kY3fu1KwE7MRLQK4X0bs= -github.com/databricks/databricks-sdk-go v0.201.0 h1:Orw6QUTk7UqVdGcctLtZPnm4BsC7a25vVEWB3a+Mr54= -github.com/databricks/databricks-sdk-go v0.201.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= +github.com/databricks/databricks-sdk-go v0.202.0 h1:5+lPRISQy0y/XCyg9qLUoTQgkENkV9yDOr/IwOeaVjc= +github.com/databricks/databricks-sdk-go v0.202.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= github.com/databricks/sdk-go/auth v0.2.0 h1:543fVMvJ6pVxBymfjGGkkmfiHDbUqX7y9lZseEcE4tQ= github.com/databricks/sdk-go/auth v0.2.0/go.mod h1:eNJdFzBAfu1y32a3wPcTnjaUkjhS9VfyCNblKFPIPEo= github.com/databricks/sdk-go/core v0.1.0 h1:ZolzW/KVIJy1xXQ0zTsu/QYsEB4vQAEApbbq4D3RGHc= diff --git a/python/databricks/bundles/data_quality_monitors/_models/anomaly_detection_config.py b/python/databricks/bundles/data_quality_monitors/_models/anomaly_detection_config.py index 795940e34f7..fdddb3f15c4 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/anomaly_detection_config.py +++ b/python/databricks/bundles/data_quality_monitors/_models/anomaly_detection_config.py @@ -25,7 +25,7 @@ class AnomalyDetectionConfig: """ :meta private: [EXPERIMENTAL] - [Beta] List of fully qualified table names to exclude from anomaly detection. + [Beta] List of fully qualified table names to exclude from anomaly detection. Format: `catalog.schema.table_name`. """ notification_settings: VariableOrOptional[NotificationSettings] = None @@ -58,7 +58,7 @@ class AnomalyDetectionConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Beta] List of fully qualified table names to exclude from anomaly detection. + [Beta] List of fully qualified table names to exclude from anomaly detection. Format: `catalog.schema.table_name`. """ notification_settings: VariableOrOptional[NotificationSettingsParam] diff --git a/python/databricks/bundles/data_quality_monitors/_models/cron_schedule.py b/python/databricks/bundles/data_quality_monitors/_models/cron_schedule.py index adea369a164..d2dfd097352 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/cron_schedule.py +++ b/python/databricks/bundles/data_quality_monitors/_models/cron_schedule.py @@ -24,9 +24,8 @@ class CronSchedule: timezone_id: VariableOr[str] """ - A Java timezone id. The schedule for a job will be resolved with respect to this timezone. - See `Java TimeZone `_ for details. - The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression. + The Java timezone ID in which the cron expression is evaluated. See + [Java TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html) for the supported IDs. """ @classmethod @@ -47,9 +46,8 @@ class CronScheduleDict(TypedDict, total=False): timezone_id: VariableOr[str] """ - A Java timezone id. The schedule for a job will be resolved with respect to this timezone. - See `Java TimeZone `_ for details. - The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression. + The Java timezone ID in which the cron expression is evaluated. See + [Java TimeZone](https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html) for the supported IDs. """ diff --git a/python/databricks/bundles/data_quality_monitors/_models/data_profiling_config.py b/python/databricks/bundles/data_quality_monitors/_models/data_profiling_config.py index 0b1038597dd..e78d048b810 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/data_profiling_config.py +++ b/python/databricks/bundles/data_quality_monitors/_models/data_profiling_config.py @@ -47,42 +47,47 @@ class DataProfilingConfig: output_schema_id: VariableOr[str] """ - ID of the schema where output tables are created. + The UUID of the Unity Catalog schema where the profile and drift metrics tables + are created. """ assets_dir: VariableOrOptional[str] = None """ - Field for specifying the absolute path to a custom directory to store data-monitoring - assets. Normally prepopulated to a default user location via UI and Python APIs. + The absolute workspace path of the directory where the monitor's assets, such as + the dashboard, are stored. The UI and the Python APIs normally prepopulate a default user location. """ baseline_table_name: VariableOrOptional[str] = None """ - Baseline table name. - Baseline data is used to compute drift from the data in the monitored `table_name`. - The baseline table and the monitored table shall have the same schema. + The fully qualified name of a baseline table. Format: `catalog.schema.table_name`. + Drift metrics compare the monitored table against the baseline data, so the two tables must have the same + schema. """ custom_metrics: VariableOrList[DataProfilingCustomMetric] = field( default_factory=list ) """ - Custom metrics. + Custom metrics to compute in addition to the built-in ones. See + [custom metrics](https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics). """ inference_log: VariableOrOptional[InferenceLogConfig] = None """ - `Analysis Configuration` for monitoring inference log tables. + Profiles an inference log table, which stores the requests and predictions of a model. Metrics are + computed per time window and include model quality metrics. """ notification_settings: VariableOrOptional[NotificationSettings] = None """ - Field for specifying notification settings. + Who to notify about this monitor's refreshes. Only `on_failure` with + `email_addresses` is supported here. """ schedule: VariableOrOptional[CronSchedule] = None """ - The cron schedule. + The schedule on which the monitor refreshes its metrics. Refreshes can also be + triggered on demand through the Refresh resource. """ skip_builtin_dashboard: VariableOrOptional[bool] = None @@ -94,26 +99,27 @@ class DataProfilingConfig: """ List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its - complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the following + complements. For example `slicing_exprs=["col_1", "col_2 > 10"]` will generate the following slices: two slices for `col_2 > 10` (True and False), and one slice per unique value in - `col1`. For high-cardinality columns, only the top 100 unique values by frequency will + `col_1`. For high-cardinality columns, only the top 100 unique values by frequency will generate slices. """ snapshot: VariableOrOptional[SnapshotConfig] = None """ - `Analysis Configuration` for monitoring snapshot tables. + Profiles the full contents of the table. Metrics are computed over all rows at each refresh. """ time_series: VariableOrOptional[TimeSeriesConfig] = None """ - `Analysis Configuration` for monitoring time series tables. + Profiles a time series table. Metrics are computed per time window, as defined by `timestamp_column` + and `granularities`. """ warehouse_id: VariableOrOptional[str] = None """ - Optional argument to specify the warehouse for dashboard creation. If not specified, the first running - warehouse will be used. + The ID of the SQL warehouse used to create the dashboard. If not specified, the first running warehouse the + caller can access is used. """ @classmethod @@ -129,40 +135,45 @@ class DataProfilingConfigDict(TypedDict, total=False): output_schema_id: VariableOr[str] """ - ID of the schema where output tables are created. + The UUID of the Unity Catalog schema where the profile and drift metrics tables + are created. """ assets_dir: VariableOrOptional[str] """ - Field for specifying the absolute path to a custom directory to store data-monitoring - assets. Normally prepopulated to a default user location via UI and Python APIs. + The absolute workspace path of the directory where the monitor's assets, such as + the dashboard, are stored. The UI and the Python APIs normally prepopulate a default user location. """ baseline_table_name: VariableOrOptional[str] """ - Baseline table name. - Baseline data is used to compute drift from the data in the monitored `table_name`. - The baseline table and the monitored table shall have the same schema. + The fully qualified name of a baseline table. Format: `catalog.schema.table_name`. + Drift metrics compare the monitored table against the baseline data, so the two tables must have the same + schema. """ custom_metrics: VariableOrList[DataProfilingCustomMetricParam] """ - Custom metrics. + Custom metrics to compute in addition to the built-in ones. See + [custom metrics](https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics). """ inference_log: VariableOrOptional[InferenceLogConfigParam] """ - `Analysis Configuration` for monitoring inference log tables. + Profiles an inference log table, which stores the requests and predictions of a model. Metrics are + computed per time window and include model quality metrics. """ notification_settings: VariableOrOptional[NotificationSettingsParam] """ - Field for specifying notification settings. + Who to notify about this monitor's refreshes. Only `on_failure` with + `email_addresses` is supported here. """ schedule: VariableOrOptional[CronScheduleParam] """ - The cron schedule. + The schedule on which the monitor refreshes its metrics. Refreshes can also be + triggered on demand through the Refresh resource. """ skip_builtin_dashboard: VariableOrOptional[bool] @@ -174,26 +185,27 @@ class DataProfilingConfigDict(TypedDict, total=False): """ List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its - complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the following + complements. For example `slicing_exprs=["col_1", "col_2 > 10"]` will generate the following slices: two slices for `col_2 > 10` (True and False), and one slice per unique value in - `col1`. For high-cardinality columns, only the top 100 unique values by frequency will + `col_1`. For high-cardinality columns, only the top 100 unique values by frequency will generate slices. """ snapshot: VariableOrOptional[SnapshotConfigParam] """ - `Analysis Configuration` for monitoring snapshot tables. + Profiles the full contents of the table. Metrics are computed over all rows at each refresh. """ time_series: VariableOrOptional[TimeSeriesConfigParam] """ - `Analysis Configuration` for monitoring time series tables. + Profiles a time series table. Metrics are computed per time window, as defined by `timestamp_column` + and `granularities`. """ warehouse_id: VariableOrOptional[str] """ - Optional argument to specify the warehouse for dashboard creation. If not specified, the first running - warehouse will be used. + The ID of the SQL warehouse used to create the dashboard. If not specified, the first running warehouse the + caller can access is used. """ diff --git a/python/databricks/bundles/data_quality_monitors/_models/data_profiling_custom_metric.py b/python/databricks/bundles/data_quality_monitors/_models/data_profiling_custom_metric.py index a94edb8e38e..fba69111e39 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/data_profiling_custom_metric.py +++ b/python/databricks/bundles/data_quality_monitors/_models/data_profiling_custom_metric.py @@ -33,18 +33,22 @@ class DataProfilingCustomMetric: output_data_type: VariableOr[str] """ - The output type of the custom metric. + Specifies the Spark SQL data type of the metric value, either as a plain type name or as a JSON-encoded + StructField. """ type: VariableOr[DataProfilingCustomMetricType] """ - The type of the custom metric. + The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` metrics depend only on the + columns of the input table, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics depend only on previously + computed aggregate metrics, and `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` metrics depend on previously computed + aggregate or derived metrics. """ input_columns: VariableOrList[str] = field(default_factory=list) """ A list of column names in the input table the metric should be computed for. - Can use ``":table"`` to indicate that the metric needs information from multiple columns. + Can use `":table"` to indicate that the metric needs information from multiple columns. """ @classmethod @@ -70,18 +74,22 @@ class DataProfilingCustomMetricDict(TypedDict, total=False): output_data_type: VariableOr[str] """ - The output type of the custom metric. + Specifies the Spark SQL data type of the metric value, either as a plain type name or as a JSON-encoded + StructField. """ type: VariableOr[DataProfilingCustomMetricTypeParam] """ - The type of the custom metric. + The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` metrics depend only on the + columns of the input table, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics depend only on previously + computed aggregate metrics, and `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` metrics depend on previously computed + aggregate or derived metrics. """ input_columns: VariableOrList[str] """ A list of column names in the input table the metric should be computed for. - Can use ``":table"`` to indicate that the metric needs information from multiple columns. + Can use `":table"` to indicate that the metric needs information from multiple columns. """ diff --git a/python/databricks/bundles/data_quality_monitors/_models/data_quality_monitor.py b/python/databricks/bundles/data_quality_monitors/_models/data_quality_monitor.py index e909ae238b5..17cb6817bdc 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/data_quality_monitor.py +++ b/python/databricks/bundles/data_quality_monitors/_models/data_quality_monitor.py @@ -27,7 +27,9 @@ @dataclass(kw_only=True) class DataQualityMonitor(Resource): """ - Monitor for the data quality of unity catalog entities such as schema or table. + A data quality monitor on a Unity Catalog object. A `schema` monitor runs anomaly detection on the tables in the + schema and is configured through `anomaly_detection_config`. A `table` monitor profiles a single table and is + configured through `data_profiling_config`. """ object_id: VariableOr[str] @@ -50,13 +52,14 @@ class DataQualityMonitor(Resource): anomaly_detection_config: VariableOrOptional[AnomalyDetectionConfig] = None """ - Anomaly Detection Configuration, applicable to `schema` object types. + Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds + the settings of the parent schema's monitor if the schema has one. """ data_profiling_config: VariableOrOptional[DataProfilingConfig] = None """ - Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration` - must be present. + Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series` + or `snapshot` must be set. """ lifecycle: VariableOrOptional[Lifecycle] = None @@ -95,13 +98,14 @@ class DataQualityMonitorDict(TypedDict, total=False): anomaly_detection_config: VariableOrOptional[AnomalyDetectionConfigParam] """ - Anomaly Detection Configuration, applicable to `schema` object types. + Anomaly detection settings. Required when `object_type` is `schema`. When reading a `table` monitor, this holds + the settings of the parent schema's monitor if the schema has one. """ data_profiling_config: VariableOrOptional[DataProfilingConfigParam] """ - Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration` - must be present. + Data profiling settings. Required when `object_type` is `table`. Exactly one of `inference_log`, `time_series` + or `snapshot` must be set. """ lifecycle: VariableOrOptional[LifecycleParam] diff --git a/python/databricks/bundles/data_quality_monitors/_models/inference_log_config.py b/python/databricks/bundles/data_quality_monitors/_models/inference_log_config.py index dd58100c3ef..bb82d05ee80 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/inference_log_config.py +++ b/python/databricks/bundles/data_quality_monitors/_models/inference_log_config.py @@ -31,22 +31,24 @@ class InferenceLogConfig: model_id_column: VariableOr[str] """ - Column for the model identifier. + Column containing the ID of the model that produced each prediction. A slice is created automatically for + each distinct model ID. """ prediction_column: VariableOr[str] """ - Column for the prediction. + Column containing the model's predicted values. """ problem_type: VariableOr[InferenceProblemType] """ - Problem type the model aims to solve. + The type of problem the model solves. It determines which model quality metrics are computed. """ timestamp_column: VariableOr[str] """ - Column for the timestamp. + Column containing the timestamp of each inference request. Its type must be TIMESTAMP or convertible to a + timestamp. """ granularities: VariableOrList[AggregationGranularity] = field(default_factory=list) @@ -56,7 +58,7 @@ class InferenceLogConfig: label_column: VariableOrOptional[str] = None """ - Column for the label. + Column containing the ground truth for the model's predictions. """ @classmethod @@ -72,22 +74,24 @@ class InferenceLogConfigDict(TypedDict, total=False): model_id_column: VariableOr[str] """ - Column for the model identifier. + Column containing the ID of the model that produced each prediction. A slice is created automatically for + each distinct model ID. """ prediction_column: VariableOr[str] """ - Column for the prediction. + Column containing the model's predicted values. """ problem_type: VariableOr[InferenceProblemTypeParam] """ - Problem type the model aims to solve. + The type of problem the model solves. It determines which model quality metrics are computed. """ timestamp_column: VariableOr[str] """ - Column for the timestamp. + Column containing the timestamp of each inference request. Its type must be TIMESTAMP or convertible to a + timestamp. """ granularities: VariableOrList[AggregationGranularityParam] @@ -97,7 +101,7 @@ class InferenceLogConfigDict(TypedDict, total=False): label_column: VariableOrOptional[str] """ - Column for the label. + Column containing the ground truth for the model's predictions. """ diff --git a/python/databricks/bundles/data_quality_monitors/_models/notification_destination.py b/python/databricks/bundles/data_quality_monitors/_models/notification_destination.py index c122219a2c0..27cf61f60b7 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/notification_destination.py +++ b/python/databricks/bundles/data_quality_monitors/_models/notification_destination.py @@ -34,6 +34,7 @@ class NotificationDestination: email_addresses: VariableOrList[str] = field(default_factory=list) """ The list of email addresses to send the notification to. A maximum of 5 email addresses is supported. + Only supported on table monitors, via `data_profiling_config`; rejected on schema monitors. """ @classmethod @@ -64,6 +65,7 @@ class NotificationDestinationDict(TypedDict, total=False): email_addresses: VariableOrList[str] """ The list of email addresses to send the notification to. A maximum of 5 email addresses is supported. + Only supported on table monitors, via `data_profiling_config`; rejected on schema monitors. """ diff --git a/python/databricks/bundles/data_quality_monitors/_models/notification_settings.py b/python/databricks/bundles/data_quality_monitors/_models/notification_settings.py index 2e9852b2279..fc62c461de6 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/notification_settings.py +++ b/python/databricks/bundles/data_quality_monitors/_models/notification_settings.py @@ -23,7 +23,8 @@ class NotificationSettings: on_failure: VariableOrOptional[NotificationDestination] = None """ - Destinations to send notifications on failure/timeout. + Recipients to notify when a refresh of the monitor fails or times out. Only supported on table + monitors, via `data_profiling_config`, and only `email_addresses` is accepted there. """ on_unhealthy_table: VariableOrOptional[NotificationDestination] = None @@ -46,7 +47,8 @@ class NotificationSettingsDict(TypedDict, total=False): on_failure: VariableOrOptional[NotificationDestinationParam] """ - Destinations to send notifications on failure/timeout. + Recipients to notify when a refresh of the monitor fails or times out. Only supported on table + monitors, via `data_profiling_config`, and only `email_addresses` is accepted there. """ on_unhealthy_table: VariableOrOptional[NotificationDestinationParam] diff --git a/python/databricks/bundles/data_quality_monitors/_models/time_series_config.py b/python/databricks/bundles/data_quality_monitors/_models/time_series_config.py index eef393818a6..1c6fbd4eda9 100644 --- a/python/databricks/bundles/data_quality_monitors/_models/time_series_config.py +++ b/python/databricks/bundles/data_quality_monitors/_models/time_series_config.py @@ -23,7 +23,7 @@ class TimeSeriesConfig: timestamp_column: VariableOr[str] """ - Column for the timestamp. + Column containing the timestamp of each row. Its type must be TIMESTAMP or convertible to a timestamp. """ granularities: VariableOrList[AggregationGranularity] = field(default_factory=list) @@ -44,7 +44,7 @@ class TimeSeriesConfigDict(TypedDict, total=False): timestamp_column: VariableOr[str] """ - Column for the timestamp. + Column containing the timestamp of each row. Its type must be TIMESTAMP or convertible to a timestamp. """ granularities: VariableOrList[AggregationGranularityParam] diff --git a/python/databricks/bundles/jobs/_models/ai_runtime_task_priority_class.py b/python/databricks/bundles/jobs/_models/ai_runtime_task_priority_class.py index c2f84db1f18..4cc5ac42164 100644 --- a/python/databricks/bundles/jobs/_models/ai_runtime_task_priority_class.py +++ b/python/databricks/bundles/jobs/_models/ai_runtime_task_priority_class.py @@ -12,10 +12,8 @@ class AiRuntimeTaskPriorityClass(Enum): when the scheduler ranks pending work. """ - BEST_EFFORT = "BEST_EFFORT" NORMAL = "NORMAL" + HIGH = "HIGH" -AiRuntimeTaskPriorityClassParam = ( - Literal["BEST_EFFORT", "NORMAL"] | AiRuntimeTaskPriorityClass -) +AiRuntimeTaskPriorityClassParam = Literal["NORMAL", "HIGH"] | AiRuntimeTaskPriorityClass diff --git a/python/databricks/bundles/jobs/_models/job.py b/python/databricks/bundles/jobs/_models/job.py index 1b43b3ce184..b184e4bfa60 100644 --- a/python/databricks/bundles/jobs/_models/job.py +++ b/python/databricks/bundles/jobs/_models/job.py @@ -186,7 +186,9 @@ class Job(Resource): """ :meta private: [EXPERIMENTAL] - [Private Preview] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object. + [Beta] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder. + + Example: /Workspace/Projects/my_project """ performance_target: VariableOrOptional[PerformanceTarget] = None @@ -382,7 +384,9 @@ class JobDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object. + [Beta] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a parent folder. + + Example: /Workspace/Projects/my_project """ performance_target: VariableOrOptional[PerformanceTargetParam] diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index c8efe551d4f..4d77c089876 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -66,6 +66,10 @@ class Pipeline(Resource): allow_duplicate_names: VariableOrOptional[bool] = None """ If false, deployment will fail if name conflicts with that of another pipeline. + + Ignored when `parent_path` is set. A pipeline in a workspace folder must have a name that is + unique within that folder, and creation fails if the folder already contains an object with the + same name. """ budget_policy_id: VariableOrOptional[str] = None @@ -189,9 +193,11 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - [Private Preview] Path of the pipeline parent folder in workspace file tree. + [Beta] Path of the pipeline parent folder in workspace file tree. + + If absent, the pipeline doesn't have a parent folder. - If absent, the pipeline doesn't have a workspace object. + Example: /Workspace/Projects/my_project """ permissions: VariableOrList[PipelinePermission] = field(default_factory=list) @@ -290,6 +296,10 @@ class PipelineDict(TypedDict, total=False): allow_duplicate_names: VariableOrOptional[bool] """ If false, deployment will fail if name conflicts with that of another pipeline. + + Ignored when `parent_path` is set. A pipeline in a workspace folder must have a name that is + unique within that folder, and creation fails if the folder already contains an object with the + same name. """ budget_policy_id: VariableOrOptional[str] @@ -413,9 +423,11 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] Path of the pipeline parent folder in workspace file tree. + [Beta] Path of the pipeline parent folder in workspace file tree. + + If absent, the pipeline doesn't have a parent folder. - If absent, the pipeline doesn't have a workspace object. + Example: /Workspace/Projects/my_project """ permissions: VariableOrList[PipelinePermissionParam] diff --git a/python/databricks/bundles/secret_scopes/_models/azure_key_vault_secret_scope_metadata.py b/python/databricks/bundles/secret_scopes/_models/azure_key_vault_secret_scope_metadata.py index ceedb8b2ec4..ac284fe1fb5 100644 --- a/python/databricks/bundles/secret_scopes/_models/azure_key_vault_secret_scope_metadata.py +++ b/python/databricks/bundles/secret_scopes/_models/azure_key_vault_secret_scope_metadata.py @@ -19,12 +19,12 @@ class AzureKeyVaultSecretScopeMetadata: dns_name: VariableOr[str] """ - The DNS of the KeyVault + The DNS name of the key vault, for example ``https://my-key-vault.vault.azure.net/``. """ resource_id: VariableOr[str] """ - The resource id of the azure KeyVault that user wants to associate the scope with. + The Azure resource ID of the key vault to associate with the scope. """ @classmethod @@ -40,12 +40,12 @@ class AzureKeyVaultSecretScopeMetadataDict(TypedDict, total=False): dns_name: VariableOr[str] """ - The DNS of the KeyVault + The DNS name of the key vault, for example ``https://my-key-vault.vault.azure.net/``. """ resource_id: VariableOr[str] """ - The resource id of the azure KeyVault that user wants to associate the scope with. + The Azure resource ID of the key vault to associate with the scope. """ diff --git a/python/databricks/bundles/secret_scopes/_models/scope_backend_type.py b/python/databricks/bundles/secret_scopes/_models/scope_backend_type.py index d95f7022d33..f5e9e84cb95 100644 --- a/python/databricks/bundles/secret_scopes/_models/scope_backend_type.py +++ b/python/databricks/bundles/secret_scopes/_models/scope_backend_type.py @@ -6,8 +6,7 @@ class ScopeBackendType(Enum): """ - The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes - will be supported in a later release. + The types of secret scope backends in the Secret Manager. """ DATABRICKS = "DATABRICKS" diff --git a/python/databricks/bundles/sql_warehouses/_models/channel.py b/python/databricks/bundles/sql_warehouses/_models/channel.py index f5893d7273f..bba1298b809 100644 --- a/python/databricks/bundles/sql_warehouses/_models/channel.py +++ b/python/databricks/bundles/sql_warehouses/_models/channel.py @@ -22,8 +22,16 @@ class Channel: """ dbsql_version: VariableOrOptional[str] = None + """ + Databricks SQL version to pin to. Set it if and only if name is + CHANNEL_NAME_CUSTOM. + """ name: VariableOrOptional[ChannelName] = None + """ + Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW + carries the upcoming Databricks SQL release for testing. + """ @classmethod def from_dict(cls, value: "ChannelDict") -> "Self": @@ -37,8 +45,16 @@ class ChannelDict(TypedDict, total=False): """""" dbsql_version: VariableOrOptional[str] + """ + Databricks SQL version to pin to. Set it if and only if name is + CHANNEL_NAME_CUSTOM. + """ name: VariableOrOptional[ChannelNameParam] + """ + Channel to follow. CHANNEL_NAME_CURRENT is the default, and CHANNEL_NAME_PREVIEW + carries the upcoming Databricks SQL release for testing. + """ ChannelParam = ChannelDict | Channel diff --git a/python/databricks/bundles/sql_warehouses/_models/endpoint_tag_pair.py b/python/databricks/bundles/sql_warehouses/_models/endpoint_tag_pair.py index 45f4d904d1e..c784073dd75 100644 --- a/python/databricks/bundles/sql_warehouses/_models/endpoint_tag_pair.py +++ b/python/databricks/bundles/sql_warehouses/_models/endpoint_tag_pair.py @@ -16,8 +16,15 @@ class EndpointTagPair: """""" key: VariableOrOptional[str] = None + """ + Tag key. Keys must be unique within the warehouse and cannot use the keys that + Databricks reserves for the tags it sets automatically. + """ value: VariableOrOptional[str] = None + """ + Tag value. Keys and values must follow the tagging rules of the cloud provider. + """ @classmethod def from_dict(cls, value: "EndpointTagPairDict") -> "Self": @@ -31,8 +38,15 @@ class EndpointTagPairDict(TypedDict, total=False): """""" key: VariableOrOptional[str] + """ + Tag key. Keys must be unique within the warehouse and cannot use the keys that + Databricks reserves for the tags it sets automatically. + """ value: VariableOrOptional[str] + """ + Tag value. Keys and values must follow the tagging rules of the cloud provider. + """ EndpointTagPairParam = EndpointTagPairDict | EndpointTagPair diff --git a/python/databricks/bundles/sql_warehouses/_models/endpoint_tags.py b/python/databricks/bundles/sql_warehouses/_models/endpoint_tags.py index 7d70c86199d..6e51eb2ff64 100644 --- a/python/databricks/bundles/sql_warehouses/_models/endpoint_tags.py +++ b/python/databricks/bundles/sql_warehouses/_models/endpoint_tags.py @@ -20,6 +20,9 @@ class EndpointTags: """""" custom_tags: VariableOrList[EndpointTagPair] = field(default_factory=list) + """ + User-defined tags, applied in addition to the tags Databricks sets automatically. + """ @classmethod def from_dict(cls, value: "EndpointTagsDict") -> "Self": @@ -33,6 +36,9 @@ class EndpointTagsDict(TypedDict, total=False): """""" custom_tags: VariableOrList[EndpointTagPairParam] + """ + User-defined tags, applied in addition to the tags Databricks sets automatically. + """ EndpointTagsParam = EndpointTagsDict | EndpointTags diff --git a/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py b/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py index c3b91e849b5..0598d41dc85 100644 --- a/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py +++ b/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py @@ -54,7 +54,7 @@ class SqlWarehouse(Resource): channel: VariableOrOptional[Channel] = None """ - Channel Details + Channel that determines which Databricks SQL version the warehouse runs. """ cluster_size: VariableOrOptional[str] = None @@ -79,7 +79,8 @@ class SqlWarehouse(Resource): creator_name: VariableOrOptional[str] = None """ - warehouse creator name + Name of the user who created the warehouse. Set by the server and ignored in + requests. """ enable_photon: VariableOrOptional[bool] = None @@ -142,11 +143,11 @@ class SqlWarehouse(Resource): name: VariableOrOptional[str] = None """ - Logical name for the cluster. + Logical name for the warehouse. Supported values: - Must be unique within an org. - - Must be less than 100 characters. + - Must be 1 to 100 characters. """ permissions: VariableOrList[SqlWarehousePermission] = field(default_factory=list) @@ -171,12 +172,17 @@ class SqlWarehouse(Resource): spot_instance_policy: VariableOrOptional[SpotInstancePolicy] = None """ - Configurations whether the endpoint should use spot instances. + Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses + spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED + uses on-demand instances only. """ statement_timeout: VariableOrOptional[int] = None """ - [Public Preview] Warehouse statement timeout in seconds. + [Public Preview] Maximum time in seconds that a statement can run on this warehouse before it is + cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a + running warehouse restarts it. See + https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. """ tags: VariableOrOptional[EndpointTags] = None @@ -220,7 +226,7 @@ class SqlWarehouseDict(TypedDict, total=False): channel: VariableOrOptional[ChannelParam] """ - Channel Details + Channel that determines which Databricks SQL version the warehouse runs. """ cluster_size: VariableOrOptional[str] @@ -245,7 +251,8 @@ class SqlWarehouseDict(TypedDict, total=False): creator_name: VariableOrOptional[str] """ - warehouse creator name + Name of the user who created the warehouse. Set by the server and ignored in + requests. """ enable_photon: VariableOrOptional[bool] @@ -308,11 +315,11 @@ class SqlWarehouseDict(TypedDict, total=False): name: VariableOrOptional[str] """ - Logical name for the cluster. + Logical name for the warehouse. Supported values: - Must be unique within an org. - - Must be less than 100 characters. + - Must be 1 to 100 characters. """ permissions: VariableOrList[SqlWarehousePermissionParam] @@ -337,12 +344,17 @@ class SqlWarehouseDict(TypedDict, total=False): spot_instance_policy: VariableOrOptional[SpotInstancePolicyParam] """ - Configurations whether the endpoint should use spot instances. + Configures whether the warehouse should use spot instances. COST_OPTIMIZED uses + spot instances where the cloud provider supports them, and RELIABILITY_OPTIMIZED + uses on-demand instances only. """ statement_timeout: VariableOrOptional[int] """ - [Public Preview] Warehouse statement timeout in seconds. + [Public Preview] Maximum time in seconds that a statement can run on this warehouse before it is + cancelled. Set to 0 to remove the warehouse-level timeout. Changing the value of a + running warehouse restarts it. See + https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. """ tags: VariableOrOptional[EndpointTagsParam] From c3744d73f9fcfe909f3a452c9f820f0cde1b7357 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 19 Nov 2026 09:09:28 +0000 Subject: [PATCH 2/2] Regenerate acceptance goldens and link the changelog entry Rerun ./task bump-sdk-post on top of the bumper's commit. The generators reproduce its output unchanged. test-update restores three goldens that the bumper's environment had overwritten with errors (missing uvx, a failed node app and a failed ssh server script): cmd/pypi-wheel, cmd/workspace/apps/run-local-node and ssh/agent-launchers. They match main again. Append the PR link to the changelog fragment. No hand-written fixes. Co-authored-by: Isaac --- .../dependency-updates/go-sdk-v0.202.0.md | 2 +- acceptance/cmd/pypi-wheel/output.txt | 4 +- .../workspace/apps/run-local-node/output.txt | 26 +++++++++- acceptance/ssh/agent-launchers/output.txt | 48 ++++++++++++++++++- 4 files changed, 74 insertions(+), 6 deletions(-) diff --git a/.nextchanges/dependency-updates/go-sdk-v0.202.0.md b/.nextchanges/dependency-updates/go-sdk-v0.202.0.md index 7229a2da7a4..f7470925970 100644 --- a/.nextchanges/dependency-updates/go-sdk-v0.202.0.md +++ b/.nextchanges/dependency-updates/go-sdk-v0.202.0.md @@ -1 +1 @@ -* Update the Go SDK to [v0.202.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.202.0). +* Update the Go SDK to [v0.202.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.202.0). ([#7791](https://github.com/databricks/cli/pull/7791)) diff --git a/acceptance/cmd/pypi-wheel/output.txt b/acceptance/cmd/pypi-wheel/output.txt index 0383173e481..0403a0ea7a0 100644 --- a/acceptance/cmd/pypi-wheel/output.txt +++ b/acceptance/cmd/pypi-wheel/output.txt @@ -111,6 +111,4 @@ Documentation: https://docs.databricks.com/dev-tools/cli/ Source: https://github.com/databricks/cli >>> uvx -q --offline --no-index --find-links wheels --from databricks==1.2.3 databricks --version -script: line 52: uvx: command not found - -Exit code: 127 +Databricks CLI v[CLI_VERSION] diff --git a/acceptance/cmd/workspace/apps/run-local-node/output.txt b/acceptance/cmd/workspace/apps/run-local-node/output.txt index e2249505bd3..e6b0bd0a642 100644 --- a/acceptance/cmd/workspace/apps/run-local-node/output.txt +++ b/acceptance/cmd/workspace/apps/run-local-node/output.txt @@ -1,4 +1,28 @@ === Prepare environment runs the build script, and the entry point overrides app.yml -Exit code: 1 +>>> grep -x Build script ran ../LOG.prepare +Build script ran + +>>> grep -x Running command: node -e console.log('Hello, world') ../LOG.prepare +Running command: node -e console.log('Hello, world') + +>>> grep -x Hello, world ../LOG.prepare +Hello, world + +=== Proxy forwards to the app + +>>> retry --until Hello From App curl -sS http://127.0.0.1:[PROXY_PORT] +{"message":"Hello From App"} + +=== Debug mode reports the debugger port, and node listens on it + +>>> retry grep -x To debug your app, attach a debugger to port [DEBUG_PORT] LOG.run +To debug your app, attach a debugger to port [DEBUG_PORT] + +>>> grep Debugger listening on ws://127.0.0.1:[DEBUG_PORT]/ LOG.run +Debugger listening on ws://127.0.0.1:[DEBUG_PORT]/[UUID] + +=== Shutting the app down + +>>> curl -sS -o /dev/null http://127.0.0.1:[PROXY_PORT]/shutdown diff --git a/acceptance/ssh/agent-launchers/output.txt b/acceptance/ssh/agent-launchers/output.txt index 68985716c07..3a4bd48d14f 100644 --- a/acceptance/ssh/agent-launchers/output.txt +++ b/acceptance/ssh/agent-launchers/output.txt @@ -1,2 +1,48 @@ -Exit code: 2 +=== Serverless server + +=== SetEnv appends the launcher directory to PATH +SetEnv +HOME="[TEST_TMP_DIR]/server-home" +PATH="/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin" +DATABRICKS_HOST="[DATABRICKS_URL]" +DATABRICKS_TOKEN="[DATABRICKS_TOKEN]" +DATABRICKS_CLI_PATH="[CLI]" +DATABRICKS_CLI_UPSTREAM=databricks_ssh_tunnel +DATABRICKS_CLI_UPSTREAM_VERSION= +DATABRICKS_SDK_UPSTREAM=databricks_ssh_tunnel +DATABRICKS_SDK_UPSTREAM_VERSION= +GIT_CONFIG_GLOBAL=/Workspace/.proc/self/git/config +ENABLE_DATABRICKS_CLI=true +PYTHONPYCACHEPREFIX=/tmp/pycache +DATABRICKS_JUPYTER_SERVERLESS=true + +=== Each supported agent has a launcher that delegates to the agent shim + +>>> ls server-home/.agent-shim/bin +claude +codex + +>>> cat server-home/.agent-shim/bin/claude +#!/usr/bin/env bash +# "claude" launcher from "databricks ssh connect"; delegates to "ssh agent-shim claude". +export DATABRICKS_WORKSPACE_HOME='/Workspace/Users/[USERNAME]' +exec [CLI] ssh agent-shim claude "$@" + +=== A non-interactive session finds the launchers on PATH +/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin +[TEST_TMP_DIR]/server-home/.agent-shim/bin/claude +[TEST_TMP_DIR]/server-home/.agent-shim/bin/codex + +=== Dedicated server + +=== SetEnv appends the launcher directory to PATH +PATH="/usr/bin:/bin:[TEST_TMP_DIR]/server-home/.agent-shim/bin" + +>>> ls server-home/.agent-shim/bin +claude +codex + +=== A non-interactive session finds the launchers on PATH +[TEST_TMP_DIR]/server-home/.agent-shim/bin/claude +[TEST_TMP_DIR]/server-home/.agent-shim/bin/codex