From d6b3676c99c8dcba95ce0ff7fe975f9c156e735c Mon Sep 17 00:00:00 2001 From: "databricks-ci-ghec-1[bot]" <184311507+databricks-ci-ghec-1[bot]@users.noreply.github.com> Date: Wed, 18 Nov 2026 12:28:00 +0000 Subject: [PATCH 1/2] Update Go SDK to v0.201.0 --- .codegen/_openapi_sha | 2 +- .codegen/cli.json | 4477 +++++++++++++---- .../dependency-updates/go-sdk-v0.201.0.md | 1 + .../refschema/output/materialization_sets.txt | 2 + .../output/vector_search_indexes.txt | 6 + acceptance/cmd/pypi-wheel/output.txt | 4 +- .../workspace/apps/run-local-node/output.txt | 26 +- .../cmd/workspace/arg-validation/output.txt | 4 +- acceptance/ssh/agent-launchers/output.txt | 48 +- .../materialization_sets.generated.yml | 2 + bundle/internal/schema/annotations.yml | 20 - .../validation/generated/enum_fields.go | 2 +- .../validation/generated/required_fields.go | 6 +- bundle/schema/jsonschema.json | 201 +- cmd/account/budget-policy/budget-policy.go | 15 +- .../disaster-recovery/disaster-recovery.go | 60 +- cmd/account/groups-v2/groups-v2.go | 14 +- cmd/account/iam-v2/iam-v2.go | 4 +- .../service-principals-v2.go | 29 +- cmd/workspace/agent-kit/agent-kit.go | 16 +- cmd/workspace/ai-gateway/ai-gateway.go | 21 +- cmd/workspace/ai-search/ai-search.go | 38 +- cmd/workspace/clean-rooms/clean-rooms.go | 22 +- cmd/workspace/clusters/clusters.go | 12 +- cmd/workspace/environments/environments.go | 27 +- cmd/workspace/experiments/experiments.go | 29 +- .../external-metadata/external-metadata.go | 63 +- .../feature-engineering.go | 2 + .../git-credentials/git-credentials.go | 21 +- .../lakeview-embedded/lakeview-embedded.go | 14 +- cmd/workspace/lakeview/lakeview.go | 71 +- cmd/workspace/lakewatch/lakewatch.go | 1058 +++- cmd/workspace/libraries/libraries.go | 9 +- .../model-registry/model-registry.go | 17 +- cmd/workspace/postgres/postgres.go | 37 +- cmd/workspace/providers/providers.go | 1 + cmd/workspace/schemas/schemas.go | 20 +- cmd/workspace/secrets/secrets.go | 49 +- .../software-artifacts/software-artifacts.go | 21 +- .../system-schemas/system-schemas.go | 6 +- cmd/workspace/tables/tables.go | 21 +- .../vector-search-endpoints.go | 14 +- .../vector-search-indexes.go | 55 +- .../workspace-entity-tag-assignments.go | 14 +- .../workspace-iam-v2/workspace-iam-v2.go | 4 +- go.mod | 2 +- go.sum | 4 +- .../cluster_policies/_models/library.py | 26 +- .../cluster_policies/_models/maven_library.py | 4 +- .../_models/python_py_pi_library.py | 4 +- .../clusters/_models/azure_attributes.py | 6 +- .../bundles/clusters/_models/cluster.py | 34 +- .../clusters/_models/docker_basic_auth.py | 8 +- .../bundles/clusters/_models/library.py | 26 +- .../bundles/clusters/_models/maven_library.py | 4 +- .../clusters/_models/python_py_pi_library.py | 4 +- .../experiments/_models/experiment_tag.py | 8 +- .../experiments/_models/mlflow_experiment.py | 34 +- .../_models/docker_basic_auth.py | 8 +- .../bundles/job_runs/_models/job_run.py | 4 +- .../bundles/jobs/_models/azure_attributes.py | 6 +- .../bundles/jobs/_models/cluster_spec.py | 34 +- .../bundles/jobs/_models/docker_basic_auth.py | 8 +- .../bundles/jobs/_models/git_source.py | 6 + ...ion_trigger_configuration_monitored_job.py | 2 - .../bundles/jobs/_models/job_environment.py | 6 +- .../bundles/jobs/_models/jobs_health_rules.py | 6 + .../bundles/jobs/_models/library.py | 26 +- .../bundles/jobs/_models/maven_library.py | 4 +- .../jobs/_models/python_py_pi_library.py | 4 +- .../bundles/jobs/_models/sparse_checkout.py | 4 +- .../_models/sql_condition_configuration.py | 18 +- .../databricks/bundles/jobs/_models/task.py | 4 +- .../bundles/jobs/_models/trigger_settings.py | 6 + .../bundles/jobs/_models/webhook.py | 6 + .../_models/model_provider_service_config.py | 52 +- ...fig_custom_provider_api_key_header_auth.py | 4 +- ...provider_service_config_provider_secret.py | 14 +- .../pipelines/_models/azure_attributes.py | 6 +- .../pipelines/_models/connector_options.py | 8 +- .../pipelines/_models/maven_library.py | 4 +- .../pipelines/_models/tik_tok_ads_options.py | 56 +- .../bundles/schemas/_models/schema.py | 20 +- .../sql_warehouses/_models/sql_warehouse.py | 14 +- .../delta_sync_vector_index_spec_request.py | 20 +- .../direct_access_vector_index_spec.py | 24 +- .../_models/embedding_source_column.py | 4 +- .../_models/embedding_vector_column.py | 4 +- .../_models/vector_search_index.py | 20 +- 89 files changed, 5269 insertions(+), 1882 deletions(-) create mode 100644 .nextchanges/dependency-updates/go-sdk-v0.201.0.md diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index 6f65d374187..b7f7be504e8 100644 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -7603627b8d9a120bcc49bdead7c7300944b047be \ No newline at end of file +6005ee42f3882434563e5e1662aa0d95781ab781 \ No newline at end of file diff --git a/.codegen/cli.json b/.codegen/cli.json index 7afb9307005..96b1e8a0942 100644 --- a/.codegen/cli.json +++ b/.codegen/cli.json @@ -187,7 +187,7 @@ "launch_stage": "PUBLIC_BETA" }, "managed_memory_store_id": { - "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit.", + "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit. It becomes the last segment of the store's `name` and cannot be changed\nafter creation.", "launch_stage": "PUBLIC_BETA" } } @@ -323,7 +323,7 @@ "description": "Request to grant a READ or WRITE permission on a memory store to a principal.\nOnly the store owner or a workspace admin may grant permissions.", "fields": { "permission": { - "description": "Permission level to grant.", + "description": "Permission level to grant. `WRITE` includes `READ`. Grants are additive: granting `READ` to a\nprincipal that already holds `WRITE` does not lower its access. To downgrade a principal,\nrevoke its grants and grant again.", "ref": "agentkit.PermissionLevel", "launch_stage": "PUBLIC_BETA" }, @@ -428,7 +428,7 @@ ] }, "page_token": { - "description": "Opaque pagination token from a previous ListManagedMemoryStores response.", + "description": "Opaque pagination token, taken from the `next_page_token` of a previous response.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" @@ -697,7 +697,7 @@ ] }, "source_type": { - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nThe server may store an omitted or UNSPECIFIED value as AGENT.", "ref": "agentkit.ManagedMemoryEntrySourceType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -757,7 +757,7 @@ } }, "agentkit.ManagedMemoryStore": { - "description": "A workspace-scoped memory store backed by service-managed storage.", + "description": "A workspace-scoped memory store backed by service-managed storage. A store is the container for\nan agent's memory entries and the boundary at which access is granted; creating one provisions\nits Lakebase storage automatically. See\nhttps://docs.databricks.com/aws/en/agents/agent-memory/managed-memory for an overview.", "fields": { "create_time": { "description": "Time when the store was created.", @@ -1158,7 +1158,7 @@ "description": "Service-managed storage backing a memory store.", "fields": { "backend_id": { - "description": "Backend-specific identifier. For Lakebase, this is the project ID.", + "description": "Backend-specific identifier. For Lakebase, this is the resource name of the database that\nholds the store's entries, in the form\n`projects/{project_id}/branches/{branch_id}/databases/{database_id}`.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -1187,10 +1187,11 @@ "description": "A principal a store permission is granted to. `name` is the principal's Lakebase\nidentifier: a user's email or a service principal's application (client) id.", "fields": { "name": { + "description": "Identifier of the principal: the email address of a user, or the application (client) ID of\na service principal. Groups are not supported.", "launch_stage": "PUBLIC_BETA" }, "principal_type": { - "description": "The kind of principal. Required unless the deprecated type alias is supplied.", + "description": "The kind of principal, which determines how `name` is interpreted. A principal without a\ntype is rejected.", "ref": "agentkit.PrincipalType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -1220,7 +1221,7 @@ "launch_stage": "PUBLIC_BETA" }, "update_mask": { - "description": "Only `description` and `metadata` may be updated. Selecting `metadata` replaces the entire map.", + "description": "Only `description` and `metadata` may be updated. Selecting `description` while leaving it\nunset clears it. Selecting `metadata` replaces the entire map.", "launch_stage": "PUBLIC_BETA" } } @@ -1498,7 +1499,7 @@ ] }, "schema": { - "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description/nullability (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", + "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Enum fields list their values in \"labels\" (e.g. {\"currency\": {\"type\": \"enum\", \"labels\": [\"USD\", \"EUR\"]}}). Primitive and enum fields are nullable by default. Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", "launch_stage": "GA" } } @@ -1869,7 +1870,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "endpoint_id": { - "description": "The user-supplied short name for the Endpoint, per AIP-133. The server composes the\nfull `Endpoint.name` as `{parent}/endpoints/{endpoint_id}`. AIP-133 does not list\n`endpoint_id` as a fields-may-be-required entry, so we annotate it OPTIONAL on the\nwire; the server still rejects empty values with INVALID_PARAMETER_VALUE.", + "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", "behaviors": [ "OPTIONAL" @@ -2055,7 +2056,7 @@ "description": "An AI Search endpoint — compute infrastructure that hosts AI Search indexes\nand serves queries against them. Customers create, query, and delete endpoints;\nthe system manages provisioning, scaling, and health status.", "fields": { "budget_policy_id": { - "description": "The user-selected budget policy id for the endpoint.", + "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", "behaviors": [ "OPTIONAL" @@ -2069,28 +2070,28 @@ ] }, "creator": { - "description": "Creator of the endpoint", + "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", "behaviors": [ "OUTPUT_ONLY" ] }, "custom_tags": { - "description": "The custom tags assigned to the endpoint", + "description": "Custom tags assigned to the endpoint. On update, the list replaces all of the endpoint's\nexisting tags.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "effective_budget_policy_id": { - "description": "The budget policy id applied to the endpoint", + "description": "ID of the budget policy that is currently applied to the endpoint.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" ] }, "endpoint_status": { - "description": "Current status of the endpoint", + "description": "Current lifecycle state of the endpoint, with an optional message that explains it.", "ref": "aisearch.EndpointStatus", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -2106,7 +2107,7 @@ ] }, "id": { - "description": "Unique identifier of the endpoint", + "description": "System-generated UUID that uniquely identifies the endpoint.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -2120,14 +2121,14 @@ ] }, "last_updated_user": { - "description": "User who last updated the endpoint", + "description": "User name of the principal that last updated the endpoint, in the same format as `creator`.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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" }, "replica_count": { @@ -2146,7 +2147,7 @@ ] }, "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.", + "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", "behaviors": [ "OPTIONAL" @@ -2168,7 +2169,7 @@ ] }, "usage_policy_id": { - "description": "The usage policy id applied to the endpoint.", + "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", "behaviors": [ "OPTIONAL" @@ -2481,6 +2482,14 @@ "aisearch.IndexStatus": { "description": "Lifecycle and health state of an AI Search index, along with human-readable\ndetail about that state and basic indexing progress.", "fields": { + "detailed_state": { + "description": "Lifecycle and ingestion state. An online index can still have a failed update.", + "ref": "aisearch.IndexStatusState", + "launch_stage": "PUBLIC_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "index_url": { "description": "Index API URL used to perform operations on the index.", "launch_stage": "PUBLIC_PREVIEW", @@ -2503,7 +2512,7 @@ ] }, "ready": { - "description": "Whether the index is ready to serve queries. After CreateIndex, poll GetIndex until this is\ntrue; `message` describes the current state in the meantime.", + "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", "behaviors": [ "OUTPUT_ONLY" @@ -2511,6 +2520,43 @@ } } }, + "aisearch.IndexStatusState": { + "description": "Detailed lifecycle state of the index.", + "enum": [ + "PROVISIONING", + "PROVISIONING_ENDPOINT", + "PROVISIONING_INDEX", + "PROVISIONING_PIPELINE_RESOURCES", + "PROVISIONING_INITIAL_SNAPSHOT", + "ONLINE", + "ONLINE_CONTINUOUS_UPDATE", + "ONLINE_TRIGGERED_UPDATE", + "ONLINE_NO_PENDING_UPDATE", + "ONLINE_DIRECT_ACCESS", + "OFFLINE", + "OFFLINE_FAILED", + "ONLINE_PIPELINE_FAILED", + "ONLINE_UPDATING_PIPELINE_RESOURCES", + "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" + } + }, "aisearch.IndexSubtype": { "description": "The subtype of the AI Search index, determining the indexing and retrieval strategy.\n- `VECTOR`: Not a supported create value — do not select it. Use `HYBRID` (vector + hybrid\nsearch) or `FULL_TEXT` (full-text only). It is the proto2 default (`= 0`) solely to mirror\nthe legacy `index_v2.proto` enum value-for-value; it is not an offered index subtype.\n- `FULL_TEXT`: An index that uses full-text search without vector embeddings.\n- `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.", "enum": [ @@ -2547,7 +2593,7 @@ "aisearch.ListEndpointsRequest": { "fields": { "page_size": { - "description": "Best-effort upper bound on the number of results to return. Honored as an upper\nbound by the shim: `page_size` only narrows the legacy backend's response, never\nwidens it, so the practical cap is `min(page_size, legacy_fixed_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", "behaviors": [ "OPTIONAL" @@ -2966,7 +3012,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "update_mask": { - "description": "The list of fields to update.", + "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" } } @@ -5218,12 +5264,12 @@ "launch_stage": "GA" }, "action_type": { - "description": "The type of the action.", + "description": "The action to take when the alert enters a triggered state. `EMAIL_NOTIFICATION` sends an email and\n`BLOCK_USAGE` blocks further usage. `BLOCK_USAGE` is only supported on Unity AI Gateway budgets, with\n`resource_type` set to `BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`.", "ref": "billing.ActionConfigurationType", "launch_stage": "GA" }, "target": { - "description": "Target for the action. For example, an email address.", + "description": "Target of the action. For `EMAIL_NOTIFICATION`, the email address that receives the alert, up to 256\ncharacters. Must be omitted for `BLOCK_USAGE`.", "launch_stage": "GA" } } @@ -5242,7 +5288,7 @@ "billing.AlertConfiguration": { "fields": { "action_configurations": { - "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.", + "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.\nAn alert can have up to 10 actions.", "launch_stage": "GA" }, "alert_configuration_id": { @@ -5254,7 +5300,7 @@ "launch_stage": "PUBLIC_BETA" }, "quantity_threshold": { - "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.", + "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.\nA decimal number passed as a string, from 0 to 1,000,000,000.", "launch_stage": "GA" }, "quantity_type": { @@ -5344,6 +5390,7 @@ } }, "billing.BudgetConfiguration": { + "description": "A budget tracks the spend of your account, or of the workspaces and custom tags selected by its\nfilter, against one or more alert thresholds. Spend is measured in US dollars at list price. For an\noverview, see https://docs.databricks.com/en/admin/account-settings/budgets.html.", "fields": { "account_id": { "description": "Databricks account ID.", @@ -5358,7 +5405,7 @@ "launch_stage": "GA" }, "create_time": { - "description": "Creation time of this budget configuration.", + "description": "Creation time of this budget configuration, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "display_name": { @@ -5366,7 +5413,7 @@ "launch_stage": "GA" }, "filter": { - "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.\nThe filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.", "ref": "billing.BudgetConfigurationFilter", "launch_stage": "GA" }, @@ -5380,7 +5427,7 @@ "launch_stage": "PUBLIC_BETA" }, "update_time": { - "description": "Update time of this budget configuration.", + "description": "Time of the most recent update to this budget configuration, in milliseconds since the Unix epoch.", "launch_stage": "GA" } } @@ -5401,10 +5448,12 @@ "billing.BudgetConfigurationFilterClause": { "fields": { "operator": { + "description": "How usage is compared with `values`. `IN` matches usage whose value is one of `values`.", "ref": "billing.BudgetConfigurationFilterOperator", "launch_stage": "GA" }, "values": { + "description": "Values to match. A clause can list up to 30 values.", "launch_stage": "GA" } } @@ -5420,9 +5469,11 @@ "billing.BudgetConfigurationFilterTagClause": { "fields": { "key": { + "description": "The custom tag key to match, exactly as it appears in your usage data. A key can appear in at\nmost one clause per operator.", "launch_stage": "GA" }, "value": { + "description": "The tag values to match for `key`. Usage is included when its value for `key` is one of the\nlisted values.", "ref": "billing.BudgetConfigurationFilterClause", "launch_stage": "GA" } @@ -5431,16 +5482,18 @@ "billing.BudgetConfigurationFilterWorkspaceIdClause": { "fields": { "operator": { + "description": "How usage is compared with `values`. `IN` matches usage from any of the listed workspaces.", "ref": "billing.BudgetConfigurationFilterOperator", "launch_stage": "GA" }, "values": { + "description": "IDs of the workspaces whose usage is included. A clause can list up to 30 workspaces, all of\nwhich must belong to this account.", "launch_stage": "GA" } } }, "billing.BudgetPolicy": { - "description": "Contains the BudgetPolicy details.", + "description": "A serverless usage policy is a set of tags that are applied to the serverless usage of the\nworkloads that use the policy. Each usage record in the billable usage system table carries the\npolicy ID and these tags, so that serverless usage can be attributed to the policy.", "fields": { "binding_workspace_ids": { "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account.", @@ -5523,6 +5576,7 @@ } }, "billing.CreateBudgetConfigurationBudget": { + "description": "A budget tracks the spend of your account, or of the workspaces and custom tags selected by its\nfilter, against one or more alert thresholds. Spend is measured in US dollars at list price. For an\noverview, see https://docs.databricks.com/en/admin/account-settings/budgets.html.", "fields": { "account_id": { "description": "Databricks account ID.", @@ -5537,7 +5591,7 @@ "launch_stage": "GA" }, "filter": { - "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.\nThe filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.", "ref": "billing.BudgetConfigurationFilter", "launch_stage": "GA" }, @@ -5555,12 +5609,12 @@ "billing.CreateBudgetConfigurationBudgetActionConfigurations": { "fields": { "action_type": { - "description": "The type of the action.", + "description": "The action to take when the alert enters a triggered state. `EMAIL_NOTIFICATION` sends an email and\n`BLOCK_USAGE` blocks further usage. `BLOCK_USAGE` is only supported on Unity AI Gateway budgets, with\n`resource_type` set to `BUDGET_RESOURCE_TYPE_UNITY_AI_GATEWAY`.", "ref": "billing.ActionConfigurationType", "launch_stage": "GA" }, "target": { - "description": "Target for the action. For example, an email address.", + "description": "Target of the action. For `EMAIL_NOTIFICATION`, the email address that receives the alert, up to 256\ncharacters. Must be omitted for `BLOCK_USAGE`.", "launch_stage": "GA" } } @@ -5568,7 +5622,7 @@ "billing.CreateBudgetConfigurationBudgetAlertConfigurations": { "fields": { "action_configurations": { - "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.", + "description": "Configured actions for this alert. These define what happens when an alert enters a triggered state.\nAn alert can have up to 10 actions.", "launch_stage": "GA" }, "principal_overrides": { @@ -5576,7 +5630,7 @@ "launch_stage": "PUBLIC_BETA" }, "quantity_threshold": { - "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.", + "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on `quantity_type`.\nA decimal number passed as a string, from 0 to 1,000,000,000.", "launch_stage": "GA" }, "quantity_type": { @@ -5623,7 +5677,7 @@ "description": "A request to create a BudgetPolicy.", "fields": { "policy": { - "description": "The policy to create. `policy_id` needs to be empty as it will be generated\n`policy_name` must be provided, custom_tags may need to be provided\ndepending on the cloud provider. All other fields are optional.", + "description": "The policy to create. `policy_name` must be provided, and `custom_tags` may be required\ndepending on the cloud provider. Leave `policy_id` empty because Databricks generates it. All\nother fields are optional.", "ref": "billing.BudgetPolicy", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -5730,7 +5784,7 @@ "description": "Structured representation of a filter to be applied to a list of policies. All specified filters\nwill be applied in conjunction.", "fields": { "creator_user_id": { - "description": "The policy creator user id to be filtered on.\nIf unspecified, all policies will be returned.", + "description": "Deprecated: This field is ignored. Creator filtering will be removed in a future version.", "deprecated": true, "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -5746,7 +5800,7 @@ ] }, "policy_name": { - "description": "The partial name of policies to be filtered on.\nIf unspecified, all policies will be returned.", + "description": "Only policies whose name contains this string are returned. Matching is case-insensitive.\nIf unspecified, all policies are returned.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -5783,6 +5837,7 @@ "billing.GetBudgetConfigurationResponse": { "fields": { "budget": { + "description": "The requested budget configuration.", "ref": "billing.BudgetConfiguration", "launch_stage": "GA" } @@ -5840,14 +5895,14 @@ ] }, "page_token": { - "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "description": "A page token, received from a previous `ListBudgetPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListBudgetPolicies` must match\nthe call that provided the page token.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "sort_spec": { - "description": "The sort specification.", + "description": "How to sort the returned policies. If unspecified, policies are sorted by name in ascending\norder.", "ref": "billing.SortSpec", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -6068,7 +6123,7 @@ ] }, "field": { - "description": "The filed to sort by", + "description": "The field to sort by. If unspecified, policies are sorted by name.", "ref": "billing.SortSpecField", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ @@ -6086,6 +6141,7 @@ } }, "billing.UpdateBudgetConfigurationBudget": { + "description": "A budget tracks the spend of your account, or of the workspaces and custom tags selected by its\nfilter, against one or more alert thresholds. Spend is measured in US dollars at list price. For an\noverview, see https://docs.databricks.com/en/admin/account-settings/budgets.html.", "fields": { "account_id": { "description": "Databricks account ID.", @@ -6104,7 +6160,7 @@ "launch_stage": "GA" }, "filter": { - "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.", + "description": "Configured filters for this budget. These are applied to your account's usage to limit the scope of what is considered for this budget.\nLeave empty to include all usage for this account. All provided filters must be matched for usage to be included.\nThe filter cannot be changed after the budget is created. To change it, delete the budget and create a new one.", "ref": "billing.BudgetConfigurationFilter", "launch_stage": "GA" }, @@ -6122,7 +6178,7 @@ "billing.UpdateBudgetConfigurationRequest": { "fields": { "budget": { - "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.\nAlerts and actions are matched by ID: those omitted from the request are removed, and those\nwithout an ID are created.", "ref": "billing.UpdateBudgetConfigurationBudget", "launch_stage": "GA" } @@ -6140,7 +6196,7 @@ "billing.UpdateBudgetPolicyRequest": { "fields": { "limit_config": { - "description": "DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy", + "description": "Deprecated: This field is ignored.", "ref": "billing.LimitConfig", "deprecated": true, "launch_stage": "PUBLIC_PREVIEW", @@ -7735,6 +7791,7 @@ "launch_stage": "GA" }, "mask": { + "description": "The column mask function applied to this column, if any. A column mask is a SQL user-defined function\nthat transforms the values a query returns for the column. See\nhttps://docs.databricks.com/aws/en/tables/row-and-column-filters for details.", "ref": "catalog.ColumnMask", "launch_stage": "GA" }, @@ -7763,6 +7820,7 @@ "launch_stage": "GA" }, "type_name": { + "description": "The name of the column's data type, for example STRING, DECIMAL or STRUCT. The complete type, including\nparameters such as the precision of a decimal or the element type of an array, is in type_text.", "ref": "catalog.ColumnTypeName", "launch_stage": "GA" }, @@ -8064,7 +8122,7 @@ "SQLDW": "GA", "SQLSERVER": "GA", "TERADATA": "GA", - "TIKTOK_ADS": "PUBLIC_BETA", + "TIKTOK_ADS": "PUBLIC_PREVIEW", "UNKNOWN_CONNECTION_TYPE": "GA", "WORKDAY_RAAS": "GA", "ZENDESK": "GA" @@ -8560,7 +8618,7 @@ "launch_stage": "GA" }, "mcp_service_id": { - "description": "Name for the MCP service, e.g. \"my_mcp_service\".", + "description": "Name of the MCP service within the parent schema. The name must not\ncontain periods, spaces, forward slashes, percent signs, or control characters,\nand it is stored in lowercase.", "launch_stage": "GA" }, "parent": { @@ -8618,7 +8676,7 @@ "launch_stage": "GA" }, "model_provider_service_id": { - "description": "Name for the model provider service, e.g. \"openai_prod\".", + "description": "Name of the model provider service within the parent schema. The name must\nnot contain periods, spaces, forward slashes, percent signs, or control\ncharacters, must not end in `_DO_NOT_MODIFY`, and must not exceed 241\ncharacters. It is stored in lowercase.", "launch_stage": "GA" }, "parent": { @@ -8837,7 +8895,7 @@ "launch_stage": "GA" }, "custom_max_retention_hours": { - "description": "Custom maximum retention period in hours for the schema.", + "description": "Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -8852,7 +8910,7 @@ "launch_stage": "GA" }, "storage_root": { - "description": "Storage root URL for managed tables within schema.", + "description": "Managed tables and volumes in the schema are stored under this storage root URL. The path must be\ninside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted,\nmanaged data is stored under the parent catalog's storage root, or under the metastore's root storage\nlocation when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and\nschemas in a federated Hive metastore catalog must set one.", "launch_stage": "GA" } } @@ -8951,6 +9009,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "data_source_format": { + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "ref": "catalog.DataSourceFormat", "launch_stage": "PUBLIC_PREVIEW" }, @@ -8967,10 +9026,11 @@ "launch_stage": "PUBLIC_PREVIEW" }, "storage_location": { - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "launch_stage": "PUBLIC_PREVIEW" }, "table_type": { + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "ref": "catalog.TableType", "launch_stage": "PUBLIC_PREVIEW" } @@ -9615,7 +9675,7 @@ "catalog.EnableRequest": { "fields": { "catalog_name": { - "description": "the catalog for which the system schema is to enabled in", + "description": "Name of the catalog in which to enable the system schema. The supported values are `system` and `samples`. If not\nset, the system schema is enabled in the `system` catalog.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -10063,9 +10123,10 @@ } }, "catalog.ExternalMetadata": { + "description": "Metadata about an object that lives outside of Databricks, such as a Kafka topic, a Tableau dashboard,\nor a Salesforce table. An external metadata object is a Unity Catalog securable that can be the source or\nthe target of external lineage relationships, so that data flows into and out of Databricks appear in the\nUnity Catalog lineage graph. See\n[External lineage](https://docs.databricks.com/aws/en/data-governance/unity-catalog/external-lineage).", "fields": { "columns": { - "description": "List of columns associated with the external metadata object.", + "description": "Names of the columns of the object, used for column-level mappings in external lineage relationships.\nColumn names must be unique within the list, and the combined size of all column names is limited.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -10086,18 +10147,18 @@ ] }, "description": { - "description": "User-provided free-form text description.", + "description": "User-provided free-form text description of the object. The description must not exceed 5000 characters.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "entity_type": { - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "launch_stage": "PUBLIC_PREVIEW" }, "id": { - "description": "Unique identifier of the external metadata object.", + "description": "Unique identifier of the external metadata object. The ID is a UUID that the system assigns on creation.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -10111,25 +10172,25 @@ ] }, "name": { - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "launch_stage": "PUBLIC_PREVIEW" }, "owner": { - "description": "Owner of the external metadata object.", + "description": "Owner of the external metadata object. Defaults to the creator. To change the owner, send an update whose\nupdate mask includes `owner`.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "properties": { - "description": "A map of key-value properties attached to the external metadata object.", + "description": "Key-value properties attached to the object. Keys and values must be non-empty, and the combined length\nof all keys and values must not exceed 5000 characters.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "system_type": { - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "ref": "catalog.SystemType", "launch_stage": "PUBLIC_PREVIEW" }, @@ -10148,7 +10209,7 @@ ] }, "url": { - "description": "URL associated with the external metadata object.", + "description": "URL of the object in the external system. When set, lineage graph viewers can follow it to the external\nasset. The URL must not exceed 2048 characters.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -10944,7 +11005,7 @@ "catalog.GetSchemaRequest": { "fields": { "include_browse": { - "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "description": "Whether to return the schema when the principal can only access selective metadata for it through the\nBROWSE privilege. The response then has browse_only set to true.", "launch_stage": "GA" } } @@ -11316,7 +11377,7 @@ "catalog.ListExternalMetadataRequest": { "fields": { "page_size": { - "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000.", + "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000. Defaults to 1000 when omitted.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" @@ -11745,7 +11806,7 @@ "launch_stage": "GA" }, "include_browse": { - "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "description": "Whether to include schemas for which the principal can only access selective metadata through the\nBROWSE privilege. Such schemas are returned with browse_only set to true.", "launch_stage": "GA" }, "max_results": { @@ -12081,14 +12142,14 @@ ] }, "created_by": { - "description": "Creator identity.", + "description": "Username or service principal application ID of the principal that created the MCP service.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "effective_owner": { - "description": "Owner of the MCP service.", + "description": "Username, group name, or service principal application ID of the MCP service owner.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -12102,14 +12163,14 @@ ] }, "metastore_id": { - "description": "Metastore hosting the MCP service.", + "description": "Unique identifier of the metastore that contains the MCP service.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -12123,7 +12184,7 @@ ] }, "updated_by": { - "description": "Identity of the last updater.", + "description": "Username or service principal application ID of the principal that last updated the MCP\nservice.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -12338,14 +12399,14 @@ ] }, "created_by": { - "description": "Creator identity.", + "description": "Username of the user who created the model provider service.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "effective_owner": { - "description": "Owner of the model provider service.", + "description": "Username or group name of the model provider service owner.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -12359,14 +12420,14 @@ ] }, "metastore_id": { - "description": "Metastore hosting the provider service.", + "description": "Unique identifier of the metastore that contains the model provider service.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -12380,7 +12441,7 @@ ] }, "updated_by": { - "description": "Identity of the last updater.", + "description": "Username of the user who last updated the model provider service.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -12399,6 +12460,7 @@ ] }, "amazon_bedrock": { + "description": "Configuration for Amazon Bedrock. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK`.", "ref": "catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12406,6 +12468,7 @@ ] }, "anthropic": { + "description": "Configuration for Anthropic. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC`.", "ref": "catalog.ModelProviderServiceConfigAnthropicProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12413,6 +12476,7 @@ ] }, "azure_openai": { + "description": "Configuration for Azure OpenAI. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI`.", "ref": "catalog.ModelProviderServiceConfigAzureOpenAiProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12420,6 +12484,7 @@ ] }, "bedrock_mantle": { + "description": "Configuration for Amazon Bedrock Mantle, with the same fields as\n`amazon_bedrock`. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE`.", "ref": "catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12427,6 +12492,7 @@ ] }, "custom": { + "description": "Configuration for a custom OpenAI-compatible provider. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM`.", "ref": "catalog.ModelProviderServiceConfigCustomProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12455,6 +12521,7 @@ ] }, "gemini_enterprise": { + "description": "Configuration for Google Gemini Enterprise. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE`.", "ref": "catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12470,6 +12537,7 @@ ] }, "microsoft_foundry": { + "description": "Configuration for Microsoft Foundry. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY`.", "ref": "catalog.ModelProviderServiceConfigMicrosoftFoundryProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12477,6 +12545,7 @@ ] }, "openai": { + "description": "Configuration for OpenAI. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI`.", "ref": "catalog.ModelProviderServiceConfigOpenAiProviderConfig", "launch_stage": "GA", "behaviors": [ @@ -12674,7 +12743,7 @@ ] }, "api_key_value": { - "description": "Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supplied as inline plaintext via `ProviderSecret.plaintext`.", + "description": "Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supply the value in `api_key_value.plaintext`.", "ref": "catalog.ModelProviderServiceConfigProviderSecret", "launch_stage": "GA", "behaviors": [ @@ -12950,7 +13019,7 @@ "description": "A secret value supplied as part of an inline provider config. The caller\nsupplies the value as inline `plaintext` on writes; the platform stores it\nencrypted. The `plaintext` field is `INPUT_ONLY` and never round-trips on\nreads.", "fields": { "plaintext": { - "description": "Inline plaintext credential. INPUT_ONLY: the value never round-trips on\nreads. Get and List responses omit `plaintext`; the enclosing secret\nobject remains present to indicate that a secret is configured.", + "description": "Inline plaintext credential. The value is write-only and never\nround-trips on reads. Get and List responses omit `plaintext`; the\nenclosing secret object remains present to indicate that a secret is\nconfigured.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -14579,6 +14648,7 @@ }, "catalog.RunRefreshRequest": {}, "catalog.SchemaInfo": { + "description": "A schema (also called a database) is the second layer of Unity Catalog's three-level namespace and\ngroups the tables, views, volumes, models, and functions under its parent catalog. Managed tables and\nvolumes in the schema are stored under the schema's storage root when it has one, and otherwise under\nthe storage of the parent catalog or the metastore.", "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.", @@ -14589,7 +14659,7 @@ "launch_stage": "GA" }, "catalog_type": { - "description": "The type of the parent catalog.", + "description": "The type of the parent catalog, which the server copies from the catalog.", "ref": "catalog.CatalogType", "launch_stage": "GA" }, @@ -14606,18 +14676,19 @@ "launch_stage": "GA" }, "custom_max_retention_hours": { - "description": "Custom maximum retention period in hours for the schema.", + "description": "Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "effective_predictive_optimization_flag": { + "description": "Indicates the predictive optimization setting that is in effect for the schema once inherited values\nare resolved.", "ref": "catalog.EffectivePredictiveOptimizationFlag", "launch_stage": "GA" }, "enable_predictive_optimization": { - "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "description": "Whether predictive optimization is enabled for this schema and the objects under it. Valid values are\nENABLE, DISABLE, and INHERIT, where INHERIT applies the parent catalog's setting. New schemas start as\nINHERIT. It cannot be set when creating a schema; use the update method instead.", "ref": "catalog.EnablePredictiveOptimization", "launch_stage": "GA" }, @@ -14634,7 +14705,7 @@ "launch_stage": "GA" }, "owner": { - "description": "Username of current owner of schema.", + "description": "The user or group that owns the schema. The creator becomes the owner, and the owner can be changed\nonly through the update method.", "launch_stage": "GA" }, "properties": { @@ -14642,19 +14713,19 @@ "launch_stage": "GA" }, "schema_id": { - "description": "The unique identifier of the schema.", + "description": "The unique identifier (UUID) that the server assigns to the schema when it is created.", "launch_stage": "GA" }, "storage_location": { - "description": "Storage location for managed tables within schema.", + "description": "The server derives this full storage location URL for managed tables and volumes within the schema\nfrom storage_root and the schema ID. It is absent when the schema has no storage root of its own.", "launch_stage": "GA" }, "storage_root": { - "description": "Storage root URL for managed tables within schema.", + "description": "Managed tables and volumes in the schema are stored under this storage root URL. The path must be\ninside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted,\nmanaged data is stored under the parent catalog's storage root, or under the metastore's root storage\nlocation when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and\nschemas in a federated Hive metastore catalog must set one.", "launch_stage": "GA" }, "updated_at": { - "description": "Time at which this schema was created, in epoch milliseconds.", + "description": "Time at which this schema was last modified, in epoch milliseconds.", "launch_stage": "GA" }, "updated_by": { @@ -15293,13 +15364,14 @@ }, "catalog.SummaryRequest": {}, "catalog.SystemSchemaInfo": { + "description": "A system schema of a metastore, with its current enablement state. System schemas hold Databricks-provided system\ntables, such as audit logs and billing usage. They live in the `system` catalog unless they are enabled in another\nsupported catalog. See https://docs.databricks.com/aws/en/admin/system-tables/.", "fields": { "schema": { - "description": "Name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "launch_stage": "PUBLIC_PREVIEW" }, "state": { - "description": "The current state of enablement for the system schema. An empty string means the system schema is available and ready for opt-in.\nPossible values: AVAILABLE | ENABLE_INITIALIZED | ENABLE_COMPLETED | DISABLE_INITIALIZED | UNAVAILABLE | MANAGED", + "description": "The current enablement state of the system schema. Possible values are `AVAILABLE` (the schema can be enabled),\n`ENABLE_INITIALIZED` (enablement is in progress), `ENABLE_COMPLETED` (the schema is enabled), `DISABLE_INITIALIZED`\n(disablement is in progress), `UNAVAILABLE` (the schema cannot be enabled at the moment) and `MANAGED` (Databricks\nenables the schema automatically).", "launch_stage": "PUBLIC_PREVIEW" } } @@ -15391,9 +15463,10 @@ } }, "catalog.TableInfo": { + "description": "A table resides in the third layer of Unity Catalog's three-level namespace and holds rows of data organized\nin columns. Besides managed and external tables, it covers views, materialized views, streaming tables,\nmetric views, foreign tables and shallow clones, which table_type distinguishes.", "fields": { "access_point": { - "description": "The AWS access point to use when accesing s3 for this external location.", + "description": "The AWS access point to use when accessing S3 for the storage location of this table.", "launch_stage": "GA" }, "browse_only": { @@ -15426,6 +15499,7 @@ "launch_stage": "GA" }, "data_source_format": { + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "ref": "catalog.DataSourceFormat", "launch_stage": "GA" }, @@ -15439,10 +15513,12 @@ "launch_stage": "GA" }, "effective_predictive_optimization_flag": { + "description": "The predictive optimization setting that is in effect for the table once inherited values are resolved.", "ref": "catalog.EffectivePredictiveOptimizationFlag", "launch_stage": "GA" }, "enable_predictive_optimization": { + "description": "Whether predictive optimization is enabled for this table. Valid values are ENABLE, DISABLE and INHERIT,\nwhere INHERIT applies the setting of the parent schema. It is ignored when creating a table. See\nhttps://docs.databricks.com/aws/en/optimizations/predictive-optimization for details.", "ref": "catalog.EnablePredictiveOptimization", "launch_stage": "GA" }, @@ -15463,7 +15539,7 @@ "launch_stage": "GA" }, "owner": { - "description": "Username of current owner of table.", + "description": "The user or group that owns the table. The principal that creates the table becomes its owner.", "launch_stage": "GA" }, "pipeline_id": { @@ -15475,6 +15551,7 @@ "launch_stage": "GA" }, "row_filter": { + "description": "The row filter function applied to the table, if any. A row filter is a SQL user-defined function that\ndecides which rows a query returns. See https://docs.databricks.com/aws/en/tables/row-and-column-filters\nfor details.", "ref": "catalog.TableRowFilter", "launch_stage": "GA" }, @@ -15496,7 +15573,7 @@ "launch_stage": "GA" }, "storage_location": { - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "launch_stage": "GA" }, "table_constraints": { @@ -15508,6 +15585,7 @@ "launch_stage": "GA" }, "table_type": { + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "ref": "catalog.TableType", "launch_stage": "GA" }, @@ -15569,6 +15647,7 @@ "launch_stage": "GA" }, "table_type": { + "description": "The type of the table, with the same meaning as table_type on TableInfo.", "ref": "catalog.TableType", "launch_stage": "GA" } @@ -16046,7 +16125,7 @@ "launch_stage": "PUBLIC_PREVIEW" }, "update_mask": { - "description": "The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.\n\nA field mask of `*` indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API changes in the future.", + "description": "Comma-separated list of the fields to update, for example `description,properties`. Only the listed\nfields change. The other fields keep their current values. The mask must not be empty.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -16443,14 +16522,14 @@ "launch_stage": "GA" }, "custom_max_retention_hours": { - "description": "Custom maximum retention period in hours for the schema.", + "description": "Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "enable_predictive_optimization": { - "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "description": "Whether predictive optimization is enabled for this schema and the objects under it. Valid values are\nENABLE, DISABLE, and INHERIT, where INHERIT applies the parent catalog's setting. New schemas start as\nINHERIT. It cannot be set when creating a schema; use the update method instead.", "ref": "catalog.EnablePredictiveOptimization", "launch_stage": "GA" }, @@ -16459,7 +16538,7 @@ "launch_stage": "GA" }, "owner": { - "description": "Username of current owner of schema.", + "description": "The user or group that owns the schema. The creator becomes the owner, and the owner can be changed\nonly through the update method.", "launch_stage": "GA" }, "properties": { @@ -16562,7 +16641,7 @@ "catalog.UpdateTableRequest": { "fields": { "owner": { - "description": "Username of current owner of table.", + "description": "The user or group that owns the table. The principal that creates the table becomes its owner.", "launch_stage": "PRIVATE_PREVIEW" } } @@ -16939,6 +17018,7 @@ } }, "cleanrooms.CleanRoom": { + "description": "A clean room is a secure, Databricks-managed environment where collaborators from one or more\nUnity Catalog metastores share tables, views, volumes and notebooks and run approved analyses\nwithout seeing each other's data. Each collaborator sees the clean room as a securable in their\nown metastore, while the analyses run in a central clean room in the cloud and region chosen at\ncreation.", "fields": { "access_restricted": { "description": "Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html)", @@ -16949,6 +17029,7 @@ ] }, "comment": { + "description": "Free-form description of the clean room. Comments are local to the caller's metastore and are\nnot shared with the other collaborators.", "launch_stage": "GA" }, "created_at": { @@ -16985,7 +17066,7 @@ ] }, "owner": { - "description": "This is the Databricks username of the owner of the local clean room securable for permission management.", + "description": "This is the Databricks username of the owner of the local clean room securable for permission management.\nWhen creating a clean room, leave it empty or set it to the caller.", "launch_stage": "GA" }, "remote_detailed_info": { @@ -17611,6 +17692,7 @@ "launch_stage": "GA" }, "status": { + "description": "Status of the output catalog for the calling collaborator.", "ref": "cleanrooms.CleanRoomOutputCatalogOutputCatalogStatus", "launch_stage": "GA", "behaviors": [ @@ -17649,13 +17731,14 @@ ] }, "collaborators": { - "description": "Collaborators in the central clean room. There should one and only one collaborator\nin the list that satisfies the owner condition:\n\n1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom).\n\n2. Its invite_recipient_email is empty.", + "description": "Collaborators in the central clean room. There should be one and only one collaborator\nin the list that satisfies the owner condition:\n\n1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom).\n\n2. Its invite_recipient_email is empty.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "compliance_security_profile": { + "description": "Compliance security profile of the central clean room. It is taken from the creator's workspace\nwhen the clean room is created; a collaborator whose workspace profile differs sees\naccess_restricted set to CSP_MISMATCH.", "ref": "cleanrooms.ComplianceSecurityProfile", "launch_stage": "GA", "behaviors": [ @@ -17671,7 +17754,7 @@ ] }, "egress_network_policy": { - "description": "Egress network policy to apply to the central clean room workspace.", + "description": "Egress network policy to apply to the central clean room workspace. Only\ninternet_access.restriction_mode (FULL_ACCESS or RESTRICTED_ACCESS) and\ninternet_access.allowed_internet_destinations can be set. When omitted, internet access is\nrestricted with no allowed destinations.", "ref": "settings.EgressNetworkPolicy", "launch_stage": "GA", "behaviors": [ @@ -17894,6 +17977,7 @@ "cleanrooms.CreateCleanRoomOutputCatalogResponse": { "fields": { "output_catalog": { + "description": "The output catalog that was created.", "ref": "cleanrooms.CleanRoomOutputCatalog", "launch_stage": "GA" } @@ -18136,6 +18220,7 @@ "cleanrooms.UpdateCleanRoomRequest": { "fields": { "clean_room": { + "description": "Clean room fields to update. Only mutable fields such as owner, comment and\nenable_shared_output can be changed; remote_detailed_info, status, created_at and updated_at\nmust be omitted.", "ref": "cleanrooms.CleanRoom", "launch_stage": "GA" } @@ -18212,6 +18297,7 @@ "description": "Attributes set during cluster creation which are related to Amazon Web Services.", "fields": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", "ref": "compute.AwsAvailability", "launch_stage": "GA" }, @@ -18284,7 +18370,7 @@ "launch_stage": "GA" }, "log_analytics_info": { - "description": "Defines values necessary to configure and run Azure Log Analytics agent", + "description": "Defines values necessary to configure and run Azure Log Analytics agent.\nBoth `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither.", "ref": "compute.LogAnalyticsInfo", "launch_stage": "GA" }, @@ -18343,6 +18429,7 @@ "compute.ChangeClusterOwner": { "fields": { "cluster_id": { + "description": "The ID of the cluster whose owner is changed.", "launch_stage": "GA" }, "owner_username": { @@ -18438,7 +18525,7 @@ "description": "Common set of attributes set during cluster creation. These attributes cannot be changed\nover the lifetime of a cluster.", "fields": { "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -18465,6 +18552,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -18474,7 +18562,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -18517,6 +18605,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -18571,6 +18660,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -18606,7 +18696,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -18659,6 +18749,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -18672,7 +18763,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -18724,15 +18815,16 @@ "launch_stage": "GA" }, "jdbc_port": { - "description": "Port on which Spark JDBC server is listening, in the driver nod. No service will be listeningon\non this port in executor nodes.", + "description": "Port on which Spark JDBC server is listening in the driver node. No service will be listening\non this port in executor nodes.", "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, "last_restarted_time": { - "description": "the timestamp that the cluster was started/restarted", + "description": "Time (in epoch milliseconds) when the cluster was last started or restarted.", "launch_stage": "GA" }, "last_state_loss_time": { @@ -18825,6 +18917,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -18833,6 +18926,7 @@ "compute.ClusterEvent": { "fields": { "cluster_id": { + "description": "The ID of the cluster the event belongs to.", "launch_stage": "GA" }, "data_plane_event_details": { @@ -18840,6 +18934,7 @@ "launch_stage": "GA" }, "details": { + "description": "Details about the event. Which fields are populated depends on the event `type`.", "ref": "compute.EventDetails", "launch_stage": "GA" }, @@ -18848,6 +18943,7 @@ "launch_stage": "GA" }, "type": { + "description": "The type of event, which determines which `details` fields are populated.", "ref": "compute.EventType", "launch_stage": "GA" } @@ -19097,7 +19193,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -19124,6 +19220,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -19133,7 +19230,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -19176,6 +19273,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -19234,6 +19332,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -19430,7 +19529,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -19462,6 +19561,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -19471,7 +19571,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -19514,6 +19614,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -19572,6 +19673,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -19942,11 +20044,11 @@ "compute.DockerBasicAuth": { "fields": { "password": { - "description": "Password of the user", + "description": "Password for authenticating to the Docker registry that hosts the image.", "launch_stage": "GA" }, "username": { - "description": "Name of the user", + "description": "User name for authenticating to the Docker registry that hosts the image.", "launch_stage": "GA" } } @@ -19987,7 +20089,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -20018,6 +20120,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -20027,7 +20130,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -20070,6 +20173,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -20128,6 +20232,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -20265,7 +20370,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -20292,6 +20397,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -20301,7 +20407,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -20344,6 +20450,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -20402,6 +20509,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -20497,6 +20605,7 @@ "launch_stage": "GA" }, "did_not_expand_reason": { + "description": "The reason the disk was not expanded. Included in `DID_NOT_EXPAND_DISK` and\n`FAILED_TO_EXPAND_DISK` events.", "launch_stage": "GA" }, "disk_size": { @@ -20512,6 +20621,7 @@ "launch_stage": "GA" }, "free_space": { + "description": "Free disk space in bytes. Included in disk expansion events such as `EXPANDED_DISK` and\n`DID_NOT_EXPAND_DISK`.", "launch_stage": "GA" }, "init_scripts": { @@ -20834,6 +20944,7 @@ "compute.GetEventsResponse": { "fields": { "events": { + "description": "The events matching the request, in the requested `order`.", "launch_stage": "GA" }, "next_page": { @@ -20875,7 +20986,7 @@ "launch_stage": "GA" }, "default_tags": { - "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- InstancePoolCreator: \u003cuser_id_of_creator\u003e\n\n- InstancePoolName: \u003cname_of_pool\u003e\n\n- InstancePoolId: \u003cid_of_pool\u003e", + "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- DatabricksInstancePoolCreatorId: \u003cuser_id_of_creator\u003e\n\n- DatabricksInstancePoolId: \u003cid_of_pool\u003e", "launch_stage": "GA" }, "disk_spec": { @@ -21328,7 +21439,7 @@ "launch_stage": "GA" }, "default_tags": { - "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- InstancePoolCreator: \u003cuser_id_of_creator\u003e\n\n- InstancePoolName: \u003cname_of_pool\u003e\n\n- InstancePoolId: \u003cid_of_pool\u003e", + "description": "Tags that are added by Databricks regardless of any ``custom_tags``, including:\n\n- Vendor: Databricks\n\n- DatabricksInstancePoolCreatorId: \u003cuser_id_of_creator\u003e\n\n- DatabricksInstancePoolId: \u003cid_of_pool\u003e", "launch_stage": "GA" }, "disk_spec": { @@ -21633,14 +21744,15 @@ } }, "compute.Library": { + "description": "A library to install on a cluster. Exactly one of the library-type fields must be set.", "fields": { "cran": { - "description": "Specification of a CRAN library to be installed as part of the library", + "description": "Specification of a CRAN library to be installed.", "ref": "compute.RCranLibrary", "launch_stage": "GA" }, "egg": { - "description": "Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.", + "description": "Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above.\nUse a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file\nto install.", "deprecated": true, "launch_stage": "GA" }, @@ -21654,12 +21766,12 @@ "launch_stage": "GA" }, "pypi": { - "description": "Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", + "description": "Specification of a PyPI library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", "ref": "compute.PythonPyPiLibrary", "launch_stage": "GA" }, "requirements": { - "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`", + "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`.\nInstalling a requirements file requires Databricks Runtime 15.0 or above.", "launch_stage": "GA" }, "whl": { @@ -21676,7 +21788,7 @@ "launch_stage": "GA" }, "library": { - "description": "Unique identifier for the library.", + "description": "The library whose status is reported.", "ref": "compute.Library", "launch_stage": "GA" }, @@ -21685,7 +21797,7 @@ "launch_stage": "GA" }, "status": { - "description": "Status of installing the library on the cluster.", + "description": "Status of installing the library on the cluster. The status starts at PENDING and ends at\nINSTALLED, FAILED or SKIPPED. Intermediate states are not always reported. A library stays\nUNINSTALL_ON_RESTART after an uninstall request until the cluster restarts. While the cluster\nis not running, libraries are reported as PENDING, and libraries marked for uninstall are\nomitted.", "ref": "compute.LibraryInstallStatus", "launch_stage": "GA" } @@ -22032,9 +22144,11 @@ "compute.LogAnalyticsInfo": { "fields": { "log_analytics_primary_key": { + "description": "Primary key of the Azure Log Analytics workspace. The agent uses it to authenticate when reporting to the workspace.", "launch_stage": "GA" }, "log_analytics_workspace_id": { + "description": "ID of the Azure Log Analytics workspace that the Log Analytics agent on the cluster's nodes reports to.", "launch_stage": "GA" } } @@ -22060,7 +22174,7 @@ "launch_stage": "GA" }, "exclusions": { - "description": "List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", + "description": "List of dependencies to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", "launch_stage": "GA" }, "repo": { @@ -22329,7 +22443,7 @@ "compute.PythonPyPiLibrary": { "fields": { "package": { - "description": "The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", + "description": "The name of the PyPI package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", "launch_stage": "GA" }, "repo": { @@ -22400,6 +22514,7 @@ "launch_stage": "GA" }, "restart_user": { + "description": "User name recorded in the `RESTARTING` cluster event as the user who restarted the cluster.\nIf omitted, the name of the user making the request is recorded.", "launch_stage": "GA" } } @@ -23126,7 +23241,7 @@ "launch_stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "launch_stage": "GA" }, "aws_attributes": { @@ -23153,6 +23268,7 @@ "launch_stage": "GA" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "ref": "compute.DataSecurityMode", "launch_stage": "GA" }, @@ -23162,7 +23278,7 @@ "launch_stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "ref": "compute.DockerImage", "launch_stage": "GA" }, @@ -23205,6 +23321,7 @@ "launch_stage": "GA" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "ref": "compute.Kind", "launch_stage": "GA" }, @@ -23263,6 +23380,7 @@ "launch_stage": "GA" }, "workload_type": { + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "ref": "compute.WorkloadType", "launch_stage": "GA" } @@ -23824,19 +23942,19 @@ "dashboards.AuthorizationDetails": { "fields": { "grant_rules": { - "description": "Represents downscoped permission rules with specific access rights.\nThis field is specific to `workspace_rule_set` constraint.", + "description": "Represents downscoped permission rules with specific access rights.\nThis field is specific to the `workspace_rule_set` constraint.", "launch_stage": "PUBLIC_PREVIEW" }, "resource_legacy_acl_path": { - "description": "The acl path of the tree store resource resource.", + "description": "The legacy ACL path of the workspace object that the rule applies to.", "launch_stage": "PUBLIC_PREVIEW" }, "resource_name": { - "description": "The resource name to which the authorization rule applies.\nThis field is specific to `workspace_rule_set` constraint.\nFormat: `workspaces/{workspace_id}/dashboards/{dashboard_id}`", + "description": "The resource name to which the authorization rule applies.\nThis field is specific to the `workspace_rule_set` constraint.\nFormat: `workspaces/{workspace_id}` for a workspace-level rule, or\n`workspaces/{workspace_id}/dashboards/{dashboard_id}` for a rule on a dashboard.", "launch_stage": "PUBLIC_PREVIEW" }, "type": { - "description": "The type of authorization downscoping policy.\nEx: `workspace_rule_set` defines access rules for a specific workspace resource", + "description": "The type of authorization downscoping policy. A `workspace_rule_set` policy defines access\nrules for a specific workspace resource.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -23844,7 +23962,7 @@ "dashboards.AuthorizationDetailsGrantRule": { "fields": { "permission_set": { - "description": "Permission sets for dashboard are defined in\niam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets\nEx: `permissionSets/dashboard.runner`", + "description": "The permission set that the rule grants on the resource.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -23886,7 +24004,7 @@ "dashboards.CronSchedule": { "fields": { "quartz_cron_expression": { - "description": "A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am.\nSee [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details.", + "description": "A cron expression in Quartz syntax that defines when the schedule runs.\nSee the [Quartz cron trigger tutorial](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for the syntax.", "launch_stage": "GA" }, "timezone_id": { @@ -23977,7 +24095,7 @@ "dashboards.DeleteSubscriptionRequest": { "fields": { "etag": { - "description": "The etag for the subscription. Can be optionally provided to ensure that the subscription has not been\nmodified since the last read.", + "description": "The etag of the subscription, as returned when it was read. If it is provided and no longer\nmatches, the request fails with ABORTED and the subscription is not deleted.", "launch_stage": "GA" } } @@ -25129,11 +25247,11 @@ "dashboards.GetPublishedDashboardTokenInfoRequest": { "fields": { "external_value": { - "description": "Provided external value to be included in the custom claim.", + "description": "Value to carry in the token for this viewer, such as a tenant or region key. Dashboard dataset\nqueries can reference it as `__aibi_external_value` to filter data per viewer. The combined size\nof `external_value` and `external_viewer_id` must be less than 1 KB.", "launch_stage": "PUBLIC_PREVIEW" }, "external_viewer_id": { - "description": "Provided external viewer id to be included in the custom claim.", + "description": "Identifier of the viewer in the external application. It is recorded in dashboard audit logs, so\nit should be unique per viewer and must not contain personally identifiable information.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -25141,15 +25259,15 @@ "dashboards.GetPublishedDashboardTokenInfoResponse": { "fields": { "authorization_details": { - "description": "Authorization constraints for accessing the published dashboard.\nCurrently includes `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before\noAuth token generation.", + "description": "Authorization constraints that restrict the minted token to viewing the published dashboard.\nPass them to the OAuth token endpoint serialized as a JSON array.", "launch_stage": "PUBLIC_PREVIEW" }, "custom_claim": { - "description": "Custom claim generated from external_value and external_viewer_id.\nFormat: `urn:aibi:external_data:\u003cexternal_value\u003e:\u003cexternal_viewer_id\u003e:\u003cdashboard_id\u003e`", + "description": "Custom claim that carries `external_value` and `external_viewer_id` into the minted token. It is\nonly present when at least one of those query parameters was provided.\nFormat: `urn:aibi:external_data:\u003cexternal_value\u003e:\u003cexternal_viewer_id\u003e:\u003cdashboard_id\u003e`", "launch_stage": "PUBLIC_PREVIEW" }, "scope": { - "description": "Scope defining access permissions.", + "description": "The space-separated OAuth scopes to request when minting the token.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -25466,18 +25584,18 @@ ] }, "embed_credentials": { - "description": "Indicates whether credentials are embedded in the published dashboard.", + "description": "Whether the publisher's credentials are embedded in the published dashboard. When true, viewers\nrun the dashboard's queries with the publisher's data permissions (shared data permissions);\nwhen false, each viewer runs them with their own data permissions.", "launch_stage": "GA" }, "revision_create_time": { - "description": "The timestamp of when the published dashboard was last revised.", + "description": "The timestamp of when the current published version was created, that is, when the dashboard\nwas last published.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "warehouse_id": { - "description": "The warehouse ID used to run the published dashboard.", + "description": "The ID of the SQL warehouse that runs the published dashboard's queries. It is the warehouse\ngiven when the dashboard was published, or the draft's warehouse if none was given.", "launch_stage": "GA" } } @@ -25522,7 +25640,7 @@ "description": "Request to revert a dashboard draft to its last published state.", "fields": { "etag": { - "description": "The etag for the dashboard. Optionally, it can be provided to verify that the dashboard\nhas not been modified from its last retrieval.", + "description": "The etag of the draft dashboard, as returned by the get dashboard API. When provided, the\nrequest fails with ABORTED if the draft has been modified since that etag was read.", "launch_stage": "GA" } } @@ -25538,6 +25656,7 @@ } }, "dashboards.Schedule": { + "description": "A schedule periodically runs a dashboard on a cron cadence. Each run executes the dashboard's\nqueries to refresh its cached data and sends a snapshot of the dashboard to the schedule's\nsubscribers. See [Manage scheduled dashboard updates and subscriptions](https://docs.databricks.com/dashboards/share/schedule-subscribe)\nfor details.", "fields": { "create_time": { "description": "A timestamp indicating when the schedule was created.", @@ -25547,7 +25666,7 @@ ] }, "cron_schedule": { - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "ref": "dashboards.CronSchedule", "launch_stage": "GA" }, @@ -25559,7 +25678,7 @@ ] }, "display_name": { - "description": "The display name for schedule.", + "description": "The name of the schedule, as shown in the dashboard's list of schedules.", "launch_stage": "GA" }, "etag": { @@ -25567,7 +25686,7 @@ "launch_stage": "GA" }, "pause_status": { - "description": "The status indicates whether this schedule is paused or not.", + "description": "Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but\nthe dashboard is not refreshed and no notifications are sent until the schedule is unpaused.", "ref": "dashboards.SchedulePauseStatus", "launch_stage": "GA" }, @@ -25586,7 +25705,7 @@ ] }, "warehouse_id": { - "description": "The warehouse id to run the dashboard with for the schedule.", + "description": "The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If\nomitted, the warehouse of the published dashboard is used.", "launch_stage": "GA" } } @@ -25660,18 +25779,19 @@ "dashboards.Subscriber": { "fields": { "destination_subscriber": { - "description": "The destination to receive the subscription email.\nThis parameter is mutually exclusive with `user_subscriber`.", + "description": "The notification destination that receives the subscription, such as an email list or a\nSlack or Microsoft Teams channel. Workspace admins configure notification destinations.", "ref": "dashboards.SubscriptionSubscriberDestination", "launch_stage": "GA" }, "user_subscriber": { - "description": "The user to receive the subscription email.\nThis parameter is mutually exclusive with `destination_subscriber`.", + "description": "The workspace user who receives the subscription.", "ref": "dashboards.SubscriptionSubscriberUser", "launch_stage": "GA" } } }, "dashboards.Subscription": { + "description": "A subscription registers a workspace user or a notification destination as a subscriber of a\ndashboard schedule. Each time the schedule runs, the subscriber receives a snapshot of the\npublished dashboard, unless the subscription is refresh-only. See\n[Manage scheduled dashboard updates and subscriptions](https://docs.databricks.com/dashboards/share/schedule-subscribe).", "fields": { "create_time": { "description": "A timestamp indicating when the subscription was created.", @@ -25695,7 +25815,7 @@ ] }, "etag": { - "description": "The etag for the subscription. Must be left empty on create, can be optionally provided on delete\nto ensure that the subscription has not been deleted since the last read.", + "description": "The etag of the subscription. It must be left empty on create. It can be passed as the `etag`\nparameter of the delete method to make sure the subscription has not changed since it was read.", "launch_stage": "GA" }, "schedule_id": { @@ -25706,11 +25826,11 @@ ] }, "skip_notify": { - "description": "Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.\nIf not defined, defaults to false in the backend to match the current behavior (refresh and notify)", + "description": "Whether the subscription is refresh-only. When true, each scheduled run refreshes the dashboard\ndata for the subscriber without sending a notification. Defaults to false. Refresh-only\nsubscriptions are only allowed on dashboards published without embedded credentials.", "launch_stage": "GA" }, "subscriber": { - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "ref": "dashboards.Subscriber", "launch_stage": "GA" }, @@ -25733,7 +25853,7 @@ "dashboards.SubscriptionSubscriberDestination": { "fields": { "destination_id": { - "description": "The canonical identifier of the destination to receive email notification.", + "description": "The UUID of the notification destination that receives the subscription, as returned by the\n[Notification Destinations API](https://docs.databricks.com/api/workspace/notificationdestinations).", "launch_stage": "GA" } } @@ -25741,7 +25861,7 @@ "dashboards.SubscriptionSubscriberUser": { "fields": { "user_id": { - "description": "UserId of the subscriber.", + "description": "The ID of the workspace user who receives the subscription, as returned by the\n[Workspace Users API](https://docs.databricks.com/api/workspace/users).", "launch_stage": "GA" } } @@ -27887,7 +28007,7 @@ ] }, "failover_type": { - "description": "The type of failover to perform.", + "description": "The type of failover to perform. FORCED is the only supported type.", "ref": "disasterrecovery.FailoverFailoverGroupRequestFailoverType", "launch_stage": "GA" }, @@ -27907,7 +28027,7 @@ } }, "disasterrecovery.FailoverGroup": { - "description": "A failover group manages disaster recovery across workspace sets,\ncoordinating Unity Catalog and workspace assets replication.", + "description": "A failover group manages Databricks Managed Disaster Recovery for a pair of workspaces in\ntwo regions. It continuously replicates the selected Unity Catalog catalogs and workspace\nassets from the primary region to the secondary region and lets you fail over to the\nsecondary region; at least one of the two replication types must be enabled. See\nhttps://docs.databricks.com/aws/en/admin/managed-disaster-recovery for the product\ndocumentation.", "fields": { "create_time": { "description": "Time at which this failover group was created.", @@ -27931,14 +28051,14 @@ ] }, "has_replication_point_blocking_errors": { - "description": "True if errors currently block the replication point.", + "description": "True when replication errors are preventing the replication point from advancing.\nPopulated only while the failover group is INITIAL_REPLICATION or ACTIVE; the blocking\nerrors are listed in the system.replication.states system table.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" ] }, "initial_primary_region": { - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -27961,21 +28081,21 @@ ] }, "regions": { - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "replication_point": { - "description": "The latest point in time to which data has been replicated.", + "description": "The most recent point in time up to which all in-scope assets have been replicated to the\nsecondary region. Data written after this point might not exist in the secondary yet and\ncan be lost in an unplanned failover. When both Unity Catalog and workspace assets are\nreplicated, this is the older of the two replication points. Not populated until the\nfirst replication point exists, and not populated in ListFailoverGroups responses.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "state": { - "description": "Aggregate state of the failover group.", + "description": "Aggregate state of the failover group across Unity Catalog and workspace asset\nreplication. The group is INITIAL_REPLICATION until it has a replication point, ACTIVE\nwhile replication is in steady state and failover is available, and FAILING_OVER while a\nfailover is in progress; the `*_FAILED` values mean that the last operation did not\ncomplete. Not populated in ListFailoverGroups responses.", "ref": "disasterrecovery.FailoverGroupState", "launch_stage": "GA", "behaviors": [ @@ -27983,7 +28103,7 @@ ] }, "unity_catalog_assets": { - "description": "Unity Catalog replication configuration.", + "description": "Unity Catalog replication configuration: the catalogs to replicate and the storage\nlocation mappings for their data. Omit it to replicate workspace assets only.", "ref": "disasterrecovery.UcReplicationConfig", "launch_stage": "GA", "behaviors": [ @@ -27998,7 +28118,7 @@ ] }, "workspace_sets": { - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "launch_stage": "GA" } } @@ -28032,7 +28152,7 @@ "description": "Progress of the initial replication of all in-scope assets (Unity Catalog and\nworkspace assets) of a FailoverGroup. Populated only while the FailoverGroup\nis in INITIAL_REPLICATION.", "fields": { "completed": { - "description": "Percent complete, 0-100.", + "description": "Percentage of in-scope assets replicated so far, from 0 to 100. Stays below 100 while\nerrors block the first replication point.", "launch_stage": "PUBLIC_BETA", "behaviors": [ "OUTPUT_ONLY" @@ -28106,11 +28226,11 @@ "description": "A location mapping identified by a name, with URIs per region.\nThe system derives replication direction from effective_primary_region.", "fields": { "name": { - "description": "Resource name for this location.", + "description": "Identifier of this location mapping, unique within the failover group.", "launch_stage": "GA" }, "uri_by_region": { - "description": "URI for each region. Each entry maps a region name to a storage URI.", + "description": "The storage URI of this location in each region, with exactly one entry per region of the\nfailover group.", "launch_stage": "GA" } } @@ -28119,11 +28239,11 @@ "description": "A single entry in a location mapping, mapping a region to a storage URI.\nUsed instead of map\u003cstring, string\u003e for proto2 compatibility.", "fields": { "region": { - "description": "The region name.", + "description": "Cloud region this URI applies to. Must be one of the failover group's regions.", "launch_stage": "GA" }, "uri": { - "description": "The storage URI for this region.", + "description": "Cloud storage URI of the location in this region. End the URI with `/*` to map every path\nunder it as a prefix; within one mapping, either all URIs or none carry the `/*` suffix.", "launch_stage": "GA" } } @@ -28182,7 +28302,7 @@ "description": "A Unity Catalog catalog to replicate.", "fields": { "name": { - "description": "The name of the UC catalog to replicate.", + "description": "Name of the Unity Catalog catalog to replicate.", "launch_stage": "GA" } } @@ -28191,15 +28311,15 @@ "description": "Unity Catalog replication configuration (top-level, not per-set).", "fields": { "catalogs": { - "description": "UC catalogs to replicate.", + "description": "Unity Catalog catalogs to replicate, including their metadata and managed table data.\nAdding a catalog to an existing failover group returns the group to INITIAL_REPLICATION\nuntil the catalog has been replicated.", "launch_stage": "GA" }, "data_replication_workspace_set": { - "description": "The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage.", + "description": "Name of the workspace set whose workspaces run the data replication for the catalogs'\nunderlying storage. Must match the name of a workspace set in this failover group.", "launch_stage": "GA" }, "location_mappings": { - "description": "Location mappings - storage URI per region for each location.", + "description": "Storage location mappings. Each mapping pairs a storage path used by the replicated\ncatalogs in one region with the corresponding path in the other region, so that\nreplicated data is written to the matching storage in the secondary region.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -28222,7 +28342,7 @@ "launch_stage": "GA" }, "update_mask": { - "description": "Comma-separated list of fields to update.", + "description": "Comma-separated list of the fields to update. The supported paths are `workspace_sets`,\n`unity_catalog_assets`, `unity_catalog_assets.catalogs` and\n`unity_catalog_assets.location_mappings`; any other path is rejected.", "launch_stage": "GA" } } @@ -28231,25 +28351,25 @@ "description": "A set of workspaces that replicate to each other across regions.", "fields": { "name": { - "description": "Resource name for this workspace set.", + "description": "Identifier of the workspace set, unique within the failover group and referenced by\nunity_catalog_assets.data_replication_workspace_set. Cannot be changed after creation.", "launch_stage": "GA" }, "replicate_workspace_assets": { - "description": "Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nDefaults to false.", + "description": "Whether to replicate workspace assets (notebooks, jobs, clusters, SQL warehouses and so\non) and their ACLs for this set. Defaults to false. Can be turned on or off with\nUpdateFailoverGroup.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "stable_url_names": { - "description": "Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl).", + "description": "Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl), and the list can only\nbe set when replicate_workspace_assets is true. While workspace asset replication stays\nenabled, an update can attach or detach one stable URL at a time.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "workspace_ids": { - "description": "Workspace IDs in this set. The system derives and validates regions.\nAll workspaces must be in the Mission Critical tier.", + "description": "IDs of the two workspaces in this set, one in each of the failover group's regions. The\nsystem derives and validates each workspace's region. Both workspaces must belong to the\naccount and have the Mission Critical add-on enabled, and they cannot be changed after\ncreation.", "launch_stage": "GA" } } @@ -28941,7 +29061,7 @@ "environments.UpdateWorkspaceBaseEnvironmentRequest": { "fields": { "workspace_base_environment": { - "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "description": "The workspace base environment with its new configuration.\nThe `name` path parameter identifies the environment to update. Set `display_name` and `filepath` on every\nupdate, even when they do not change. An update keeps the stored `base_environment_type`, but the YAML file is\nvalidated against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.", "ref": "environments.WorkspaceBaseEnvironment", "launch_stage": "GA" } @@ -28951,7 +29071,7 @@ "description": "A WorkspaceBaseEnvironment defines a workspace-level environment configuration\nconsisting of an environment version and a list of dependencies.", "fields": { "base_environment_type": { - "description": "The type of base environment (CPU or GPU).", + "description": "The type of base environment (CPU or GPU). The default is `CPU`.", "ref": "environments.BaseEnvironmentType", "launch_stage": "GA", "behaviors": [ @@ -28977,7 +29097,7 @@ "launch_stage": "GA" }, "filepath": { - "description": "The WSFS or UC Volumes path to the environment YAML file.", + "description": "The workspace file or Unity Catalog volume path to the YAML file that defines the environment version and\ndependencies. The file name must end in `.yaml` or `.yml`. Create and update requests must set this field.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -28998,18 +29118,18 @@ ] }, "message": { - "description": "Status message providing additional details about the environment status.", + "description": "Status message providing additional details about the environment status.\nWhen the status is `FAILED`, the message contains the build error.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\nThe server ignores this field on create and builds the name from `workspace_base_environment_id`, or from\n`display_name` plus a random suffix when no ID is given.", "launch_stage": "GA" }, "spec": { - "description": "The environment specification containing version and dependencies.", + "description": "The environment specification containing version and dependencies, read from the YAML file at `filepath`.", "ref": "environments.EnvironmentSpec", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -29017,7 +29137,7 @@ ] }, "status": { - "description": "The status of the materialized workspace base environment.", + "description": "The status of the materialized workspace base environment, which the server builds from the YAML file.\nThe status is `CREATED` once the build has succeeded.", "ref": "environments.WorkspaceBaseEnvironmentCacheStatus", "launch_stage": "GA", "behaviors": [ @@ -30143,24 +30263,26 @@ } }, "iam.AccountGroup": { + "description": "Represents a group of users, service principals and other groups in the Databricks account.\nMembers inherit the permissions that are granted to the group.", "fields": { "account_id": { - "description": "Databricks account ID", + "description": "Identifies the Databricks account that the group belongs to.", "launch_stage": "GA" }, "displayName": { - "description": "String that represents a human-readable group name", + "description": "Identifies the group by a human-readable name. The name must be unique within the account and\nmust not exceed 255 characters.", "launch_stage": "GA" }, "externalId": { - "description": "external_id should be unique for identifying groups", + "description": "Identifies the group in an external identity provider. Identity providers use it to match the\ngroups they manage to Databricks groups, so it should be unique among the groups in the account.", "launch_stage": "GA" }, "id": { - "description": "Databricks group ID", + "description": "Identifies the group within Databricks. Databricks generates the ID when the group is created.", "launch_stage": "GA" }, "members": { + "description": "Lists the members of the group. Each entry identifies a user, service principal or group in the\naccount by its ID in the value sub-attribute.", "launch_stage": "GA" }, "meta": { @@ -30169,38 +30291,40 @@ "launch_stage": "PRIVATE_PREVIEW" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the group. The only supported role value is\n`account_admin`.", "launch_stage": "GA" } } }, "iam.AccountServicePrincipal": { + "description": "Represents a service principal in the Databricks account. Service principals are identities for\njobs, automated tools and systems such as scripts, apps and CI/CD platforms.", "fields": { "account_id": { - "description": "Databricks account ID", + "description": "Identifies the Databricks account that the service principal belongs to.", "launch_stage": "GA" }, "active": { - "description": "If this user is active", + "description": "Indicates whether the service principal is active. A deactivated service principal cannot\nauthenticate or access Databricks APIs, but it keeps its permissions.", "launch_stage": "GA" }, "applicationId": { - "description": "UUID relating to the service principal", + "description": "Identifies the service principal when it authenticates to Databricks. Databricks generates\nthe application ID, except on Azure, where it can be the application ID of a Microsoft Entra\nID service principal.", "launch_stage": "GA" }, "displayName": { - "description": "String that represents a concatenation of given and family names.", + "description": "Identifies the service principal by a human-readable name.", "launch_stage": "GA" }, "externalId": { + "description": "Identifies the service principal in an external identity provider. Identity providers use it\nto match the service principals they manage to Databricks service principals.", "launch_stage": "GA" }, "id": { - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks. Databricks generates the ID when the\nservice principal is created.", "launch_stage": "GA" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the service principal. The only supported role\nvalue is `account_admin`.", "launch_stage": "GA" } } @@ -30340,17 +30464,19 @@ "iam.CreateAccountGroupRequest": { "fields": { "displayName": { - "description": "String that represents a human-readable group name", + "description": "Sets the human-readable name of the group. The name must be unique within the account and must\nnot exceed 255 characters.", "launch_stage": "GA" }, "externalId": { + "description": "Sets the identifier of the group in an external identity provider.", "launch_stage": "GA" }, "id": { - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "launch_stage": "GA" }, "members": { + "description": "Lists the members of the group. Each entry identifies a user, service principal or group in the\naccount by its ID in the value sub-attribute.", "launch_stage": "GA" }, "meta": { @@ -30359,7 +30485,7 @@ "launch_stage": "PRIVATE_PREVIEW" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the group. The only supported role value is\n`account_admin`.", "launch_stage": "GA" } } @@ -30367,26 +30493,27 @@ "iam.CreateAccountServicePrincipalRequest": { "fields": { "active": { - "description": "If this user is active", + "description": "Indicates whether the service principal is active. A deactivated service principal cannot\nauthenticate or access Databricks APIs, but it keeps its permissions.", "launch_stage": "GA" }, "applicationId": { - "description": "UUID relating to the service principal", + "description": "Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this\nfield. On AWS and GCP, Databricks generates the application ID and rejects requests that set\nit.", "launch_stage": "GA" }, "displayName": { - "description": "String that represents a concatenation of given and family names.", + "description": "Sets the human-readable name of the service principal. The name is required unless the\nrequest sets `applicationId`.", "launch_stage": "GA" }, "externalId": { + "description": "Sets the identifier of the service principal in an external identity provider.", "launch_stage": "GA" }, "id": { - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "launch_stage": "GA" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the service principal. The only supported role\nvalue is `account_admin`.", "launch_stage": "GA" } } @@ -30767,7 +30894,7 @@ "launch_stage": "GA" }, "count": { - "description": "Desired number of results per page. Default is 10000.", + "description": "Specifies the number of results per page. When omitted, the server uses its default page size.", "launch_stage": "GA" }, "excludedAttributes": { @@ -30796,7 +30923,7 @@ "iam.ListAccountGroupsResponse": { "fields": { "Resources": { - "description": "User objects returned in the response.", + "description": "Group objects returned in the response.", "launch_stage": "GA" }, "itemsPerPage": { @@ -30849,7 +30976,7 @@ "iam.ListAccountServicePrincipalsResponse": { "fields": { "Resources": { - "description": "User objects returned in the response.", + "description": "Lists the service principals that are returned in the response.", "launch_stage": "GA" }, "itemsPerPage": { @@ -31332,6 +31459,7 @@ "iam.PatchAccountGroupRequest": { "fields": { "Operations": { + "description": "Lists the patch operations to apply to the group.", "launch_stage": "GA" }, "schemas": { @@ -31343,6 +31471,7 @@ "iam.PatchAccountServicePrincipalRequest": { "fields": { "Operations": { + "description": "Lists the patch operations to apply to the service principal.", "launch_stage": "GA" }, "schemas": { @@ -31573,7 +31702,7 @@ "launch_stage": "PRIVATE_PREVIEW" }, "parent_resource_info": { - "description": "Parent resource info for the current resource. The parent may have another parent.", + "description": "Deprecated: use `contributing_resources`.\nParent resource info for the current resource. The parent may have another parent.", "ref": "iam.ResourceInfo", "launch_stage": "PRIVATE_PREVIEW" } @@ -31704,13 +31833,15 @@ "iam.UpdateAccountGroupRequest": { "fields": { "displayName": { - "description": "String that represents a human-readable group name", + "description": "Sets the human-readable name of the group. The name must be unique within the account and must\nnot exceed 255 characters.", "launch_stage": "GA" }, "externalId": { + "description": "Sets the identifier of the group in an external identity provider.", "launch_stage": "GA" }, "members": { + "description": "Lists the members of the group. Each entry identifies a user, service principal or group in the\naccount by its ID in the value sub-attribute.", "launch_stage": "GA" }, "meta": { @@ -31719,7 +31850,7 @@ "launch_stage": "PRIVATE_PREVIEW" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the group. The only supported role value is\n`account_admin`.", "launch_stage": "GA" } } @@ -31727,22 +31858,23 @@ "iam.UpdateAccountServicePrincipalRequest": { "fields": { "active": { - "description": "If this user is active", + "description": "Indicates whether the service principal is active. A deactivated service principal cannot\nauthenticate or access Databricks APIs, but it keeps its permissions.", "launch_stage": "GA" }, "applicationId": { - "description": "UUID relating to the service principal", + "description": "Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this\nfield. On AWS and GCP, Databricks generates the application ID and rejects requests that set\nit.", "launch_stage": "GA" }, "displayName": { - "description": "String that represents a concatenation of given and family names.", + "description": "Sets the human-readable name of the service principal. The name is required unless the\nrequest sets `applicationId`.", "launch_stage": "GA" }, "externalId": { + "description": "Sets the identifier of the service principal in an external identity provider.", "launch_stage": "GA" }, "roles": { - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the service principal. The only supported role\nvalue is `account_admin`.", "launch_stage": "GA" } } @@ -32492,7 +32624,7 @@ ] }, "group_id": { - "description": "The Databricks ID of the group.", + "description": "The Databricks ID of the group. It is a numeric string that Databricks assigns when the group\nis created, and it is the `{group_id}` segment of `name`.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32500,7 +32632,7 @@ ] }, "group_name": { - "description": "The name of the group.", + "description": "The display name of the group. It must be unique in the account, must not be blank, and must be\nshorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of a\ngroup that Databricks manages, such as `admins` or `users`.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -34665,12 +34797,15 @@ "jobs.ContinuousTriggerState": { "fields": { "consecutive_failures": { + "description": "The number of consecutive unsuccessful runs. Resets to `0` after a healthy run and determines the exponential backoff before the next run.", "launch_stage": "PUBLIC_BETA" }, "is_backing_off": { + "description": "Whether the trigger is delaying the next run with exponential backoff after repeated failures.", "launch_stage": "PUBLIC_BETA" }, "next_attempt_ms": { + "description": "The time at which the trigger next attempts to start a run, in epoch milliseconds.", "launch_stage": "PUBLIC_BETA" } } @@ -34736,6 +34871,7 @@ "launch_stage": "GA" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "ref": "jobs.JobsHealthRules", "launch_stage": "GA" }, @@ -35495,6 +35631,7 @@ "launch_stage": "GA" }, "git_snapshot": { + "description": "Read-only state of the remote repository at the time the job was run. This field is only included on job runs.", "ref": "jobs.GitSnapshot", "launch_stage": "GA" }, @@ -35513,6 +35650,7 @@ "launch_stage": "PRIVATE_PREVIEW" }, "sparse_checkout": { + "description": "Sparse checkout settings for the repository. When set, only the directories listed in `patterns` are checked out.", "ref": "jobs.SparseCheckout", "launch_stage": "GA" } @@ -35694,7 +35832,7 @@ "launch_stage": "PUBLIC_BETA" }, "workspace_id": { - "description": "The ID of the workspace containing the upstream job.\nThis can differ from the caller's workspace and downstream services enforce\ncorrect entitlements and CAN_VIEW permissions for the user + job combination.\nSDR: https://databricks.atlassian.net/browse/SDR-5267", + "description": "The ID of the workspace containing the upstream job.\nThis can differ from the caller's workspace and downstream services enforce\ncorrect entitlements and CAN_VIEW permissions for the user + job combination.", "launch_stage": "PUBLIC_BETA" } } @@ -35892,6 +36030,7 @@ "launch_stage": "GA" }, "spec": { + "description": "The environment specification, including the environment version and the dependencies to install before a task runs.", "ref": "compute.Environment", "launch_stage": "GA" } @@ -36101,6 +36240,7 @@ "launch_stage": "GA" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "ref": "jobs.JobsHealthRules", "launch_stage": "GA" }, @@ -36253,10 +36393,12 @@ "jobs.JobsHealthRule": { "fields": { "metric": { + "description": "Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.", "ref": "jobs.JobsHealthMetric", "launch_stage": "GA" }, "op": { + "description": "Specifies the operator used to compare the health metric value with the specified threshold.", "ref": "jobs.JobsHealthOperator", "launch_stage": "GA" }, @@ -36270,6 +36412,7 @@ "description": "An optional set of health rules that can be defined for this job.", "fields": { "rules": { + "description": "The health rules to evaluate for each run.", "launch_stage": "GA" } } @@ -36541,14 +36684,17 @@ "description": "Per-trigger runtime state for the multi-trigger surface. Mirrors `TriggerConfiguration`'s\ntrigger-type variants 1:1; each entry sets exactly one variant matching the corresponding\ntrigger's type. Variants with no runtime state today (`schedule`, `model`) are emitted as\nempty messages.", "fields": { "continuous": { + "description": "State of the continuous trigger.", "ref": "jobs.ContinuousTriggerState", "launch_stage": "PUBLIC_BETA" }, "file_arrival": { + "description": "State of the file arrival trigger.", "ref": "jobs.FileArrivalTriggerState", "launch_stage": "PUBLIC_BETA" }, "job_completion": { + "description": "State of the job completion trigger.", "ref": "jobs.JobCompletionTriggerState", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -36556,6 +36702,7 @@ ] }, "model": { + "description": "State of the model trigger.", "ref": "jobs.ModelTriggerState", "launch_stage": "PUBLIC_BETA" }, @@ -36565,10 +36712,12 @@ "launch_stage": "PUBLIC_BETA" }, "periodic": { + "description": "State of the periodic trigger.", "ref": "jobs.PeriodicTriggerState", "launch_stage": "PUBLIC_BETA" }, "schedule": { + "description": "State of the cron schedule trigger.", "ref": "jobs.ScheduleTriggerState", "launch_stage": "PUBLIC_BETA" }, @@ -36578,6 +36727,7 @@ "launch_stage": "PUBLIC_BETA" }, "table_update": { + "description": "State of the table update trigger.", "ref": "jobs.TableTriggerState", "launch_stage": "PUBLIC_BETA" } @@ -36624,6 +36774,7 @@ "jobs.PeriodicTriggerState": { "fields": { "next_run_time": { + "description": "The time of the next scheduled run, in epoch milliseconds. Only set while the trigger is not paused.", "launch_stage": "PUBLIC_BETA" } } @@ -37536,7 +37687,7 @@ "launch_stage": "GA" }, "job_parameters": { - "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "description": "Job-level parameters used in the run, for example `\"param\": \"overriding_val\"`.", "launch_stage": "GA" }, "notebook_params": { @@ -38173,7 +38324,7 @@ "jobs.SparseCheckout": { "fields": { "patterns": { - "description": "List of patterns to include for sparse checkout.", + "description": "List of patterns to include for sparse checkout. Each pattern is the path of a directory relative to the repository root.", "launch_stage": "GA" } } @@ -38218,8 +38369,11 @@ "jobs.SqlConditionConfiguration": { "fields": { "sql_query_id": { - "description": "The ID of the SQL query to evaluate as the trigger condition.", - "launch_stage": "PUBLIC_BETA" + "description": "The ID of the SQL query to evaluate as the trigger condition.\nExactly one of `sql_query_id` or `file` must be set.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] }, "trigger_mode": { "description": "Determines how the SQL query result is interpreted to decide whether the condition fires.\nMust be set to a recognized value when provided.\nWhen unset on an existing serialized configuration, the server preserves the original\nsemantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this\nexplicitly — explicit `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED` is rejected at validation.", @@ -39036,6 +39190,7 @@ "jobs.TableTriggerState": { "fields": { "last_seen_table_states": { + "description": "The last observed state of each monitored table.", "launch_stage": "GA" }, "using_scalable_monitoring": { @@ -39163,6 +39318,7 @@ "launch_stage": "PRIVATE_PREVIEW" }, "health": { + "description": "An optional set of health rules that can be defined for this task.", "ref": "jobs.JobsHealthRules", "launch_stage": "GA" }, @@ -39653,6 +39809,7 @@ "launch_stage": "PUBLIC_BETA" }, "table_update": { + "description": "Table update trigger settings.", "ref": "jobs.TableUpdateTriggerConfiguration", "launch_stage": "GA" } @@ -39661,10 +39818,12 @@ "jobs.TriggerStateProto": { "fields": { "file_arrival": { + "description": "State of the file arrival trigger.", "ref": "jobs.FileArrivalTriggerState", "launch_stage": "GA" }, "job_completion": { + "description": "State of the job completion trigger.", "ref": "jobs.JobCompletionTriggerState", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -39682,6 +39841,7 @@ "launch_stage": "PUBLIC_BETA" }, "table": { + "description": "State of the table update trigger.", "ref": "jobs.TableTriggerState", "launch_stage": "GA" } @@ -39802,6 +39962,7 @@ "jobs.Webhook": { "fields": { "id": { + "description": "The ID of the notification destination to call. Must be a UUID.", "launch_stage": "GA" } } @@ -40535,6 +40696,87 @@ "AUTOLOADER_FORMAT_XML": "PUBLIC_BETA" } }, + "lakewatch.BuiltinParser": { + "description": "A Databricks-authored parser, shared by every customer.\n\nSame container-plus-versions shape as the custom `Parser`, and\naddressed the same way, by UUID. Built-ins are global rather than\ncatalog-scoped, so they carry no owning catalog or schema.", + "fields": { + "latest_version": { + "description": "Newest published version number.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name. Format: `builtin-parsers/{parser_id}`.", + "launch_stage": "PUBLIC_BETA" + }, + "parser_id": { + "description": "The parser's UUID, authored into the built-in's published definition rather\nthan minted per customer, so every workspace addresses the same built-in by\nthe same id. It is the leaf of `name`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parser_name": { + "description": "The built-in's own leaf name, as published in content-marketplace. Stable and\nhuman-readable, which is what a UI shows; `name` addresses the resource by id.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tags": { + "description": "Key/value tags describing this parser, e.g.\n`cloud_provider=aws` or `log_source=cloudtrail`. A parser may carry up to\n32. Filterable on list.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "lakewatch.BuiltinParserVersion": { + "description": "One published version of a built-in parser, carrying the spec.\n\nThe content pipeline owns versioning, so unlike the custom version there is no\nauthoring principal and no append timestamp here.", + "fields": { + "description": { + "description": "Free-form description of this parser, authored by Databricks.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name. Format:\n`builtin-parsers/{parser_id}/versions/{version}`.", + "launch_stage": "PUBLIC_BETA" + }, + "parser_name": { + "description": "The parent built-in's published leaf name, copied from the container on read.\nDenormalized so a caller that needs identity alongside the spec reads the\nversion alone rather than the container as well. Populated by\n`GetBuiltinParserVersion`; List omits it, as List omits `spec`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The parser spec: the field definitions for this log source, as\na YAML document. Read-only; built-in specs are authored by Databricks, so\nno client-facing size cap is enforced here.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tags": { + "description": "The parent built-in's tags, copied from the container on read. Rendering reads\nthese for connector-specific details, such as the source table a Lakeflow\nConnect parser reads.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "version": { + "description": "Version number.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "lakewatch.CloudWatchLogsEnvelope": { "description": "Unwraps an AWS CloudWatch Logs delivery envelope: each element of `logEvents`\nbecomes its own row, with the element's `message` parsed as the event body.", "fields": { @@ -40616,6 +40858,24 @@ } } }, + "lakewatch.CreateParserRequest": { + "fields": { + "parser": { + "description": "The parser to create. `spec` and `description` become version 1.", + "ref": "lakewatch.Parser", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "lakewatch.CreateParserVersionRequest": { + "fields": { + "parser_version": { + "description": "The version to append.", + "ref": "lakewatch.ParserVersion", + "launch_stage": "PUBLIC_BETA" + } + } + }, "lakewatch.CreateRuleRequest": { "fields": { "rule": { @@ -40921,6 +41181,8 @@ } }, "lakewatch.DeleteDatasourceRequest": {}, + "lakewatch.DeleteParserRequest": {}, + "lakewatch.DeleteParserVersionRequest": {}, "lakewatch.DeleteRuleRequest": {}, "lakewatch.Envelope": { "description": "Unwraps a transport envelope from the source data so that each contained event becomes\nits own row. Applied when the source data is read, before parsing.", @@ -41047,9 +41309,13 @@ } }, "lakewatch.GetAlertConfigRequest": {}, + "lakewatch.GetBuiltinParserRequest": {}, + "lakewatch.GetBuiltinParserVersionRequest": {}, "lakewatch.GetCommonConfigRequest": {}, "lakewatch.GetDatasourceConfigRequest": {}, "lakewatch.GetDatasourceRequest": {}, + "lakewatch.GetParserRequest": {}, + "lakewatch.GetParserVersionRequest": {}, "lakewatch.GetRuleConfigRequest": {}, "lakewatch.GetRuleRequest": {}, "lakewatch.JiraExportConfig": { @@ -41085,6 +41351,75 @@ } } }, + "lakewatch.ListBuiltinParserVersionsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of results to return in one page. If unset or 0, at most 100 versions\nare returned. The maximum allowed value is 1000.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous `ListBuiltinParserVersions` response, used to fetch the\nnext page of results.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "lakewatch.ListBuiltinParserVersionsResponse": { + "description": "A page of built-in version metadata, without the specs.", + "fields": { + "builtin_parser_versions": { + "description": "Version metadata only, oldest first, without the spec.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "Opaque token for fetching the next page; pass it as `page_token` on the next call.\nIt is empty when there are no more results.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "lakewatch.ListBuiltinParsersRequest": { + "fields": { + "filter": { + "description": "AIP-160 filter expression. Built-ins are filterable by their `tags`; the\nexact tag-filter grammar is defined by the server.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous `ListBuiltinParsers` response, used to fetch the next\npage of results.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "lakewatch.ListBuiltinParsersResponse": { + "description": "A page of built-in parsers, without their specs.", + "fields": { + "builtin_parsers": { + "description": "Summary rows: the container fields only, without the spec. Read a spec with\n`GetBuiltinParserVersion`.", + "launch_stage": "PUBLIC_BETA" + }, + "next_page_token": { + "description": "Opaque token for fetching the next page; pass it as `page_token` on the next\ncall. It is empty only when there are no more results. Page size is best-effort,\nso a short or even empty page does not mean the end; keep paging until this\ntoken is empty, which is the only reliable end-of-results signal.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "lakewatch.ListDatasourcesRequest": { "fields": { "catalog_name": { @@ -41139,6 +41474,86 @@ } } }, + "lakewatch.ListParserVersionsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous `ListParserVersions` response, used to fetch the next\npage of results. Send the same `parent` when requesting later pages; a token from a\nrequest for a different parser is rejected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "lakewatch.ListParserVersionsResponse": { + "description": "A page of version metadata, without the specs.", + "fields": { + "next_page_token": { + "description": "Opaque token for fetching the next page; pass it as `page_token` on the next\ncall. It is empty only when there are no more results. Page size is best-effort,\nso a short or even empty page does not mean the end; keep paging until this\ntoken is empty, which is the only reliable end-of-results signal.", + "launch_stage": "PUBLIC_BETA" + }, + "parser_versions": { + "description": "Version metadata only, oldest first, without the spec. Each row's\n`create_time` and `created_by` are that version's own.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "lakewatch.ListParsersRequest": { + "fields": { + "catalog_name": { + "description": "Name of the parent UC catalog to list parsers from. Required:\nList is scoped to a single catalog, mirroring the Unity Catalog\ntables/functions APIs, which take catalog_name as a request field (bound to\na query parameter) rather than a catalog path segment.", + "launch_stage": "PUBLIC_BETA" + }, + "filter": { + "description": "AIP-160 filter expression. Parsers are filterable by `parser_name`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_size": { + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Page token from a previous `ListParsers` response, used to fetch the next page of\nresults. Send the other request fields unchanged when requesting later pages; a\ntoken from a request with different fields is rejected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "schema_name": { + "description": "Name of the parent UC schema. Optional: when set, results are narrowed to\nthis schema; when omitted, parsers across all schemas in\n`catalog_name` are returned.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "lakewatch.ListParsersResponse": { + "description": "A page of parsers, without their specs.", + "fields": { + "next_page_token": { + "description": "Opaque token for fetching the next page; pass it as `page_token` on the next\ncall. It is empty only when there are no more results. Page size is best-effort,\nso a short or even empty page does not mean the end; keep paging until this\ntoken is empty, which is the only reliable end-of-results signal.", + "launch_stage": "PUBLIC_BETA" + }, + "parsers": { + "description": "Summary rows: the container fields only, without the spec. Read a spec with\n`GetParserVersion`.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "lakewatch.ListRulesRequest": { "fields": { "catalog_name": { @@ -41195,6 +41610,104 @@ } } }, + "lakewatch.Parser": { + "description": "A customer-authored, versioned contract describing the fields of an ingested\nlog source.\n\nThe parser is a container: it carries the identity and a pointer to the\nnewest version. Specs live on the immutable `ParserVersion` children, so one\nparser can be attached to many data sources and each attachment pins a\nversion.", + "fields": { + "catalog_name": { + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "create_time": { + "description": "When the parser was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The principal that created this parser. Each version records its own\n`created_by`.", + "ref": "lakewatch.Principal", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "Description of version 1. Accepted only by `CreateParser`; read a version's\ndescription with `GetParserVersion`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE", + "INPUT_ONLY", + "OPTIONAL" + ] + }, + "effective_catalog_name": { + "description": "The current name of the parser's UC catalog. Tracks UC renames; when the\ncurrent name cannot be looked up, the name as of the parser's last write.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "effective_schema_name": { + "description": "The current name of the parser's UC schema. Tracks UC renames; when the\ncurrent name cannot be looked up, the name as of the parser's last write.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "latest_version": { + "description": "Newest version of this parser. Read its spec by passing this to\n`GetParserVersion`, or by using the `latest` alias. Absent when every version\nhas been deleted.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name. Format: `parsers/{parser_id}`, where the leaf is the\nimmutable server-assigned UUID. Create-time placement names are stored\nseparately and do not affect the resource name.", + "launch_stage": "PUBLIC_BETA" + }, + "owner": { + "description": "The principal that owns this parser. Server-set from the authenticated\ncreator, never supplied by the client. Beta reads by UUID perform no\nauthorization. Owner-gated write RPCs are outside this API's current\nimplementation scope.", + "ref": "lakewatch.Principal", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parser_id": { + "description": "The parser's server-assigned UUID. It is not currently a UC securable ID,\nis immutable for the life of the resource, is the leaf of `name`, and is\nreturned by CreateParser.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "parser_name": { + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "schema_name": { + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "spec": { + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE", + "INPUT_ONLY" + ] + } + } + }, "lakewatch.ParserRef": { "description": "Reference to a parser that the datasource uses. Each parser defines the schema of the\nparsed table that it writes.", "fields": { @@ -41224,6 +41737,75 @@ } } }, + "lakewatch.ParserTag": { + "description": "A key/value tag on a built-in parser, e.g. `key = \"cloud_provider\"`,\n`value = \"aws\"`. Key/value pairs match the tag shape used across Databricks\n(MLflow, model-serving endpoints, clusters) rather than a bare string list.", + "fields": { + "key": { + "description": "The tag key, e.g. `cloud_provider`. Required: a keyless tag cannot be\nfiltered on and is meaningless.", + "launch_stage": "PUBLIC_BETA" + }, + "value": { + "description": "The tag value, e.g. `aws`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "lakewatch.ParserVersion": { + "description": "One immutable version of a parser, carrying the spec.\n\nImmutable: an edit creates a new version rather than mutating an existing\none, so a data source that pins a version is never affected. Version numbers\nare never reused, including after a delete.", + "fields": { + "create_time": { + "description": "When this version was appended.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "The principal that appended this version.", + "ref": "lakewatch.Principal", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "description": { + "description": "Free-form description of this version, set when the version is created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE", + "OPTIONAL" + ] + }, + "name": { + "description": "Resource name. Format:\n`parsers/{parser_id}/versions/{version}`.", + "launch_stage": "PUBLIC_BETA" + }, + "parser_name": { + "description": "The parent parser's name, copied from the container on read. Denormalized so a\ncaller that needs identity alongside the spec reads the version alone rather\nthan the container as well. Populated by `GetParserVersion`; List omits it, as\nList omits `spec`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "spec": { + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "IMMUTABLE" + ] + }, + "version": { + "description": "Version number, assigned by the server when the version is appended.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "lakewatch.Principal": { "description": "A principal — user or service-principal — used as the value type for\n`created_by` / `updated_by` / `assignee` etc. across v2 resources.", "fields": { @@ -44453,15 +45035,15 @@ "ml.CreateExperiment": { "fields": { "artifact_location": { - "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", + "description": "URI of the location where the artifacts of the experiment's runs are stored, such as a Unity\nCatalog volume path of the form `dbfs:/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/\u003cpath\u003e`. The URI\nmust have a scheme other than `file` and must not point under the MLflow-managed prefix\n`dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed\nstorage. See https://docs.databricks.com/aws/en/mlflow/experiments for the supported\nlocations.", "launch_stage": "GA" }, "name": { - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "launch_stage": "GA" }, "tags": { - "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", + "description": "Tags to set on the new experiment, as key-value pairs. A request can include at most 100\ntags.", "launch_stage": "GA" }, "trace_location": { @@ -44701,15 +45283,15 @@ "ml.CreateModelVersionRequest": { "fields": { "description": { - "description": "Optional description for model version.", + "description": "Description of the model version.", "launch_stage": "GA" }, "name": { - "description": "Register model under this name", + "description": "Name of the existing registered model to create the version under.", "launch_stage": "GA" }, "run_id": { - "description": "MLflow run ID for correlation, if `source` was generated by an experiment run in\nMLflow tracking server", + "description": "ID of the MLflow run that produced the model artifacts, if `source` comes from a run in the\nMLflow tracking server. The ID is at most 32 characters long.", "launch_stage": "GA" }, "run_link": { @@ -44717,11 +45299,11 @@ "launch_stage": "GA" }, "source": { - "description": "URI indicating the location of the model artifacts.", + "description": "URI of the model artifacts to register, such as the artifact path of an MLflow run or a\n`models:/\u003cmodel_name\u003e/\u003cversion\u003e` URI of an existing `READY` model version. The registry copies\nthe artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.", "launch_stage": "GA" }, "tags": { - "description": "Additional metadata for model version.", + "description": "Tags to set on the new model version.", "launch_stage": "GA" } } @@ -44729,7 +45311,7 @@ "ml.CreateModelVersionResponse": { "fields": { "model_version": { - "description": "Return new version number generated for this model in registry.", + "description": "The new model version, including the version number that the registry assigned.", "ref": "ml.ModelVersion", "launch_stage": "GA" } @@ -45520,11 +46102,11 @@ "description": "An experiment and its metadata.", "fields": { "artifact_location": { - "description": "Location where artifacts for the experiment are stored.", + "description": "URI of the location where the artifacts of the experiment's runs are stored. Experiments\ncreated without an explicit location use MLflow-managed storage under\n`dbfs:/databricks/mlflow-tracking/\u003cexperiment_id\u003e`.", "launch_stage": "GA" }, "creation_time": { - "description": "Creation time", + "description": "Time when the experiment was created, as a Unix timestamp in milliseconds.", "launch_stage": "GA" }, "experiment_id": { @@ -45532,19 +46114,19 @@ "launch_stage": "GA" }, "last_update_time": { - "description": "Last update time", + "description": "Time when the experiment metadata was last updated, as a Unix timestamp in milliseconds.", "launch_stage": "GA" }, "lifecycle_stage": { - "description": "Current life cycle stage of the experiment: \"active\" or \"deleted\".\nDeleted experiments are not returned by APIs.", + "description": "Current life cycle stage of the experiment: `active` or `deleted`. Deleted experiments are\nexcluded from list and search results unless `view_type` requests them, and can be restored\nuntil they are permanently deleted.", "launch_stage": "GA" }, "name": { - "description": "Human readable name that identifies the experiment.", + "description": "Name of the experiment. A workspace experiment is named by its absolute path in the\nworkspace; a notebook experiment has the path of its notebook.", "launch_stage": "GA" }, "tags": { - "description": "Tags: Additional metadata key-value pairs.", + "description": "Tags set on the experiment, as key-value pairs, including system tags such as\n`mlflow.ownerId` that MLflow maintains.", "launch_stage": "GA" }, "trace_location": { @@ -45658,11 +46240,11 @@ "description": "A tag for an experiment.", "fields": { "key": { - "description": "The tag key.", + "description": "The tag key. Keys are at most 255 characters long.", "launch_stage": "GA" }, "value": { - "description": "The tag value.", + "description": "The tag value. Values are at most 65535 characters long.", "launch_stage": "GA" } } @@ -47122,7 +47704,7 @@ "launch_stage": "GA" }, "page_token": { - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "launch_stage": "GA" }, "view_type": { @@ -48040,6 +48622,14 @@ "OPTIONAL" ] }, + "operations": { + "description": "Operations associated with this materialized feature.", + "ref": "ml.MaterializedFeatureOperations", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "pipeline_id": { "description": "The ID of the pipeline that materializes this feature. This is only present for streaming features.", "launch_stage": "PRIVATE_PREVIEW", @@ -48105,6 +48695,18 @@ } } }, + "ml.MaterializedFeatureOperations": { + "description": "References to operations on a materialized feature.", + "fields": { + "latest_entity_purge_operation": { + "description": "Name of the latest entity purge operation. Format: operations/{operation_id}.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "ml.MaterializedFeaturePipelineScheduleState": { "enum": [ "SNAPSHOT", @@ -48281,50 +48883,51 @@ } }, "ml.ModelVersion": { + "description": "A version of a registered model in the Workspace Model Registry. Each version points to the\nmodel artifacts it was registered from and moves through the stages `None`, `Staging`,\n`Production` and `Archived`.", "fields": { "creation_timestamp": { - "description": "Timestamp recorded when this `model_version` was created.", + "description": "Time when the model version was created, as a Unix timestamp in milliseconds.", "launch_stage": "GA" }, "current_stage": { - "description": "Current stage for this `model_version`.", + "description": "Current stage of the model version. Valid values are `None`, `Staging`, `Production` and\n`Archived`. A new model version starts in `None`.", "launch_stage": "GA" }, "description": { - "description": "Description of this `model_version`.", + "description": "User-provided description of the model version.", "launch_stage": "GA" }, "last_updated_timestamp": { - "description": "Timestamp recorded when metadata for this `model_version` was last updated.", + "description": "Time when the metadata of the model version was last updated, as a Unix timestamp in\nmilliseconds.", "launch_stage": "GA" }, "name": { - "description": "Unique name of the model", + "description": "Name of the registered model that the version belongs to.", "launch_stage": "GA" }, "run_id": { - "description": "MLflow run ID used when creating `model_version`, if `source` was generated by an\nexperiment run stored in MLflow tracking server.", + "description": "ID of the MLflow run that produced the model artifacts, if `source` comes from a run in the\nMLflow tracking server.", "launch_stage": "GA" }, "run_link": { - "description": "Run Link: Direct link to the run that generated this version", + "description": "URL of the MLflow run that generated the model version, as given in the create request. It is\ntypically set when the run is hosted on a different tracking server than the registry.", "launch_stage": "GA" }, "source": { - "description": "URI indicating the location of the source model artifacts, used when creating `model_version`", + "description": "URI of the model artifacts that the model version was registered from, as given in the\ncreate request.", "launch_stage": "GA" }, "status": { - "description": "Current status of `model_version`", + "description": "Registration status of the model version. The version can be used once the status is `READY`.", "ref": "ml.ModelVersionStatus", "launch_stage": "GA" }, "status_message": { - "description": "Details on current `status`, if it is pending or failed.", + "description": "Details on the current `status`, such as the reason why registration failed.", "launch_stage": "GA" }, "tags": { - "description": "Tags: Additional metadata key-value pairs for this `model_version`.", + "description": "Key-value tags attached to the model version.", "launch_stage": "GA" }, "user_id": { @@ -48332,7 +48935,7 @@ "launch_stage": "GA" }, "version": { - "description": "Model's version number.", + "description": "Version number of the model version, as a string. Version numbers start at 1 for each\nregistered model.", "launch_stage": "GA" } } @@ -48344,6 +48947,7 @@ "launch_stage": "GA" }, "current_stage": { + "description": "Current stage of the model version. Valid values are `None`, `Staging`, `Production` and\n`Archived`.", "launch_stage": "GA" }, "description": { @@ -48369,10 +48973,11 @@ "launch_stage": "GA" }, "open_requests": { - "description": "Open requests for this `model_versions`.\nGap in sequence number is intentional and is done in order to\nmatch field sequence numbers of `ModelVersion` proto message", + "description": "Open stage transition requests for the model version.", "launch_stage": "GA" }, "permission_level": { + "description": "Permission level of the requesting user on the registered model that the version belongs to.", "ref": "ml.PermissionLevel", "launch_stage": "GA" }, @@ -48389,6 +48994,7 @@ "launch_stage": "GA" }, "status": { + "description": "Registration status of the model version. The version can be used once the status is `READY`.", "ref": "ml.Status", "launch_stage": "GA" }, @@ -49647,19 +50253,19 @@ "ml.SearchExperiments": { "fields": { "filter": { - "description": "String representing a SQL filter condition (e.g. \"name ILIKE 'my-experiment%'\")", + "description": "Filter condition on the experiment name and tags. The `name` attribute and `tags.\u003ckey\u003e`\nsupport the operators `=`, `!=`, `LIKE` and `ILIKE` (case-insensitive `LIKE`), string values\nare wrapped in single quotes, and several conditions can be combined with `AND`. No wildcard\nis added automatically, so include `%` in a `LIKE` pattern where you need one.", "launch_stage": "GA" }, "max_results": { - "description": "Maximum number of experiments desired. Max threshold is 3000.", + "description": "Maximum number of experiments to return per page. Larger values are capped by the server, so\nuse `page_token` to retrieve further pages.", "launch_stage": "GA" }, "order_by": { - "description": "List of columns for ordering search results, which can include experiment name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by experiment id DESC.", + "description": "Columns to order the results by, each given as `name`, `basename` (the last segment of the\nname), `experiment_id`, `creation_time` or `last_update_time` with an optional `ASC` or `DESC`\nsuffix, where `ASC` is the default. If omitted, results are ordered by last update time with\nthe most recently updated experiment first. Tiebreaks are done by experiment id DESC.", "launch_stage": "GA" }, "page_token": { - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "launch_stage": "GA" }, "view_type": { @@ -49821,7 +50427,7 @@ "ml.SearchModelVersionsRequest": { "fields": { "filter": { - "description": "String filter condition, like \"name='my-model-name'\". Must be a single boolean condition,\nwith string values wrapped in single quotes.", + "description": "Filter condition on `name`, `run_id`, `source` or `tags.\u003ckey\u003e`. The filter must constrain at\nleast one of `name`, `run_id` or `source`. Conditions use `=`, `!=`, `LIKE` or `ILIKE`, and\n`run_id` also supports `IN`. String values are wrapped in single quotes, and several\nconditions can be combined with `AND`.", "launch_stage": "GA" }, "max_results": { @@ -49829,7 +50435,7 @@ "launch_stage": "GA" }, "order_by": { - "description": "List of columns to be ordered by including model name, version, stage with an\noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", + "description": "Columns to order the results by, each given as `name`, `version`, `current_stage` or\n`last_updated_timestamp` with an optional `ASC` or `DESC` suffix, where `ASC` is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", "launch_stage": "GA" }, "page_token": { @@ -49841,7 +50447,7 @@ "ml.SearchModelVersionsResponse": { "fields": { "model_versions": { - "description": "Models that match the search criteria", + "description": "Model versions that match the search filter.", "launch_stage": "GA" }, "next_page_token": { @@ -49943,11 +50549,11 @@ "launch_stage": "GA" }, "key": { - "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "description": "Key of the tag. Keys are at most 255 characters long. Setting a key that already exists\nreplaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and\n`mlflow.experimentType` cannot be set.", "launch_stage": "GA" }, "value": { - "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "description": "Value of the tag. Values are at most 65535 characters long.", "launch_stage": "GA" } } @@ -50668,7 +51274,7 @@ "launch_stage": "GA" }, "new_name": { - "description": "If provided, the experiment's name is changed to the new name. The new name must be unique.", + "description": "New name for the experiment, as an absolute path in the workspace. The new name must be\nunique.", "launch_stage": "GA" } } @@ -50784,7 +51390,7 @@ "ml.UpdateModelVersionRequest": { "fields": { "description": { - "description": "If provided, updates the description for this `registered_model`.", + "description": "New description for the model version.", "launch_stage": "GA" }, "name": { @@ -50800,7 +51406,7 @@ "ml.UpdateModelVersionResponse": { "fields": { "model_version": { - "description": "Return new version number generated for this model in registry.", + "description": "The updated model version.", "ref": "ml.ModelVersion", "launch_stage": "GA" } @@ -52646,7 +53252,7 @@ }, "tiktok_ads_options": { "ref": "pipelines.TikTokAdsOptions", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "zendesk_support_options": { "ref": "pipelines.ZendeskSupportOptions", @@ -53610,6 +54216,7 @@ "JIRA", "CONFLUENCE", "META_MARKETING", + "GOOGLE_ADS", "TIKTOK_ADS", "ZENDESK", "SMARTSHEET", @@ -53623,6 +54230,7 @@ "DYNAMICS365": "PUBLIC_PREVIEW", "FOREIGN_CATALOG": "PRIVATE_PREVIEW", "GA4_RAW_DATA": "PUBLIC_PREVIEW", + "GOOGLE_ADS": "PRIVATE_PREVIEW", "GOOGLE_DRIVE": "PRIVATE_PREVIEW", "JIRA": "PUBLIC_BETA", "MANAGED_POSTGRESQL": "PUBLIC_PREVIEW", @@ -53639,7 +54247,7 @@ "SMARTSHEET": "PUBLIC_PREVIEW", "SQLSERVER": "PUBLIC_PREVIEW", "TERADATA": "PUBLIC_PREVIEW", - "TIKTOK_ADS": "PUBLIC_BETA", + "TIKTOK_ADS": "PUBLIC_PREVIEW", "WORKDAY_RAAS": "PUBLIC_PREVIEW", "ZENDESK": "PUBLIC_PREVIEW" } @@ -55447,36 +56055,36 @@ "description": "Deprecated. Use custom_report_options.data_level instead.", "ref": "pipelines.TikTokAdsOptionsTikTokDataLevel", "deprecated": true, - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "dimensions": { "description": "Deprecated. Use custom_report_options.dimensions instead.", "deprecated": true, - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "lookback_window_days": { "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "metrics": { "description": "Deprecated. Use custom_report_options.metrics instead.", "deprecated": true, - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "query_lifetime": { "description": "Deprecated. Use custom_report_options.query_lifetime instead.", "deprecated": true, - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "report_type": { "description": "Deprecated. Use custom_report_options.report_type instead.", "ref": "pipelines.TikTokAdsOptionsTikTokReportType", "deprecated": true, - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "sync_start_date": { "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" } } }, @@ -55516,10 +56124,10 @@ "AUCTION_AD" ], "enum_launch_stages": { - "AUCTION_AD": "PUBLIC_BETA", - "AUCTION_ADGROUP": "PUBLIC_BETA", - "AUCTION_ADVERTISER": "PUBLIC_BETA", - "AUCTION_CAMPAIGN": "PUBLIC_BETA" + "AUCTION_AD": "PUBLIC_PREVIEW", + "AUCTION_ADGROUP": "PUBLIC_PREVIEW", + "AUCTION_ADVERTISER": "PUBLIC_PREVIEW", + "AUCTION_CAMPAIGN": "PUBLIC_PREVIEW" } }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -55533,12 +56141,12 @@ "GMV_MAX" ], "enum_launch_stages": { - "AUDIENCE": "PUBLIC_BETA", - "BASIC": "PUBLIC_BETA", - "BUSINESS_CENTER": "PUBLIC_BETA", - "DSA": "PUBLIC_BETA", - "GMV_MAX": "PUBLIC_BETA", - "PLAYABLE_AD": "PUBLIC_BETA" + "AUDIENCE": "PUBLIC_PREVIEW", + "BASIC": "PUBLIC_PREVIEW", + "BUSINESS_CENTER": "PUBLIC_PREVIEW", + "DSA": "PUBLIC_PREVIEW", + "GMV_MAX": "PUBLIC_PREVIEW", + "PLAYABLE_AD": "PUBLIC_PREVIEW" } }, "pipelines.Transformer": { @@ -56526,14 +57134,14 @@ "launch_stage": "GA" }, "database_id": { - "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\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 database_id is not specified in the request, it is generated automatically.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "replace_existing": { - "description": "If true, update the database if it already exists instead of returning an\nerror.", + "description": "If true, update the database if it already exists instead of returning an\nerror. This requires `database_id` to be set. Without `database_id`, the request\nfollows the normal create path and fails if the database name already exists.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -56616,12 +57224,12 @@ "postgres.CreateSnapshotRequest": { "fields": { "snapshot": { - "description": "The snapshot to create.", + "description": "The snapshot to create. Only `spec` is read from this message; the system\nsets the other fields.", "ref": "postgres.Snapshot", "launch_stage": "GA" }, "snapshot_id": { - "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation.", + "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation. The ID must be\n3 to 63 characters long, start with a lowercase letter, end with a\nlowercase letter or digit, and contain only lowercase letters, digits, and\nhyphens.", "launch_stage": "GA" } } @@ -56629,6 +57237,7 @@ "postgres.CreateSyncedTableRequest": { "fields": { "synced_table": { + "description": "The synced table to create. Its configuration is read from spec, and its name comes from\nsynced_table_id.", "ref": "postgres.SyncedTable", "launch_stage": "GA" }, @@ -56925,7 +57534,7 @@ ] }, "role": { - "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", + "description": "The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nThe role must be in the same branch as the database.\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", "launch_stage": "GA" } } @@ -58163,12 +58772,10 @@ "postgres.MigrationType": { "description": "The intended data transfer mode of a migration.", "enum": [ - "MIGRATION_TYPE_ONE_TIME_COPY", - "MIGRATION_TYPE_ONLINE" + "MIGRATION_TYPE_ONE_TIME_COPY" ], "enum_launch_stages": { - "MIGRATION_TYPE_ONE_TIME_COPY": "PRIVATE_PREVIEW", - "MIGRATION_TYPE_ONLINE": "PRIVATE_PREVIEW" + "MIGRATION_TYPE_ONE_TIME_COPY": "PRIVATE_PREVIEW" } }, "postgres.MonthlySchedule": { @@ -58865,7 +59472,7 @@ } }, "postgres.Snapshot": { - "description": "An immutable, point-in-time copy of a branch's data within a project. It\nremains available after the source branch is deleted.", + "description": "An immutable, point-in-time copy of a branch's data within a project. It\nremains available after the source branch is deleted. To restore a snapshot,\ncreate a new branch with `spec.source_snapshot` set to the snapshot's\nresource name. For an overview, see\nhttps://docs.databricks.com/aws/en/oltp/projects/snapshots.", "fields": { "create_time": { "description": "When the snapshot was created.", @@ -58886,7 +59493,7 @@ ] }, "spec": { - "description": "Client-provided configuration of the snapshot.", + "description": "Client-provided configuration of the snapshot. When you create a snapshot,\nset exactly one of `expire_time`, `ttl`, or `no_expiry`.", "ref": "postgres.SnapshotSpec", "launch_stage": "GA", "behaviors": [ @@ -58937,7 +59544,7 @@ "description": "Client-provided configuration of the snapshot.", "fields": { "expire_time": { - "description": "Absolute time at which the snapshot is deleted.\nMutually exclusive with `ttl` and `no_expiry`.", + "description": "Absolute time at which the snapshot is deleted. It must not be in the\npast. Mutually exclusive with `ttl` and `no_expiry`.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -58945,7 +59552,7 @@ ] }, "no_expiry": { - "description": "If true, the snapshot never expires.\nMutually exclusive with `ttl` and `expire_time`.", + "description": "If true, the snapshot never expires. The value `false` is rejected; set\n`expire_time` or `ttl` instead.\nMutually exclusive with `ttl` and `expire_time`.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -58953,14 +59560,14 @@ ] }, "source_branch": { - "description": "The source branch to snapshot.\nFormat: projects/{project_id}/branches/{branch_id}", + "description": "The source branch to snapshot. The branch must belong to the same project\nas the snapshot.\nFormat: projects/{project_id}/branches/{branch_id}", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "source_branch_lsn": { - "description": "LSN to snapshot from, e.g. `16/B374D848`.\nMutually exclusive with `source_branch_time`.", + "description": "Postgres log sequence number (LSN) to snapshot from. It must fall within\nthe project's history retention window. If neither this field nor\n`source_branch_time` is set, the snapshot captures the current head of\nthe source branch. Mutually exclusive with `source_branch_time`.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -58968,7 +59575,7 @@ ] }, "source_branch_time": { - "description": "Timestamp to snapshot from.\nMutually exclusive with `source_branch_lsn`.", + "description": "Timestamp to snapshot from. It must fall within the project's history\nretention window. Mutually exclusive with `source_branch_lsn`.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -58976,7 +59583,7 @@ ] }, "ttl": { - "description": "Time-to-live. The snapshot expires this long after it is created.\nMutually exclusive with `expire_time` and `no_expiry`. Reads report the\nresolved absolute `expire_time` instead.", + "description": "Time-to-live, as a positive duration in seconds with an `s` suffix. The\nsnapshot expires this long after it is created.\nMutually exclusive with `expire_time` and `no_expiry`. Reads report the\nresolved absolute `expire_time` instead.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -59043,15 +59650,17 @@ } }, "postgres.SyncedTable": { + "description": "A synced table is a read-only Postgres table that Databricks keeps up to date from a Unity Catalog\nsource table through a managed pipeline. It is also registered in Unity Catalog under its\nthree-part name. See https://docs.databricks.com/aws/en/oltp/projects/sync-tables.", "fields": { "create_time": { + "description": "The time when the synced table was created.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "Output only. The Full resource name of the synced table in Postgres\nwhere (catalog, schema, table) are the UC entity names.\n\nFormat \"synced_tables/{catalog}.{schema}.{table}\"\n\nFor the corresponding source table in the Unity catalog look for the \"source_table_full_name\" attribute.", + "description": "The full resource name of the synced table, where (catalog, schema, table) are the Unity Catalog\nnames of the synced table.\n\nFormat: \"synced_tables/{catalog}.{schema}.{table}\".\n\nFor the corresponding source table in Unity Catalog, look for the \"source_table_full_name\" attribute.", "launch_stage": "GA" }, "spec": { @@ -59072,7 +59681,7 @@ ] }, "synced_table_id": { - "description": "The part of the name, chosen by the user when the resource was created.", + "description": "The three-part Unity Catalog name of the synced table, in the format \"{catalog}.{schema}.{table}\".\nIt is the synced_table_id that was used to create the synced table and the last component of name.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -59133,6 +59742,7 @@ "postgres.SyncedTablePosition": { "fields": { "delta_table_sync_info": { + "description": "The source Delta table version that the last successful sync read.", "ref": "postgres.DeltaTableSyncInfo", "launch_stage": "GA", "behaviors": [ @@ -59194,7 +59804,7 @@ ] }, "branch": { - "description": "The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", + "description": "The full resource name of the branch that contains the synced table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".\n\nA value must be specified when creating a synced table inside a standard catalog. Inside a\nLakebase catalog it can be omitted, and if specified it must match the branch of that catalog.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -59208,7 +59818,7 @@ ] }, "existing_pipeline_id": { - "description": "ID of an existing pipeline to bin-pack this synced table into.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "description": "ID of an existing pipeline to bin-pack this synced table into. The pipeline must be a synced\ntable pipeline that runs continuously if and only if scheduling_policy is CONTINUOUS.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned in status.pipeline_id.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -59222,7 +59832,7 @@ ] }, "new_pipeline_spec": { - "description": "Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "description": "Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned in status.pipeline_id.", "ref": "postgres.NewPipelineSpec", "launch_stage": "GA", "behaviors": [ @@ -59230,21 +59840,21 @@ ] }, "postgres_database": { - "description": "The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog.", + "description": "The name of the Postgres database where the synced table is created. A value must be specified\non creation. If the synced table is created inside a Lakebase catalog, the value must match the\nPostgres database of that catalog.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "primary_key_columns": { - "description": "Primary Key columns to be used for data insert/update in the destination.", + "description": "Primary Key columns to be used for data insert/update in the destination. At least one column\nmust be specified.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "scheduling_policy": { - "description": "Scheduling policy of the underlying pipeline.", + "description": "Scheduling policy of the underlying pipeline. A value must be specified on creation. See\nhttps://docs.databricks.com/aws/en/oltp/projects/sync-tables for how to choose a sync mode.", "ref": "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", "launch_stage": "GA", "behaviors": [ @@ -59397,6 +60007,7 @@ ] }, "ongoing_sync_progress": { + "description": "Progress of the sync that is currently running, either the initial data load or an update of a\ntriggered or snapshot synced table.", "ref": "postgres.SyncedTablePipelineProgress", "launch_stage": "GA", "behaviors": [ @@ -59489,7 +60100,7 @@ "launch_stage": "GA" }, "update_mask": { - "description": "The list of fields to update.", + "description": "The list of fields to update. The updatable fields are `spec.role` and\n`spec.postgres_database`.", "launch_stage": "GA" } } @@ -64517,7 +65128,7 @@ "description": "An ingress rule is enforced when a request satisfies all\nspecified attributes — including request origin, destination, and authentication.", "fields": { "authentication": { - "description": "The authenticated identity the request must match. When unset, the rule matches\nall users and service principals.\nOn the account-level network policy, scoping to specific identities is not\ncurrently supported, so this field must be unset (the rule matches all users\nand service principals).", + "description": "The authenticated identity the request must match. When unset, the rule matches\nall users and service principals.", "ref": "settings.CustomerFacingIngressNetworkPolicyAuthentication", "launch_stage": "PUBLIC_BETA" }, @@ -69314,6 +69925,10 @@ "description": "Maximum number of notebooks to return.", "launch_stage": "GA" }, + "skill_max_results": { + "description": "Maximum number of skills to return.", + "launch_stage": "PUBLIC_BETA" + }, "table_max_results": { "description": "Maximum number of tables to return.", "launch_stage": "GA" @@ -69340,6 +69955,10 @@ "ref": "sharing.Share", "launch_stage": "GA" }, + "skills": { + "description": "The list of skills in the share.", + "launch_stage": "PUBLIC_BETA" + }, "tables": { "description": "The list of tables in the share.", "launch_stage": "GA" @@ -70169,7 +70788,8 @@ "NOTEBOOK_FILE", "FUNCTION", "FEATURE_SPEC", - "VOLUME" + "VOLUME", + "SKILL" ], "enum_launch_stages": { "FEATURE_SPEC": "GA", @@ -70179,6 +70799,7 @@ "MODEL": "GA", "NOTEBOOK_FILE": "GA", "SCHEMA": "GA", + "SKILL": "PUBLIC_BETA", "STREAMING_TABLE": "GA", "TABLE": "GA", "VIEW": "GA", @@ -70256,6 +70877,43 @@ } } }, + "sharing.Skill": { + "description": "An agent skill shared through a Delta Sharing share, as served to a recipient.", + "fields": { + "bundle_name": { + "description": "The name from the skill bundle frontmatter, which may differ from the resource name.", + "launch_stage": "PUBLIC_BETA" + }, + "comment": { + "description": "The comment of the skill.", + "launch_stage": "PUBLIC_BETA" + }, + "description": { + "description": "The bundle description parsed from the skill bundle's SKILL.md frontmatter.", + "launch_stage": "PUBLIC_BETA" + }, + "id": { + "description": "The shared-object ID that recipients match replicas on. For a skill shared through its\nschema, which has no shared-object row, this is derived from the shared schema and the skill.", + "launch_stage": "PUBLIC_BETA" + }, + "name": { + "description": "The name of the skill.", + "launch_stage": "PUBLIC_BETA" + }, + "schema": { + "description": "The name of the schema that the skill belongs to.", + "launch_stage": "PUBLIC_BETA" + }, + "share": { + "description": "The name of the share that the skill belongs to.", + "launch_stage": "PUBLIC_BETA" + }, + "share_id": { + "description": "The id of the share that the skill belongs to.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "sharing.Table": { "fields": { "comment": { @@ -70534,7 +71192,7 @@ "description": "Request to resolve a software artifact version from its tag alias.", "fields": { "alias": { - "description": "Image tag alias selecting the version.", + "description": "Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128\ncharacters, made of letters, digits, underscores, periods, and hyphens, and must not start with\na period or hyphen.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -70553,10 +71211,10 @@ } }, "softwareartifacts.SoftwareArtifact": { - "description": "A software artifact in a Unity Catalog schema.", + "description": "A software artifact is a named container image stored in a Unity Catalog schema and governed by\nUnity Catalog privileges. Images are pushed through Databricks Artifact Registry; each pushed\nimage digest becomes an immutable version of the artifact, exposed as a SoftwareArtifactVersion.\nSee https://docs.databricks.com/aws/en/artifact-registry/ for concepts, naming rules, and the\nprivileges each operation requires.", "fields": { "create_time": { - "description": "Time at which this software artifact was created.", + "description": "Time at which the artifact was created, formatted as an RFC 3339 timestamp in JSON.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -70574,14 +71232,14 @@ "launch_stage": "PUBLIC_PREVIEW" }, "owner": { - "description": "Principal name (a user, service principal, or group) that owns this artifact.", + "description": "Principal that owns the artifact, given as a user's email address, a service principal's\napplication ID, or a group name.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OPTIONAL" ] }, "update_time": { - "description": "Time at which this software artifact was last updated.", + "description": "Time at which the artifact was last updated, formatted as an RFC 3339 timestamp in JSON.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -70600,7 +71258,7 @@ "description": "An immutable version of a software artifact, identified by its content digest.", "fields": { "create_time": { - "description": "Time at which this software artifact version was created.", + "description": "Time at which this software artifact version was created, formatted as an RFC 3339 timestamp in\nJSON.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -70614,7 +71272,7 @@ ] }, "digest": { - "description": "Content digest of the version, for example `sha256:...`.", + "description": "Content digest of the version's image manifest, of the form `{algorithm}:{hex}`.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -70629,7 +71287,7 @@ ] }, "name": { - "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "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.", "launch_stage": "PUBLIC_PREVIEW" }, "tags": { @@ -70640,7 +71298,7 @@ ] }, "update_time": { - "description": "Time at which this software artifact version was last updated.", + "description": "Time at which this software artifact version was last updated, formatted as an RFC 3339\ntimestamp in JSON.", "launch_stage": "PUBLIC_PREVIEW", "behaviors": [ "OUTPUT_ONLY" @@ -71731,7 +72389,7 @@ "description": "Creates a new SQL warehouse.", "fields": { "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "launch_stage": "GA" }, "channel": { @@ -71794,7 +72452,7 @@ }, "statement_timeout": { "description": "Warehouse statement timeout in seconds.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "tags": { "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", @@ -72221,7 +72879,7 @@ "description": "This is an incremental edit functionality, so all fields except id are optional. If a field is set, the corresponding\nconfiguration in the SQL warehouse is modified. If a field is unset, the existing configuration value in the SQL\nwarehouse is retained. Thus, this API is not idempotent.", "fields": { "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "launch_stage": "GA" }, "channel": { @@ -72284,7 +72942,7 @@ }, "statement_timeout": { "description": "Warehouse statement timeout in seconds.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "tags": { "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", @@ -72359,7 +73017,7 @@ "sql.EndpointInfo": { "fields": { "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "launch_stage": "GA" }, "channel": { @@ -72460,7 +73118,7 @@ }, "statement_timeout": { "description": "Warehouse statement timeout in seconds.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "tags": { "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", @@ -72643,6 +73301,7 @@ "launch_stage": "GA" }, "job_info": { + "description": "Identifiers of the job, job run, and task run that executed this statement, when it ran as part of a job.", "ref": "sql.ExternalQuerySourceJobInfo", "launch_stage": "GA" }, @@ -72729,7 +73388,7 @@ "sql.GetWarehouseResponse": { "fields": { "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "launch_stage": "GA" }, "channel": { @@ -72830,7 +73489,7 @@ }, "statement_timeout": { "description": "Warehouse statement timeout in seconds.", - "launch_stage": "PUBLIC_BETA" + "launch_stage": "PUBLIC_PREVIEW" }, "tags": { "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", @@ -73355,7 +74014,7 @@ "sql.ListQueryHistoryRequest": { "fields": { "filter_by": { - "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", + "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, warehouse IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", "ref": "sql.QueryFilter", "launch_stage": "GA" }, @@ -73364,11 +74023,11 @@ "launch_stage": "GA" }, "max_results": { - "description": "Limit the number of results returned in one page. Must be less than 1000 and the default is 100.", + "description": "Limit the number of results returned in one page. Must be no more than 1000; the default is 100.", "launch_stage": "GA" }, "page_token": { - "description": "A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", + "description": "A token that can be used to get the next page of results. The token can contain characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", "launch_stage": "GA" } } @@ -73850,7 +74509,7 @@ "sql.QueryInfo": { "fields": { "cache_query_id": { - "description": "The ID of the cached query if this result retrieved from cache", + "description": "The ID of the query whose cached result was returned, if this result was retrieved from the cache.", "launch_stage": "GA" }, "channel_used": { @@ -73863,7 +74522,7 @@ "launch_stage": "GA" }, "duration": { - "description": "Total time of the statement execution. This value does not include the time taken to retrieve the results, which\ncan result in a discrepancy between this value and the start-to-finish wall-clock time.", + "description": "Total time of the statement execution, in milliseconds. This value does not include the time taken to retrieve the results, which\ncan result in a discrepancy between this value and the start-to-finish wall-clock time.", "launch_stage": "GA" }, "endpoint_id": { @@ -73884,11 +74543,11 @@ "launch_stage": "GA" }, "execution_end_time_ms": { - "description": "The time execution of the query ended.", + "description": "The time execution of the query ended, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "is_final": { - "description": "Whether more updates for the query are expected.", + "description": "Whether the query has reached a final state, so no further updates to this record are expected.", "launch_stage": "GA" }, "lookup_key": { @@ -73896,7 +74555,7 @@ "launch_stage": "GA" }, "metrics": { - "description": "Metrics about query execution.", + "description": "Metrics about query execution. Only returned when `include_metrics` is true in the request.", "ref": "sql.QueryMetrics", "launch_stage": "GA" }, @@ -73906,11 +74565,11 @@ "launch_stage": "GA" }, "query_end_time_ms": { - "description": "The time the query ended.", + "description": "The time the query ended, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "query_id": { - "description": "The query ID.", + "description": "The UUID that uniquely identifies the query execution. It matches the statement ID shown in the Query History UI\nand the values accepted by the `statement_ids` filter.", "launch_stage": "GA" }, "query_source": { @@ -73919,11 +74578,11 @@ "launch_stage": "GA" }, "query_start_time_ms": { - "description": "The time the query started.", + "description": "The time the query started, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "query_tags": { - "description": "A query execution can be optionally annotated with query tags", + "description": "Key-value tags attached to the query execution, for example with the `SET QUERY_TAGS` statement, for grouping\nand filtering. See https://docs.databricks.com/aws/en/sql/user/queries/query-tags.", "launch_stage": "PUBLIC_PREVIEW" }, "query_text": { @@ -73948,7 +74607,7 @@ "launch_stage": "GA" }, "status": { - "description": "Query status with one the following values:\n\n- `QUEUED`: Query has been received and queued.\n- `RUNNING`: Query has started.\n- `CANCELED`: Query has been cancelled by the user.\n- `FAILED`: Query has failed.\n- `FINISHED`: Query has completed.", + "description": "Query status with one of the following values:\n\n- `QUEUED`: Query has been received and queued.\n- `RUNNING`: Query has started.\n- `CANCELED`: Query has been cancelled by the user.\n- `FAILED`: Query has failed.\n- `FINISHED`: Query has completed.", "ref": "sql.QueryStatus", "launch_stage": "GA" }, @@ -73961,7 +74620,7 @@ "launch_stage": "GA" }, "warehouse_id": { - "description": "Warehouse ID.", + "description": "ID of the warehouse that ran the query.", "launch_stage": "GA" } } @@ -74002,7 +74661,7 @@ "launch_stage": "GA" }, "overloading_queue_start_timestamp": { - "description": "Timestamp of when the query was enqueued waiting while the warehouse was at max load.\nThis field is optional and will not appear if the query skipped the overloading queue.", + "description": "Timestamp of when the query was enqueued waiting while the warehouse was at max load, in milliseconds since the Unix epoch.\nThis field is optional and will not appear if the query skipped the overloading queue.", "launch_stage": "GA" }, "photon_total_time_ms": { @@ -74018,7 +74677,7 @@ "launch_stage": "GA" }, "provisioning_queue_start_timestamp": { - "description": "Timestamp of when the query was enqueued waiting for a cluster to be provisioned for the warehouse.\nThis field is optional and will not appear if the query skipped the provisioning queue.", + "description": "Timestamp of when the query was enqueued waiting for a cluster to be provisioned for the warehouse, in milliseconds since the Unix epoch.\nThis field is optional and will not appear if the query skipped the provisioning queue.", "launch_stage": "GA" }, "pruned_bytes": { @@ -74030,7 +74689,7 @@ "launch_stage": "GA" }, "query_compilation_start_timestamp": { - "description": "Timestamp of when the underlying compute started compilation of the query.", + "description": "Timestamp of when the underlying compute started compilation of the query, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "read_bytes": { @@ -74078,7 +74737,7 @@ "launch_stage": "GA" }, "runnable_tasks": { - "description": "number of remaining tasks to complete, calculated by autoscaler StatementAnalysis.scala\ndeprecated: use remaining_task_count instead", + "description": "Deprecated: use `remaining_task_count` instead.\nNumber of remaining tasks to complete.", "deprecated": true, "launch_stage": "GA" }, @@ -74100,12 +74759,12 @@ "launch_stage": "GA" }, "work_to_be_done": { - "description": "remaining work to be done across all stages in the query, calculated by autoscaler StatementAnalysis.scala, in milliseconds\ndeprecated: using projected_remaining_task_total_time_ms instead", + "description": "Deprecated: use `projected_remaining_task_total_time_ms` instead.\nRemaining work to be done across all stages in the query, in milliseconds.", "deprecated": true, "launch_stage": "GA" }, "write_remote_bytes": { - "description": "Size pf persistent data written to cloud object storage in your cloud tenant, in bytes.", + "description": "Size of persistent data written to cloud object storage in your cloud tenant, in bytes.", "launch_stage": "GA" } } @@ -74284,9 +74943,11 @@ "description": "* A query execution can be annotated with an optional key-value pair to\nallow users to attribute the executions by key and optional value to filter by.\nQueryTag is the user-facing representation.", "fields": { "key": { + "description": "The key of the tag.", "launch_stage": "GA" }, "value": { + "description": "The value of the tag. Key-only tags have no value.", "launch_stage": "GA" } } @@ -74698,6 +75359,7 @@ "sql.TaskTimeOverRange": { "fields": { "entries": { + "description": "Each entry covers one consecutive time bucket of length `interval`, starting at `query_start_time_ms`.", "launch_stage": "GA" }, "interval": { @@ -75139,11 +75801,11 @@ "sql.TimeRange": { "fields": { "end_time_ms": { - "description": "The end time in milliseconds.", + "description": "End of the range, in milliseconds since the Unix epoch.", "launch_stage": "GA" }, "start_time_ms": { - "description": "The start time in milliseconds.", + "description": "Start of the range, in milliseconds since the Unix epoch.", "launch_stage": "GA" } } @@ -75868,9 +76530,11 @@ "description": "* A query execution can be annotated with an optional key-value pair to\nallow users to attribute the executions by key and optional value to filter by.\nQueryTag is the user-facing representation.", "fields": { "key": { + "description": "The key of the tag.", "launch_stage": "PUBLIC_PREVIEW" }, "value": { + "description": "The value of the tag. Key-only tags have no value.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -76668,6 +77332,7 @@ } }, "tags.TagAssignment": { + "description": "A tag assignment attaches a tag, which is a key with an optional value, to a workspace object such\nas a dashboard, notebook, Genie space or app. An object can have at most one assignment for each tag\nkey. If the key belongs to a governed tag, the caller needs the ASSIGN permission on that governed\ntag, and the value must be one of its allowed values. See\nhttps://docs.databricks.com/aws/en/admin/governed-tags/.", "fields": { "entity_id": { "description": "The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name", @@ -76691,7 +77356,7 @@ ] }, "tag_value": { - "description": "The value of the tag", + "description": "The value of the tag. If the value is omitted, the tag is assigned with its key only.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -76751,7 +77416,7 @@ "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 fields to update. Only `tag_value` can be updated, because the entity\ntype, entity ID and tag key identify the tag assignment.", "launch_stage": "GA" } } @@ -76834,15 +77499,16 @@ "launch_stage": "PUBLIC_BETA" }, "index_type": { + "description": "Type of index to create, which determines which spec field is required.", "ref": "vectorsearch.VectorIndexType", "launch_stage": "GA" }, "name": { - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "launch_stage": "GA" }, "primary_key": { - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "launch_stage": "GA" } } @@ -76886,7 +77552,7 @@ "vectorsearch.DeleteDataVectorIndexRequest": { "fields": { "primary_keys": { - "description": "List of primary keys for the data to be deleted.", + "description": "Primary keys of the rows to delete. At least one key is required.", "launch_stage": "GA" } } @@ -76920,11 +77586,11 @@ "launch_stage": "GA" }, "embedding_source_columns": { - "description": "The columns that contain the embedding source.", + "description": "The source table column whose text Databricks embeds, together with the embedding model\nendpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of\n`embedding_source_columns` or `embedding_vector_columns` must be specified unless the index\nsubtype is `FULL_TEXT`, and only one column is supported.", "launch_stage": "GA" }, "embedding_vector_columns": { - "description": "The columns that contain the embedding vectors.", + "description": "The source table column that contains precomputed embedding vectors. Set this instead of\n`embedding_source_columns` for an index with self-managed embeddings.", "launch_stage": "GA" }, "embedding_writeback_table": { @@ -76937,7 +77603,7 @@ "launch_stage": "GA" }, "source_table": { - "description": "The name of the source table.", + "description": "Three-level Unity Catalog name of the source table that the index is synced from.", "launch_stage": "GA" } } @@ -76953,11 +77619,11 @@ "launch_stage": "GA" }, "embedding_source_columns": { - "description": "The columns that contain the embedding source.", + "description": "The source table column whose text Databricks embeds, together with the embedding model\nendpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of\n`embedding_source_columns` or `embedding_vector_columns` must be specified unless the index\nsubtype is `FULL_TEXT`, and only one column is supported.", "launch_stage": "GA" }, "embedding_vector_columns": { - "description": "The columns that contain the embedding vectors.", + "description": "The source table column that contains precomputed embedding vectors. Set this instead of\n`embedding_source_columns` for an index with self-managed embeddings.", "launch_stage": "GA" }, "embedding_writeback_table": { @@ -76974,7 +77640,7 @@ "launch_stage": "GA" }, "source_table": { - "description": "The name of the source table.", + "description": "Three-level Unity Catalog name of the source table that the index is synced from.", "launch_stage": "GA" } } @@ -76982,15 +77648,15 @@ "vectorsearch.DirectAccessVectorIndexSpec": { "fields": { "embedding_source_columns": { - "description": "The columns that contain the embedding source. The format should be array[double].", + "description": "Embedding source configuration used to embed `query_text` when the index is queried with text,\nnaming the embedding model endpoint to use. The index stores the vectors you supply through\nupsert; this setting never computes embeddings for them.", "launch_stage": "GA" }, "embedding_vector_columns": { - "description": "The columns that contain the embedding vectors. The format should be array[double].", + "description": "The column that holds the embedding vectors you write to the index. Exactly one column must be\nspecified, and `schema_json` must declare it as `array\u003cfloat\u003e` or `array\u003cdouble\u003e`.", "launch_stage": "GA" }, "schema_json": { - "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", + "description": "JSON object that maps each column name of the index to its type, serialized to a string. The\nprimary key and the embedding vector column must be present.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`.", "launch_stage": "GA" } } @@ -77006,7 +77672,7 @@ "launch_stage": "GA" }, "name": { - "description": "Name of the column", + "description": "Name of the column that contains the text to embed.", "launch_stage": "GA" } } @@ -77018,7 +77684,7 @@ "launch_stage": "GA" }, "name": { - "description": "Name of the column", + "description": "Name of the column that contains the embedding vectors.", "launch_stage": "GA" } } @@ -77207,6 +77873,27 @@ } } }, + "vectorsearch.FailedStatus": { + "description": "Failure details for an index or its latest ingestion update.", + "fields": { + "error_code": { + "description": "Error code associated with the error message, when available.", + "launch_stage": "GA" + }, + "error_message": { + "description": "Error message, when available.", + "launch_stage": "GA" + }, + "last_processed_commit_timestamp": { + "description": "[Standard endpoint] timestamp when the last processed commit was committed to the source table.\n[Storage Optimized endpoint] timestamp when the last processed commit was processed by the pipeline.", + "launch_stage": "GA" + }, + "last_processed_commit_version": { + "description": "Last source Delta table version fully processed while the index is still queryable.", + "launch_stage": "GA" + } + } + }, "vectorsearch.GetEndpointRequest": {}, "vectorsearch.GetIndexRequest": { "fields": { @@ -77226,6 +77913,43 @@ } }, "vectorsearch.GetVectorSearchEndpointPermissionsRequest": {}, + "vectorsearch.IndexStatus": { + "description": "Lifecycle and ingestion state of an index.", + "enum": [ + "PROVISIONING", + "PROVISIONING_ENDPOINT", + "PROVISIONING_INDEX", + "PROVISIONING_PIPELINE_RESOURCES", + "PROVISIONING_INITIAL_SNAPSHOT", + "ONLINE", + "ONLINE_CONTINUOUS_UPDATE", + "ONLINE_TRIGGERED_UPDATE", + "ONLINE_NO_PENDING_UPDATE", + "ONLINE_DIRECT_ACCESS", + "OFFLINE", + "OFFLINE_FAILED", + "ONLINE_PIPELINE_FAILED", + "ONLINE_UPDATING_PIPELINE_RESOURCES", + "DOWNLOADING" + ], + "enum_launch_stages": { + "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" + } + }, "vectorsearch.IndexSubtype": { "description": "The subtype of the AI Search index, determining the indexing and retrieval strategy.\n- `VECTOR`: Not supported. Use `HYBRID` instead.\n- `FULL_TEXT`: An index that uses full-text search without vector embeddings.\n- `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.", "enum": [ @@ -77267,11 +77991,11 @@ "vectorsearch.ListIndexesRequest": { "fields": { "endpoint_name": { - "description": "Name of the endpoint", + "description": "Name of the endpoint whose indexes to list.", "launch_stage": "GA" }, "page_token": { - "description": "Token for pagination", + "description": "Page token returned by a previous call, used to get the next page of results.", "launch_stage": "GA" } } @@ -77291,6 +78015,7 @@ "launch_stage": "GA" }, "vector_indexes": { + "description": "Indexes served by the endpoint. Each entry is a summary without the index specification and\nstatus; use Get an index to retrieve them.", "launch_stage": "GA" } } @@ -77313,15 +78038,15 @@ "description": "Metric specification", "fields": { "labels": { - "description": "Metric labels", + "description": "Labels that restrict the metric to matching series, for example to a single index.\nEndpoint-level metrics do not accept labels.", "launch_stage": "GA" }, "name": { - "description": "Metric name", + "description": "Metric name. Supported metrics include: `EndpointHealthStatus`, `EndpointConcurrency`,\n`IndexRequestCount`, `IndexRequestLatency`, `IndexRequestErrorSourceCount`,\n`IndexRequestGuidanceCount`, `IndexRequestGuidancePeakRate`, `IndexIngestedRows`, and\n`IndexEmbeddedRows`.\nAn unknown name is rejected with an error that lists the available metric names.", "launch_stage": "GA" }, "percentile": { - "description": "Percentile for the metric", + "description": "Percentile for latency metrics, such as `IndexRequestLatency`, which require it. One of 0.5,\n0.75, 0.9, 0.95, or 0.99.", "launch_stage": "GA" } } @@ -77330,11 +78055,11 @@ "description": "Label for a metric", "fields": { "name": { - "description": "Label name", + "description": "Label name, such as `error_source`, `failure_cause`, `operation`, `request_path`,\n`query_type`, `response_code`, or `index_name`. Supported labels depend on the metric.", "launch_stage": "GA" }, "value": { - "description": "Label value", + "description": "Label value, as an RE2 regular expression. The label also splits the result by its values,\nso `.+` returns one series per value. Some labels, such as `operation`, accept only `.+`,\n`.*`, or listed values joined by `|`.", "launch_stage": "GA" } } @@ -77343,11 +78068,11 @@ "description": "Single metric value at a specific timestamp", "fields": { "timestamp": { - "description": "Timestamp of the metric value (milliseconds since epoch)", + "description": "Timestamp of the metric value, in seconds since the Unix epoch.", "launch_stage": "GA" }, "value": { - "description": "Metric value", + "description": "Value of the metric at `timestamp`.", "launch_stage": "GA" } } @@ -77356,17 +78081,18 @@ "description": "Collection of metric values for a specific metric", "fields": { "metric": { - "description": "Metric specification", + "description": "The metric this time series was computed for, including the labels that identify the series.", "ref": "vectorsearch.Metric", "launch_stage": "GA" }, "values": { - "description": "Time series of metric values", + "description": "Each entry is one data point of the time series.", "launch_stage": "GA" } } }, "vectorsearch.MiniVectorIndex": { + "description": "An AI Search index stores vectors and metadata on an endpoint and serves vector similarity,\nfull-text and hybrid search queries over them. A Delta Sync index is kept in sync with a source\ntable, with embeddings either computed by Databricks from a text column or supplied by you in a\nvector column; a Direct Vector Access index holds rows that you write through the upsert and\ndelete data APIs. See https://docs.databricks.com/aws/en/ai-search/create-ai-search for how to\nchoose between them.", "fields": { "creator": { "description": "The user who created the index.", @@ -77377,24 +78103,25 @@ "launch_stage": "PRIVATE_PREVIEW" }, "endpoint_name": { - "description": "Name of the endpoint associated with the index", + "description": "Name of the endpoint that serves the index.", "launch_stage": "GA" }, "index_subtype": { - "description": "The subtype of the index.", + "description": "Subtype of the index. A `HYBRID` index supports vector similarity, full-text and hybrid\nqueries; a `FULL_TEXT` index has no embeddings and supports only full-text queries.", "ref": "vectorsearch.IndexSubtype", "launch_stage": "PUBLIC_BETA" }, "index_type": { + "description": "Type of the index, which determines whether `delta_sync_index_spec` or\n`direct_access_index_spec` describes it.", "ref": "vectorsearch.VectorIndexType", "launch_stage": "GA" }, "name": { - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "launch_stage": "GA" }, "primary_key": { - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row of the index.", "launch_stage": "GA" } } @@ -77446,7 +78173,7 @@ "description": "Request payload for getting next page of results.", "fields": { "endpoint_name": { - "description": "Name of the endpoint.", + "description": "Name of the endpoint that serves the index.", "launch_stage": "GA" }, "page_token": { @@ -77458,7 +78185,7 @@ "vectorsearch.QueryVectorIndexRequest": { "fields": { "columns": { - "description": "List of column names to include in the response.", + "description": "Names of the columns to return for each result. At least one column is required, and only\ncolumns that are part of the index can be returned.", "launch_stage": "GA" }, "columns_to_rerank": { @@ -77470,11 +78197,11 @@ "launch_stage": "PUBLIC_BETA" }, "filters_json": { - "description": "JSON string representing query filters.\n\nExample filters:\n\n- `{\"id \u003c\": 5}`: Filter for id less than 5.\n- `{\"id \u003e\": 5}`: Filter for id greater than 5.\n- `{\"id \u003c=\": 5}`: Filter for id less than equal to 5.\n- `{\"id \u003e=\": 5}`: Filter for id greater than equal to 5.\n- `{\"id\": 5}`: Filter for id equal to 5.", + "description": "Filters to apply to the results, as a JSON object serialized to a string. Each key is a column\nname, optionally followed by a space and an operator, and each value is the value or list of\nvalues to compare the column against. A key without an operator matches the value exactly, or\nany of the listed values. Supported operators are `NOT`, `\u003c`, `\u003c=`, `\u003e`, `\u003e=`, `OR` and `LIKE`;\nsee https://docs.databricks.com/aws/en/ai-search/query-ai-search for their semantics. This\nfield is not supported on storage-optimized endpoints.", "launch_stage": "GA" }, "num_results": { - "description": "Number of results to return. Defaults to 10.", + "description": "Maximum number of results to return. It must be greater than 0 and defaults to 10. By default,\na `HYBRID` query can return at most 200 results.", "launch_stage": "GA" }, "query_columns": { @@ -77482,7 +78209,7 @@ "launch_stage": "PUBLIC_BETA" }, "query_text": { - "description": "Query text. Required for Delta Sync Index using model endpoint.", + "description": "Text to search for. Use it for an index with Databricks-managed embeddings, which embeds the\ntext with the index's embedding model endpoint, and for `FULL_TEXT` queries on any index. A\n`HYBRID` query on an index with managed embeddings requires only `query_text`.", "launch_stage": "GA" }, "query_type": { @@ -77490,7 +78217,7 @@ "launch_stage": "GA" }, "query_vector": { - "description": "Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.", + "description": "Embedding vector to search for. Use it for an index whose embeddings you compute yourself: a\nDirect Vector Access index or a Delta Sync index with `embedding_vector_columns`. A `HYBRID`\nquery on a Delta Sync index with `embedding_vector_columns`, or on a Direct Vector Access index\nwithout `embedding_source_columns`, requires both `query_vector` and `query_text`. A Direct\nVector Access index with `embedding_source_columns` can be queried with `query_text` alone.", "launch_stage": "GA" }, "reranker": { @@ -77547,6 +78274,7 @@ "vectorsearch.RerankerConfigRerankerParameters": { "fields": { "columns_to_rerank": { + "description": "Names of the columns whose values are sent to the reranker. List the most relevant column\nfirst, since the order affects the ranking.", "launch_stage": "GA" } } @@ -77589,23 +78317,23 @@ "description": "Request to retrieve user-visible metrics", "fields": { "end_time": { - "description": "End time for metrics query", + "description": "End of the time range. Defaults to the current time. Must be later than `start_time`.", "launch_stage": "GA" }, "granularity_in_seconds": { - "description": "Granularity in seconds", + "description": "Requested interval between data points, in seconds. Defaults to 60, which is also the minimum.\nThe server may return a finer or coarser interval: 60 seconds only for time ranges of 1 hour or\nless, otherwise 300 seconds or more. Read the interval from the returned timestamps.", "launch_stage": "GA" }, "metrics": { - "description": "List of metrics to retrieve", + "description": "Metrics to retrieve. Each entry names a metric and optionally narrows it with labels or a\npercentile. An unknown metric name fails the whole request, and an empty list returns no series.", "launch_stage": "GA" }, "page_token": { - "description": "Token for pagination", + "description": "Not used. The response returns all data points in one page.", "launch_stage": "GA" }, "start_time": { - "description": "Start time for metrics query", + "description": "Start of the time range. Required. Must be within the last 169 hours.", "launch_stage": "GA" } } @@ -77614,11 +78342,11 @@ "description": "Response containing user-visible metrics", "fields": { "metric_values": { - "description": "Collection of metric values", + "description": "One time series for each requested metric and each combination of label values it was broken\ndown by.", "launch_stage": "GA" }, "next_page_token": { - "description": "A token that can be used to get the next page of results. If not present, there are no more results to show.", + "description": "Not set. The response returns all data points in one page.", "launch_stage": "GA" } } @@ -77719,7 +78447,7 @@ "vectorsearch.UpsertDataVectorIndexRequest": { "fields": { "inputs_json": { - "description": "JSON string representing the data to be upserted.", + "description": "Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column\nnames from `schema_json` to values and must include the primary key. A row whose primary key\nalready exists in the index is replaced.", "launch_stage": "GA" } } @@ -77760,16 +78488,19 @@ } }, "vectorsearch.VectorIndex": { + "description": "An AI Search index stores vectors and metadata on an endpoint and serves vector similarity,\nfull-text and hybrid search queries over them. A Delta Sync index is kept in sync with a source\ntable, with embeddings either computed by Databricks from a text column or supplied by you in a\nvector column; a Direct Vector Access index holds rows that you write through the upsert and\ndelete data APIs. See https://docs.databricks.com/aws/en/ai-search/create-ai-search for how to\nchoose between them.", "fields": { "creator": { "description": "The user who created the index.", "launch_stage": "GA" }, "delta_sync_index_spec": { + "description": "Specification of a Delta Sync index. Present only when `index_type` is `DELTA_SYNC`.", "ref": "vectorsearch.DeltaSyncVectorIndexSpecResponse", "launch_stage": "GA" }, "direct_access_index_spec": { + "description": "Specification of a Direct Vector Access index. Present only when `index_type` is\n`DIRECT_ACCESS`.", "ref": "vectorsearch.DirectAccessVectorIndexSpec", "launch_stage": "GA" }, @@ -77778,27 +78509,29 @@ "launch_stage": "PRIVATE_PREVIEW" }, "endpoint_name": { - "description": "Name of the endpoint associated with the index", + "description": "Name of the endpoint that serves the index.", "launch_stage": "GA" }, "index_subtype": { - "description": "The subtype of the index.", + "description": "Subtype of the index. A `HYBRID` index supports vector similarity, full-text and hybrid\nqueries; a `FULL_TEXT` index has no embeddings and supports only full-text queries.", "ref": "vectorsearch.IndexSubtype", "launch_stage": "PUBLIC_BETA" }, "index_type": { + "description": "Type of the index, which determines whether `delta_sync_index_spec` or\n`direct_access_index_spec` describes it.", "ref": "vectorsearch.VectorIndexType", "launch_stage": "GA" }, "name": { - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "launch_stage": "GA" }, "primary_key": { - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row of the index.", "launch_stage": "GA" }, "status": { + "description": "Current status of the index, including whether it is ready to serve queries and how many rows\nit holds.", "ref": "vectorsearch.VectorIndexStatus", "launch_stage": "GA" } @@ -77806,6 +78539,16 @@ }, "vectorsearch.VectorIndexStatus": { "fields": { + "detailed_state": { + "description": "Lifecycle and ingestion state. An online index can still have a failed update.", + "ref": "vectorsearch.IndexStatus", + "launch_stage": "GA" + }, + "failed_status": { + "description": "Failure details, when available, for OFFLINE_FAILED or ONLINE_PIPELINE_FAILED.", + "ref": "vectorsearch.FailedStatus", + "launch_stage": "GA" + }, "index_url": { "description": "Index API Url to be used to perform operations on the index", "launch_stage": "GA" @@ -77815,11 +78558,11 @@ "launch_stage": "GA" }, "message": { - "description": "Message associated with the index status", + "description": "Human-readable description of the current status.", "launch_stage": "GA" }, "ready": { - "description": "Whether the index is ready for search", + "description": "Whether the index can serve queries. This does not mean the latest update succeeded\nor that all source-table changes have been indexed; check detailed_state for update failures.", "launch_stage": "GA" } } @@ -77991,11 +78734,11 @@ "launch_stage": "GA" }, "is_default_for_provider": { - "description": "if the credential is the default for the given provider", + "description": "Set to true to make the new credential the default for its Git provider, replacing the\ncurrent default. The first credential created for a provider becomes the default\nregardless of this value.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup. It must not\nexceed 100 characters.", "launch_stage": "PUBLIC_PREVIEW" }, "personal_access_token": { @@ -78003,7 +78746,7 @@ "launch_stage": "GA" }, "principal_id": { - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal for which the credential will be created. Only service principal managers can perform this action.", "launch_stage": "GA" } } @@ -78027,11 +78770,11 @@ "launch_stage": "GA" }, "is_default_for_provider": { - "description": "if the credential is the default for the given provider", + "description": "Whether this credential is the default for its Git provider. The default credential is the\nfallback that is used when no specific credential is selected.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -78117,6 +78860,7 @@ } }, "workspace.CredentialInfo": { + "description": "A Git credential that Databricks uses to authenticate to a Git provider on behalf of a user\nor service principal. Each user has one default credential per Git provider, which is used\nwhen no specific credential is selected.", "fields": { "credential_id": { "description": "ID of the credential object in the workspace.", @@ -78135,11 +78879,11 @@ "launch_stage": "GA" }, "is_default_for_provider": { - "description": "if the credential is the default for the given provider", + "description": "Whether this credential is the default for its Git provider. The default credential is the\nfallback that is used when no specific credential is selected. See\nhttps://docs.databricks.com/aws/en/repos/repos-setup#how-default-credentials-work.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -78171,7 +78915,7 @@ "workspace.DeleteCredentialsRequest": { "fields": { "principal_id": { - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal whose credential will be deleted. Only service principal managers can perform this action.", "launch_stage": "GA" } } @@ -78272,7 +79016,7 @@ "workspace.GetCredentialsRequest": { "fields": { "principal_id": { - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal whose credential will be returned. Only service principal managers can perform this action.", "launch_stage": "GA" } } @@ -78296,11 +79040,11 @@ "launch_stage": "GA" }, "is_default_for_provider": { - "description": "if the credential is the default for the given provider", + "description": "Whether this credential is the default for its Git provider. The default credential is the\nfallback that is used when no specific credential is selected.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup.", "launch_stage": "PUBLIC_PREVIEW" } } @@ -78372,7 +79116,7 @@ "launch_stage": "GA" }, "value": { - "description": "The value of the secret in its byte representation.", + "description": "The secret value, base64-encoded. A secret written with ``string_value`` is returned\nas the base64 encoding of its UTF-8 bytes.", "launch_stage": "GA" } } @@ -78651,7 +79395,7 @@ "workspace.PutSecret": { "fields": { "bytes_value": { - "description": "If specified, value will be stored as bytes.", + "description": "The secret value as raw bytes. The bytes must be base64-encoded in the JSON request body.", "launch_stage": "GA" }, "key": { @@ -78659,11 +79403,11 @@ "launch_stage": "GA" }, "scope": { - "description": "The name of the scope to which the secret will be associated with.", + "description": "The name of the scope to store the secret in.", "launch_stage": "GA" }, "string_value": { - "description": "If specified, note that the value will be stored in UTF-8 (MB4) form.", + "description": "The secret value as text. The server stores it as the UTF-8 encoding of the string.", "launch_stage": "GA" } } @@ -78819,7 +79563,7 @@ "launch_stage": "GA" }, "last_updated_timestamp": { - "description": "The last updated timestamp (in milliseconds) for the secret.", + "description": "The time the secret was last written, in milliseconds since the Unix epoch.", "launch_stage": "GA" } } @@ -78868,7 +79612,7 @@ "launch_stage": "GA" }, "git_provider": { - "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.\nMust match the Git provider of the existing credential; the provider cannot be changed.", "launch_stage": "GA" }, "git_username": { @@ -78876,11 +79620,11 @@ "launch_stage": "GA" }, "is_default_for_provider": { - "description": "if the credential is the default for the given provider", + "description": "Set to true to make this credential the default for its Git provider, replacing the\ncurrent default. Cannot be set to false; make another credential the default instead.", "launch_stage": "PUBLIC_PREVIEW" }, "name": { - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup. It must not\nexceed 100 characters.", "launch_stage": "PUBLIC_PREVIEW" }, "personal_access_token": { @@ -81086,7 +81830,7 @@ }, { "name": "source_type", - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nThe server may store an omitted or UNSPECIFIED value as AGENT.", "is_request_body_field": true, "entity": { "pascal_name": "ManagedMemoryEntrySourceType", @@ -81143,7 +81887,7 @@ }, { "name": "CreateMemoryStore", - "description": "Creates a memory store in the caller's workspace.", + "description": "Creates a memory store in the caller's workspace. Returns `ALREADY_EXISTS` when a store with\nthe requested ID already exists.", "summary": "Create a memory store.", "path": "/api/2.0/agents/memory-stores", "can_use_json": true, @@ -81170,7 +81914,7 @@ }, { "name": "managed_memory_store_id", - "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit.", + "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit. It becomes the last segment of the store's `name` and cannot be changed\nafter creation.", "required": true, "is_query": true, "entity": { @@ -81181,7 +81925,7 @@ "required_in_url_fields": [ { "name": "managed_memory_store_id", - "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit.", + "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit. It becomes the last segment of the store's `name` and cannot be changed\nafter creation.", "required": true, "is_query": true, "entity": { @@ -81229,7 +81973,7 @@ }, { "name": "managed_memory_store_id", - "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit.", + "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit. It becomes the last segment of the store's `name` and cannot be changed\nafter creation.", "required": true, "is_query": true, "entity": { @@ -81323,7 +82067,7 @@ "required_positional_arguments": [ { "name": "managed_memory_store_id", - "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit.", + "description": "Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin\nwith a lowercase letter, contain only lowercase letters, digits, and hyphens, and end with a\nletter or digit. It becomes the last segment of the store's `name` and cannot be changed\nafter creation.", "required": true, "is_query": true, "entity": { @@ -81838,7 +82582,7 @@ }, { "name": "DeleteMemoryStore", - "description": "Deletes a memory store by resource name. Returns `NOT_FOUND` when the store does not\nexist in the caller's workspace.", + "description": "Deletes a memory store by resource name. Deleting a store also deletes all of its memory\nentries, and its ID becomes available for reuse. Returns `NOT_FOUND` when the store does not\nexist in the caller's workspace.", "summary": "Delete a memory store by resource name.", "path": "/api/2.0/agents/{name=memory-stores/*}", "has_required_positional_arguments": true, @@ -82845,7 +83589,7 @@ }, { "name": "permission", - "description": "Permission level to grant.", + "description": "Permission level to grant. `WRITE` includes `READ`. Grants are additive: granting `READ` to a\nprincipal that already holds `WRITE` does not lower its access. To downgrade a principal,\nrevoke its grants and grant again.", "required": true, "is_request_body_field": true, "entity": { @@ -82885,7 +83629,7 @@ }, { "name": "permission", - "description": "Permission level to grant.", + "description": "Permission level to grant. `WRITE` includes `READ`. Grants are additive: granting `READ` to a\nprincipal that already holds `WRITE` does not lower its access. To downgrade a principal,\nrevoke its grants and grant again.", "required": true, "is_request_body_field": true, "entity": { @@ -82918,7 +83662,7 @@ }, { "name": "permission", - "description": "Permission level to grant.", + "description": "Permission level to grant. `WRITE` includes `READ`. Grants are additive: granting `READ` to a\nprincipal that already holds `WRITE` does not lower its access. To downgrade a principal,\nrevoke its grants and grant again.", "required": true, "is_request_body_field": true, "entity": { @@ -83384,7 +84128,7 @@ }, { "name": "page_token", - "description": "Opaque pagination token from a previous ListManagedMemoryStores response.", + "description": "Opaque pagination token, taken from the `next_page_token` of a previous response.", "is_query": true, "entity": { "is_string": true @@ -83395,7 +84139,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "Opaque pagination token from a previous ListManagedMemoryStores response.", + "description": "Opaque pagination token, taken from the `next_page_token` of a previous response.", "is_query": true, "entity": { "is_string": true @@ -84523,7 +85267,7 @@ }, { "name": "source_type", - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nThe server may store an omitted or UNSPECIFIED value as AGENT.", "is_request_body_field": true, "entity": { "pascal_name": "ManagedMemoryEntrySourceType", @@ -84626,7 +85370,7 @@ }, { "name": "update_mask", - "description": "Only `description` and `metadata` may be updated. Selecting `metadata` replaces the entire map.", + "description": "Only `description` and `metadata` may be updated. Selecting `description` while leaving it\nunset clears it. Selecting `metadata` replaces the entire map.", "required": true, "is_query": true, "entity": { @@ -84647,7 +85391,7 @@ }, { "name": "update_mask", - "description": "Only `description` and `metadata` may be updated. Selecting `metadata` replaces the entire map.", + "description": "Only `description` and `metadata` may be updated. Selecting `description` while leaving it\nunset clears it. Selecting `metadata` replaces the entire map.", "required": true, "is_query": true, "entity": { @@ -84705,7 +85449,7 @@ }, { "name": "update_mask", - "description": "Only `description` and `metadata` may be updated. Selecting `metadata` replaces the entire map.", + "description": "Only `description` and `metadata` may be updated. Selecting `description` while leaving it\nunset clears it. Selecting `metadata` replaces the entire map.", "required": true, "is_query": true, "entity": { @@ -84809,7 +85553,7 @@ }, { "name": "update_mask", - "description": "Only `description` and `metadata` may be updated. Selecting `metadata` replaces the entire map.", + "description": "Only `description` and `metadata` may be updated. Selecting `description` while leaving it\nunset clears it. Selecting `metadata` replaces the entire map.", "required": true, "is_query": true, "entity": { @@ -85529,7 +86273,7 @@ }, { "name": "schema", - "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description/nullability (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", + "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Enum fields list their values in \"labels\" (e.g. {\"currency\": {\"type\": \"enum\", \"labels\": [\"USD\", \"EUR\"]}}). Primitive and enum fields are nullable by default. Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", "required": true, "is_request_body_field": true, "entity": {} @@ -85545,7 +86289,7 @@ }, { "name": "schema", - "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description/nullability (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", + "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Enum fields list their values in \"labels\" (e.g. {\"currency\": {\"type\": \"enum\", \"labels\": [\"USD\", \"EUR\"]}}). Primitive and enum fields are nullable by default. Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", "required": true, "is_request_body_field": true, "entity": {} @@ -85576,7 +86320,7 @@ }, { "name": "schema", - "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description/nullability (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", + "description": "The extraction schema defining the fields to extract. Either a JSON array of field names, assumed to be strings (e.g. [\"company\", \"valuation\"]), or a JSON object mapping each field to its type/description (e.g. {\"company\": {\"type\": \"string\", \"description\": \"the company name\"}}). Enum fields list their values in \"labels\" (e.g. {\"currency\": {\"type\": \"enum\", \"labels\": [\"USD\", \"EUR\"]}}). Primitive and enum fields are nullable by default. Accepts up to 256 fields, 12 levels of nesting, and 500 enum values. Supported field types are string, integer, number, boolean, and enum.", "required": true, "is_request_body_field": true, "entity": {} @@ -86325,7 +87069,7 @@ }, { "name": "mcp_service_id", - "description": "Name for the MCP service, e.g. \"my_mcp_service\".", + "description": "Name of the MCP service within the parent schema. The name must not\ncontain periods, spaces, forward slashes, percent signs, or control characters,\nand it is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86345,7 +87089,7 @@ }, { "name": "mcp_service_id", - "description": "Name for the MCP service, e.g. \"my_mcp_service\".", + "description": "Name of the MCP service within the parent schema. The name must not\ncontain periods, spaces, forward slashes, percent signs, or control characters,\nand it is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86393,7 +87137,7 @@ }, { "name": "mcp_service_id", - "description": "Name for the MCP service, e.g. \"my_mcp_service\".", + "description": "Name of the MCP service within the parent schema. The name must not\ncontain periods, spaces, forward slashes, percent signs, or control characters,\nand it is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86439,7 +87183,7 @@ }, { "name": "created_by", - "description": "Creator identity.", + "description": "Username or service principal application ID of the principal that created the MCP service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86448,7 +87192,7 @@ }, { "name": "effective_owner", - "description": "Owner of the MCP service.", + "description": "Username, group name, or service principal application ID of the MCP service owner.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86466,7 +87210,7 @@ }, { "name": "metastore_id", - "description": "Metastore hosting the MCP service.", + "description": "Unique identifier of the metastore that contains the MCP service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86475,7 +87219,7 @@ }, { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "is_request_body_field": true, "entity": { "is_string": true @@ -86493,7 +87237,7 @@ }, { "name": "updated_by", - "description": "Identity of the last updater.", + "description": "Username or service principal application ID of the principal that last updated the MCP\nservice.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86513,7 +87257,7 @@ }, { "name": "mcp_service_id", - "description": "Name for the MCP service, e.g. \"my_mcp_service\".", + "description": "Name of the MCP service within the parent schema. The name must not\ncontain periods, spaces, forward slashes, percent signs, or control characters,\nand it is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86672,7 +87416,7 @@ }, { "name": "model_provider_service_id", - "description": "Name for the model provider service, e.g. \"openai_prod\".", + "description": "Name of the model provider service within the parent schema. The name must\nnot contain periods, spaces, forward slashes, percent signs, or control\ncharacters, must not end in `_DO_NOT_MODIFY`, and must not exceed 241\ncharacters. It is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86692,7 +87436,7 @@ }, { "name": "model_provider_service_id", - "description": "Name for the model provider service, e.g. \"openai_prod\".", + "description": "Name of the model provider service within the parent schema. The name must\nnot contain periods, spaces, forward slashes, percent signs, or control\ncharacters, must not end in `_DO_NOT_MODIFY`, and must not exceed 241\ncharacters. It is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86740,7 +87484,7 @@ }, { "name": "model_provider_service_id", - "description": "Name for the model provider service, e.g. \"openai_prod\".", + "description": "Name of the model provider service within the parent schema. The name must\nnot contain periods, spaces, forward slashes, percent signs, or control\ncharacters, must not end in `_DO_NOT_MODIFY`, and must not exceed 241\ncharacters. It is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -86786,7 +87530,7 @@ }, { "name": "created_by", - "description": "Creator identity.", + "description": "Username of the user who created the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86795,7 +87539,7 @@ }, { "name": "effective_owner", - "description": "Owner of the model provider service.", + "description": "Username or group name of the model provider service owner.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86813,7 +87557,7 @@ }, { "name": "metastore_id", - "description": "Metastore hosting the provider service.", + "description": "Unique identifier of the metastore that contains the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86822,7 +87566,7 @@ }, { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "is_request_body_field": true, "entity": { "is_string": true @@ -86840,7 +87584,7 @@ }, { "name": "updated_by", - "description": "Identity of the last updater.", + "description": "Username of the user who last updated the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -86860,7 +87604,7 @@ }, { "name": "model_provider_service_id", - "description": "Name for the model provider service, e.g. \"openai_prod\".", + "description": "Name of the model provider service within the parent schema. The name must\nnot contain periods, spaces, forward slashes, percent signs, or control\ncharacters, must not end in `_DO_NOT_MODIFY`, and must not exceed 241\ncharacters. It is stored in lowercase.", "required": true, "is_query": true, "entity": { @@ -88402,7 +89146,7 @@ "required_fields": [ { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "required": true, "is_path": true, "entity": { @@ -88432,7 +89176,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "required": true, "is_path": true, "entity": { @@ -88497,7 +89241,7 @@ }, { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "required": true, "is_path": true, "entity": { @@ -88543,7 +89287,7 @@ }, { "name": "created_by", - "description": "Creator identity.", + "description": "Username or service principal application ID of the principal that created the MCP service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88552,7 +89296,7 @@ }, { "name": "effective_owner", - "description": "Owner of the MCP service.", + "description": "Username, group name, or service principal application ID of the MCP service owner.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88570,7 +89314,7 @@ }, { "name": "metastore_id", - "description": "Metastore hosting the MCP service.", + "description": "Unique identifier of the metastore that contains the MCP service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88579,7 +89323,7 @@ }, { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "is_request_body_field": true, "entity": { "is_string": true @@ -88597,7 +89341,7 @@ }, { "name": "updated_by", - "description": "Identity of the last updater.", + "description": "Username or service principal application ID of the principal that last updated the MCP\nservice.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88608,7 +89352,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`mcp_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the MCP service.\nFormat: `mcp-services/{catalog}.{schema}.{mcp_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `mcp_service_id`; it is required and immutable on Update,\nGet, and Delete.", "required": true, "is_path": true, "entity": { @@ -88643,7 +89387,7 @@ "required_fields": [ { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "required": true, "is_path": true, "entity": { @@ -88673,7 +89417,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "required": true, "is_path": true, "entity": { @@ -88738,7 +89482,7 @@ }, { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "required": true, "is_path": true, "entity": { @@ -88784,7 +89528,7 @@ }, { "name": "created_by", - "description": "Creator identity.", + "description": "Username of the user who created the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88793,7 +89537,7 @@ }, { "name": "effective_owner", - "description": "Owner of the model provider service.", + "description": "Username or group name of the model provider service owner.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88811,7 +89555,7 @@ }, { "name": "metastore_id", - "description": "Metastore hosting the provider service.", + "description": "Unique identifier of the metastore that contains the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88820,7 +89564,7 @@ }, { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "is_request_body_field": true, "entity": { "is_string": true @@ -88838,7 +89582,7 @@ }, { "name": "updated_by", - "description": "Identity of the last updater.", + "description": "Username of the user who last updated the model provider service.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -88849,7 +89593,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nServer-derived on Create from `parent` +\n`model_provider_service_id`; required and immutable on Update/Get/Delete.", + "description": "Resource name of the provider service.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.\nThe server derives the name on Create from\n`parent` and `model_provider_service_id`; it is required and immutable on\nUpdate, Get, and Delete.", "required": true, "is_path": true, "entity": { @@ -89606,7 +90350,7 @@ }, { "name": "endpoint_id", - "description": "The user-supplied short name for the Endpoint, per AIP-133. The server composes the\nfull `Endpoint.name` as `{parent}/endpoints/{endpoint_id}`. AIP-133 does not list\n`endpoint_id` as a fields-may-be-required entry, so we annotate it OPTIONAL on the\nwire; the server still rejects empty values with INVALID_PARAMETER_VALUE.", + "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.", "is_query": true, "entity": { "is_string": true @@ -89623,7 +90367,7 @@ }, { "name": "budget_policy_id", - "description": "The user-selected budget policy id for the endpoint.", + "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`.", "is_request_body_field": true, "entity": { "is_string": true @@ -89641,7 +90385,7 @@ }, { "name": "creator", - "description": "Creator of the endpoint", + "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.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -89650,7 +90394,7 @@ }, { "name": "custom_tags", - "description": "The custom tags assigned to the endpoint", + "description": "Custom tags assigned to the endpoint. On update, the list replaces all of the endpoint's\nexisting tags.", "is_request_body_field": true, "entity": { "pascal_name": "CustomTagList", @@ -89662,7 +90406,7 @@ }, { "name": "effective_budget_policy_id", - "description": "The budget policy id applied to the endpoint", + "description": "ID of the budget policy that is currently applied to the endpoint.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -89671,7 +90415,7 @@ }, { "name": "endpoint_status", - "description": "Current status of the endpoint", + "description": "Current lifecycle state of the endpoint, with an optional message that explains it.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -89699,7 +90443,7 @@ }, { "name": "id", - "description": "Unique identifier of the endpoint", + "description": "System-generated UUID that uniquely identifies the endpoint.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -89717,7 +90461,7 @@ }, { "name": "last_updated_user", - "description": "User who last updated the endpoint", + "description": "User name of the principal that last updated the endpoint, in the same format as `creator`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -89726,7 +90470,7 @@ }, { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "is_request_body_field": true, "entity": { "is_string": true @@ -89753,7 +90497,7 @@ }, { "name": "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.", + "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`.", "is_request_body_field": true, "entity": { "is_int": true @@ -89782,7 +90526,7 @@ }, { "name": "usage_policy_id", - "description": "The usage policy id applied to the endpoint.", + "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.", "is_request_body_field": true, "entity": { "is_string": true @@ -90624,7 +91368,7 @@ "all_fields": [ { "name": "page_size", - "description": "Best-effort upper bound on the number of results to return. Honored as an upper\nbound by the shim: `page_size` only narrows the legacy backend's response, never\nwidens it, so the practical cap is `min(page_size, legacy_fixed_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.", "is_query": true, "entity": { "is_int": true @@ -91221,7 +91965,7 @@ }, { "name": "UpdateEndpoint", - "description": "Update an existing AI Search endpoint. Multi-bucket masks are supported and\ndispatched in deterministic bucket order: budget policy, custom tags, throughput,\nscaling/replicas, then metrics export. Per-bucket dispatch is not atomic across buckets — if a\nlater bucket fails, earlier buckets may already have been applied.", + "description": "Update an existing AI Search endpoint. Only the fields named in `update_mask` change.\nThe server applies a mask that spans several settings, such as `budget_policy_id` and\n`custom_tags`, one setting at a time, so if a later setting fails, the earlier ones may\nalready have been applied.", "summary": "Update an AI Search endpoint.", "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*}", "can_use_json": true, @@ -91238,7 +91982,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "required": true, "is_path": true, "entity": { @@ -91257,7 +92001,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "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.", "required": true, "is_query": true, "entity": { @@ -91268,7 +92012,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "required": true, "is_path": true, "entity": { @@ -91277,7 +92021,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "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.", "required": true, "is_query": true, "entity": { @@ -91442,7 +92186,7 @@ }, { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "required": true, "is_path": true, "entity": { @@ -91451,7 +92195,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "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.", "required": true, "is_query": true, "entity": { @@ -91460,7 +92204,7 @@ }, { "name": "budget_policy_id", - "description": "The user-selected budget policy id for the endpoint.", + "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`.", "is_request_body_field": true, "entity": { "is_string": true @@ -91478,7 +92222,7 @@ }, { "name": "creator", - "description": "Creator of the endpoint", + "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.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -91487,7 +92231,7 @@ }, { "name": "custom_tags", - "description": "The custom tags assigned to the endpoint", + "description": "Custom tags assigned to the endpoint. On update, the list replaces all of the endpoint's\nexisting tags.", "is_request_body_field": true, "entity": { "pascal_name": "CustomTagList", @@ -91499,7 +92243,7 @@ }, { "name": "effective_budget_policy_id", - "description": "The budget policy id applied to the endpoint", + "description": "ID of the budget policy that is currently applied to the endpoint.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -91508,7 +92252,7 @@ }, { "name": "endpoint_status", - "description": "Current status of the endpoint", + "description": "Current lifecycle state of the endpoint, with an optional message that explains it.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -91536,7 +92280,7 @@ }, { "name": "id", - "description": "Unique identifier of the endpoint", + "description": "System-generated UUID that uniquely identifies the endpoint.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -91554,7 +92298,7 @@ }, { "name": "last_updated_user", - "description": "User who last updated the endpoint", + "description": "User name of the principal that last updated the endpoint, in the same format as `creator`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -91563,7 +92307,7 @@ }, { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "is_request_body_field": true, "entity": { "is_string": true @@ -91590,7 +92334,7 @@ }, { "name": "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.", + "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`.", "is_request_body_field": true, "entity": { "is_int": true @@ -91619,7 +92363,7 @@ }, { "name": "usage_policy_id", - "description": "The usage policy id applied to the endpoint.", + "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.", "is_request_body_field": true, "entity": { "is_string": true @@ -91629,7 +92373,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the AI Search endpoint. Server-assigned full resource path\n(`workspaces/{workspace}/endpoints/{endpoint}`) on output. On create, the\nuser-supplied short name is conveyed via `CreateEndpointRequest.endpoint_id`;\nthe server composes the full `name` and returns it on the response.", + "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.", "required": true, "is_path": true, "entity": { @@ -91638,7 +92382,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "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.", "required": true, "is_query": true, "entity": { @@ -101033,7 +101777,7 @@ "methods": [ { "name": "Create", - "description": "Creates a new policy.", + "description": "Creates a new usage policy. The creator is granted the manager role on the new policy.", "summary": "Create a budget policy.", "path": "/api/2.1/accounts/{account_id}/budget-policies", "can_use_json": true, @@ -101054,7 +101798,7 @@ "all_fields": [ { "name": "policy", - "description": "The policy to create. `policy_id` needs to be empty as it will be generated\n`policy_name` must be provided, custom_tags may need to be provided\ndepending on the cloud provider. All other fields are optional.", + "description": "The policy to create. `policy_name` must be provided, and `custom_tags` may be required\ndepending on the cloud provider. Leave `policy_id` empty because Databricks generates it. All\nother fields are optional.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -101074,7 +101818,7 @@ }, { "name": "Delete", - "description": "Deletes a policy", + "description": "Deletes a usage policy.", "summary": "Delete a budget policy.", "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", "has_required_positional_arguments": true, @@ -101136,7 +101880,7 @@ }, { "name": "Get", - "description": "Retrieves a policy by it's ID.", + "description": "Retrieves a usage policy by its ID.", "summary": "Get a budget policy.", "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", "is_crud_read": true, @@ -101200,7 +101944,7 @@ }, { "name": "List", - "description": "Lists all policies. Policies are returned in the alphabetically ascending order of their names.", + "description": "Lists the usage policies that the caller has permission to view. Policies are sorted by name\nin ascending order unless `sort_spec` requests a different order.", "summary": "List policies.", "path": "/api/2.1/accounts/{account_id}/budget-policies", "has_required_positional_arguments": true, @@ -101237,7 +101981,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "description": "A page token, received from a previous `ListBudgetPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListBudgetPolicies` must match\nthe call that provided the page token.", "is_query": true, "entity": { "is_string": true @@ -101245,7 +101989,7 @@ }, { "name": "sort_spec", - "description": "The sort specification.", + "description": "How to sort the returned policies. If unspecified, policies are sorted by name in ascending\norder.", "is_query": true, "is_optional_object": true, "entity": { @@ -101258,7 +102002,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous `ListServerlessPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match\nthe call that provided the page token.", + "description": "A page token, received from a previous `ListBudgetPolicies` call.\nProvide this to retrieve the subsequent page.\nIf unspecified, the first page will be returned.\n\nWhen paginating, all other parameters provided to `ListBudgetPolicies` must match\nthe call that provided the page token.", "is_query": true, "entity": { "is_string": true @@ -101269,7 +102013,7 @@ }, { "name": "Update", - "description": "Updates a policy", + "description": "Updates a usage policy. Changes apply only to serverless usage that starts after the update,\nnot to workloads that are already running.", "summary": "Update a budget policy.", "path": "/api/2.1/accounts/{account_id}/budget-policies/{policy_id}", "can_use_json": true, @@ -101344,7 +102088,7 @@ "all_fields": [ { "name": "limit_config", - "description": "DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy", + "description": "Deprecated: This field is ignored.", "is_query": true, "is_optional_object": true, "entity": { @@ -101831,7 +102575,7 @@ }, { "name": "budget", - "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.\nAlerts and actions are matched by ID: those omitted from the request are removed, and those\nwithout an ID are created.", "required": true, "is_request_body_field": true, "entity": { @@ -101854,7 +102598,7 @@ "required_request_body_fields": [ { "name": "budget", - "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.\nAlerts and actions are matched by ID: those omitted from the request are removed, and those\nwithout an ID are created.", "required": true, "is_request_body_field": true, "entity": { @@ -101871,7 +102615,7 @@ "all_fields": [ { "name": "budget", - "description": "The updated budget. This will overwrite the budget specified by the budget ID.", + "description": "The updated budget. This will overwrite the budget specified by the budget ID.\nAlerts and actions are matched by ID: those omitted from the request are removed, and those\nwithout an ID are created.", "required": true, "is_request_body_field": true, "entity": { @@ -108631,7 +109375,7 @@ "methods": [ { "name": "Create", - "description": "Create a new clean room with the specified collaborators.\nThis method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status,\nusing the [cleanrooms/get](https://docs.databricks.com/api/workspace/cleanrooms/get) method.\nWhen this method returns, the clean room will be in a PROVISIONING state, with only name, owner, comment, created_at and status populated.\nThe clean room will be usable once it enters an ACTIVE state.\n\nThe caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the\nmetastore.", + "description": "Create a new clean room with the specified collaborators.\nThis method is asynchronous; the name field of the returned clean room can be used to poll the clean room status,\nusing the [cleanrooms/get](https://docs.databricks.com/api/workspace/cleanrooms/get) method.\nWhen this method returns, the clean room will be in a PROVISIONING state, with only name, owner, comment, created_at and status populated.\nThe clean room will be usable once it enters an ACTIVE state.\n\nThe caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the\nmetastore.", "summary": "Create a clean room.", "path": "/api/2.0/clean-rooms", "can_use_json": true, @@ -108708,6 +109452,7 @@ }, { "name": "comment", + "description": "Free-form description of the clean room. Comments are local to the caller's metastore and are\nnot shared with the other collaborators.", "is_request_body_field": true, "entity": { "is_string": true @@ -108760,7 +109505,7 @@ }, { "name": "owner", - "description": "This is the Databricks username of the owner of the local clean room securable for permission management.", + "description": "This is the Databricks username of the owner of the local clean room securable for permission management.\nWhen creating a clean room, leave it empty or set it to the caller.", "is_request_body_field": true, "entity": { "is_string": true @@ -108830,7 +109575,7 @@ }, { "name": "CreateOutputCatalog", - "description": "Create the output catalog of the clean room.", + "description": "Create the output catalog of the clean room. The output catalog is a catalog in the caller's\nmetastore where the output tables of the clean room runs that the caller triggers are made\navailable. Each collaborator can create one output catalog per clean room, and the clean room\nmust be ACTIVE.", "summary": "Create an output catalog.", "path": "/api/2.0/clean-rooms/{clean_room_name}/output-catalogs", "can_use_json": true, @@ -108901,6 +109646,7 @@ "required_fields": [ { "name": "output_catalog", + "description": "The output catalog that was created.", "required": true, "is_request_body_field": true, "entity": { @@ -108912,6 +109658,7 @@ "required_request_body_fields": [ { "name": "output_catalog", + "description": "The output catalog that was created.", "required": true, "is_request_body_field": true, "entity": { @@ -108950,6 +109697,7 @@ }, { "name": "status", + "description": "Status of the output catalog for the calling collaborator.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -109055,6 +109803,7 @@ "required_fields": [ { "name": "name", + "description": "Name of the clean room.", "required": true, "is_path": true, "entity": { @@ -109065,6 +109814,7 @@ "required_in_url_fields": [ { "name": "name", + "description": "Name of the clean room.", "required": true, "is_path": true, "entity": { @@ -109080,6 +109830,7 @@ "all_fields": [ { "name": "name", + "description": "Name of the clean room.", "required": true, "is_path": true, "entity": { @@ -109090,6 +109841,7 @@ "required_positional_arguments": [ { "name": "name", + "description": "Name of the clean room.", "required": true, "is_path": true, "entity": { @@ -109187,6 +109939,7 @@ "all_fields": [ { "name": "clean_room", + "description": "Clean room fields to update. Only mutable fields such as owner, comment and\nenable_shared_output can be changed; remote_detailed_info, status, created_at and updated_at\nmust be omitted.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -109925,6 +110678,7 @@ "required_fields": [ { "name": "cluster_id", + "description": "The ID of the cluster whose owner is changed.", "required": true, "is_request_body_field": true, "entity": { @@ -109944,6 +110698,7 @@ "required_request_body_fields": [ { "name": "cluster_id", + "description": "The ID of the cluster whose owner is changed.", "required": true, "is_request_body_field": true, "entity": { @@ -109969,6 +110724,7 @@ "all_fields": [ { "name": "cluster_id", + "description": "The ID of the cluster whose owner is changed.", "required": true, "is_request_body_field": true, "entity": { @@ -109988,6 +110744,7 @@ "required_positional_arguments": [ { "name": "cluster_id", + "description": "The ID of the cluster whose owner is changed.", "required": true, "is_request_body_field": true, "entity": { @@ -110067,7 +110824,7 @@ }, { "name": "autotermination_minutes", - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "is_request_body_field": true, "entity": { "is_int": true @@ -110133,6 +110890,7 @@ }, { "name": "data_security_mode", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "is_request_body_field": true, "entity": { "pascal_name": "DataSecurityMode", @@ -110191,7 +110949,7 @@ }, { "name": "docker_image", - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -110281,6 +111039,7 @@ }, { "name": "kind", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "is_request_body_field": true, "entity": { "pascal_name": "Kind", @@ -110418,6 +111177,7 @@ }, { "name": "workload_type", + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -110634,7 +111394,7 @@ }, { "name": "autotermination_minutes", - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "is_request_body_field": true, "entity": { "is_int": true @@ -110699,6 +111459,7 @@ }, { "name": "data_security_mode", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "is_request_body_field": true, "entity": { "pascal_name": "DataSecurityMode", @@ -110757,7 +111518,7 @@ }, { "name": "docker_image", - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -110847,6 +111608,7 @@ }, { "name": "kind", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "is_request_body_field": true, "entity": { "pascal_name": "Kind", @@ -110984,6 +111746,7 @@ }, { "name": "workload_type", + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -111866,6 +112629,7 @@ }, { "name": "restart_user", + "description": "User name recorded in the `RESTARTING` cluster event as the user who restarted the cluster.\nIf omitted, the name of the user making the request is recorded.", "is_request_body_field": true, "entity": { "is_string": true @@ -129190,7 +129954,7 @@ "methods": [ { "name": "CreateFailoverGroup", - "description": "Create a new failover group.", + "description": "Create a failover group. The group starts in the CREATING state and moves to\nINITIAL_REPLICATION while the first replication cycle copies all in-scope data to the\nsecondary region; failover becomes available once the group is ACTIVE. Set validate_only\nto check the request without creating anything.", "summary": "Create a Failover Group.", "path": "/api/disaster-recovery/v1/{parent=accounts/*}/failover-groups", "can_use_json": true, @@ -129277,7 +130041,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129289,7 +130053,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129302,7 +130066,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129313,7 +130077,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129325,7 +130089,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129338,7 +130102,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129355,7 +130119,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129367,7 +130131,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129380,7 +130144,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129391,7 +130155,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129403,7 +130167,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129416,7 +130180,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129438,7 +130202,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129450,7 +130214,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129463,7 +130227,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129474,7 +130238,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129486,7 +130250,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129499,7 +130263,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129565,7 +130329,7 @@ }, { "name": "has_replication_point_blocking_errors", - "description": "True if errors currently block the replication point.", + "description": "True when replication errors are preventing the replication point from advancing.\nPopulated only while the failover group is INITIAL_REPLICATION or ACTIVE; the blocking\nerrors are listed in the system.replication.states system table.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -129574,7 +130338,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -129602,7 +130366,7 @@ }, { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129614,7 +130378,7 @@ }, { "name": "replication_point", - "description": "The latest point in time to which data has been replicated.", + "description": "The most recent point in time up to which all in-scope assets have been replicated to the\nsecondary region. Data written after this point might not exist in the secondary yet and\ncan be lost in an unplanned failover. When both Unity Catalog and workspace assets are\nreplicated, this is the older of the two replication points. Not populated until the\nfirst replication point exists, and not populated in ListFailoverGroups responses.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -129624,7 +130388,7 @@ }, { "name": "state", - "description": "Aggregate state of the failover group.", + "description": "Aggregate state of the failover group across Unity Catalog and workspace asset\nreplication. The group is INITIAL_REPLICATION until it has a replication point, ACTIVE\nwhile replication is in steady state and failover is available, and FAILING_OVER while a\nfailover is in progress; the `*_FAILED` values mean that the last operation did not\ncomplete. Not populated in ListFailoverGroups responses.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -129659,7 +130423,7 @@ }, { "name": "unity_catalog_assets", - "description": "Unity Catalog replication configuration.", + "description": "Unity Catalog replication configuration: the catalogs to replicate and the storage\nlocation mappings for their data. Omit it to replicate workspace assets only.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -129679,7 +130443,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129712,7 +130476,7 @@ }, { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -129724,7 +130488,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -129737,7 +130501,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130029,7 +130793,7 @@ }, { "name": "DeleteFailoverGroup", - "description": "Delete a failover group.", + "description": "Delete a failover group. Deleting stops replication for the group; stable URLs linked\nto it are detached but not deleted.", "summary": "Delete a Failover Group.", "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", "has_required_positional_arguments": true, @@ -130157,7 +130921,7 @@ }, { "name": "FailoverFailoverGroup", - "description": "Initiate a failover to a new primary region.", + "description": "Initiate a failover that makes target_primary_region the primary region. Stable URLs\nlinked to the group are pointed at the new primary workspace, replication is reversed so\nthat the former primary becomes the secondary, and the group moves through FAILING_OVER\nto INITIAL_REPLICATION until it has a replication point in the new direction. The group\nmust be ACTIVE; repeating the request while it is FAILING_OVER is accepted. To fail back,\nrepeat the request with the former primary region as the target once the group is ACTIVE\nagain. In an unplanned failover, data written after the replication point can be lost.", "summary": "Failover a Failover Group to a new primary region.", "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}/failover", "can_use_json": true, @@ -130189,7 +130953,7 @@ }, { "name": "failover_type", - "description": "The type of failover to perform.", + "description": "The type of failover to perform. FORCED is the only supported type.", "required": true, "is_request_body_field": true, "entity": { @@ -130225,7 +130989,7 @@ }, { "name": "failover_type", - "description": "The type of failover to perform.", + "description": "The type of failover to perform. FORCED is the only supported type.", "required": true, "is_request_body_field": true, "entity": { @@ -130246,7 +131010,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130258,7 +131022,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130271,7 +131035,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130282,7 +131046,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130294,7 +131058,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130307,7 +131071,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130327,7 +131091,7 @@ }, { "name": "failover_type", - "description": "The type of failover to perform.", + "description": "The type of failover to perform. FORCED is the only supported type.", "required": true, "is_request_body_field": true, "entity": { @@ -130379,7 +131143,7 @@ }, { "name": "failover_type", - "description": "The type of failover to perform.", + "description": "The type of failover to perform. FORCED is the only supported type.", "required": true, "is_request_body_field": true, "entity": { @@ -130395,7 +131159,7 @@ }, { "name": "GetFailoverGroup", - "description": "Get a failover group.", + "description": "Get a failover group, including its current state and replication point.", "summary": "Get a Failover Group.", "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", "is_crud_read": true, @@ -130435,7 +131199,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130447,7 +131211,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130460,7 +131224,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130471,7 +131235,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130483,7 +131247,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130496,7 +131260,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130615,7 +131379,7 @@ }, { "name": "ListFailoverGroups", - "description": "List failover groups.\n\nList entries are abbreviated: `state` and `replication_point` are not\npopulated. Call GetFailoverGroup to retrieve the full resource.", + "description": "List the failover groups in an account.\n\nList entries are abbreviated: `state`, `replication_point` and\n`unity_catalog_assets.location_mappings` are not populated. Call GetFailoverGroup to\nretrieve the full resource.", "summary": "List Failover Groups.", "path": "/api/disaster-recovery/v1/{parent=accounts/*}/failover-groups", "has_required_positional_arguments": true, @@ -130793,7 +131557,7 @@ }, { "name": "UpdateFailoverGroup", - "description": "Update a failover group.", + "description": "Update a failover group. Only the fields named in update_mask change. You can turn\nworkspace asset replication on or off, attach or detach a stable URL, and change the\nUnity Catalog catalogs and location mappings; the regions, the workspace set name and\nthe workspace IDs cannot be changed. Updates are rejected while a create, failover or\ndelete is in progress, and after a create or delete has failed.", "summary": "Update a Failover Group.", "path": "/api/disaster-recovery/v1/{name=accounts/*/failover-groups/*}", "can_use_json": true, @@ -130827,7 +131591,7 @@ }, { "name": "update_mask", - "description": "Comma-separated list of fields to update.", + "description": "Comma-separated list of the fields to update. The supported paths are `workspace_sets`,\n`unity_catalog_assets`, `unity_catalog_assets.catalogs` and\n`unity_catalog_assets.location_mappings`; any other path is rejected.", "required": true, "is_query": true, "entity": { @@ -130847,7 +131611,7 @@ }, { "name": "update_mask", - "description": "Comma-separated list of fields to update.", + "description": "Comma-separated list of the fields to update. The supported paths are `workspace_sets`,\n`unity_catalog_assets`, `unity_catalog_assets.catalogs` and\n`unity_catalog_assets.location_mappings`; any other path is rejected.", "required": true, "is_query": true, "entity": { @@ -130880,7 +131644,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130892,7 +131656,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130905,7 +131669,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130916,7 +131680,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130928,7 +131692,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130941,7 +131705,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130958,7 +131722,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -130970,7 +131734,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -130983,7 +131747,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -130994,7 +131758,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -131006,7 +131770,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -131019,7 +131783,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -131049,7 +131813,7 @@ "required_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -131061,7 +131825,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -131074,7 +131838,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -131085,7 +131849,7 @@ "required_request_body_fields": [ { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -131097,7 +131861,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -131110,7 +131874,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -131131,7 +131895,7 @@ }, { "name": "update_mask", - "description": "Comma-separated list of fields to update.", + "description": "Comma-separated list of the fields to update. The supported paths are `workspace_sets`,\n`unity_catalog_assets`, `unity_catalog_assets.catalogs` and\n`unity_catalog_assets.location_mappings`; any other path is rejected.", "required": true, "is_query": true, "entity": { @@ -131168,7 +131932,7 @@ }, { "name": "has_replication_point_blocking_errors", - "description": "True if errors currently block the replication point.", + "description": "True when replication errors are preventing the replication point from advancing.\nPopulated only while the failover group is INITIAL_REPLICATION or ACTIVE; the blocking\nerrors are listed in the system.replication.states system table.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -131177,7 +131941,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -131205,7 +131969,7 @@ }, { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -131217,7 +131981,7 @@ }, { "name": "replication_point", - "description": "The latest point in time to which data has been replicated.", + "description": "The most recent point in time up to which all in-scope assets have been replicated to the\nsecondary region. Data written after this point might not exist in the secondary yet and\ncan be lost in an unplanned failover. When both Unity Catalog and workspace assets are\nreplicated, this is the older of the two replication points. Not populated until the\nfirst replication point exists, and not populated in ListFailoverGroups responses.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -131227,7 +131991,7 @@ }, { "name": "state", - "description": "Aggregate state of the failover group.", + "description": "Aggregate state of the failover group across Unity Catalog and workspace asset\nreplication. The group is INITIAL_REPLICATION until it has a replication point, ACTIVE\nwhile replication is in steady state and failover is available, and FAILING_OVER while a\nfailover is in progress; the `*_FAILED` values mean that the last operation did not\ncomplete. Not populated in ListFailoverGroups responses.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -131262,7 +132026,7 @@ }, { "name": "unity_catalog_assets", - "description": "Unity Catalog replication configuration.", + "description": "Unity Catalog replication configuration: the catalogs to replicate and the storage\nlocation mappings for their data. Omit it to replicate workspace assets only.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -131282,7 +132046,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -131306,7 +132070,7 @@ }, { "name": "update_mask", - "description": "Comma-separated list of fields to update.", + "description": "Comma-separated list of the fields to update. The supported paths are `workspace_sets`,\n`unity_catalog_assets`, `unity_catalog_assets.catalogs` and\n`unity_catalog_assets.location_mappings`; any other path is rejected.", "required": true, "is_query": true, "entity": { @@ -131315,7 +132079,7 @@ }, { "name": "regions", - "description": "List of all regions participating in this failover group.", + "description": "The two cloud regions that participate in this failover group, the primary and the\nsecondary. Each workspace set contains one workspace in each region.", "required": true, "is_request_body_field": true, "entity": { @@ -131327,7 +132091,7 @@ }, { "name": "workspace_sets", - "description": "Workspace sets, each containing workspaces that replicate to each other.", + "description": "Workspace sets, each containing workspaces that replicate to each other. A failover group\ncurrently supports exactly one workspace set.", "required": true, "is_request_body_field": true, "entity": { @@ -131340,7 +132104,7 @@ }, { "name": "initial_primary_region", - "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses.", + "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region, and must be one of the regions in `regions`. Not returned in responses.", "required": true, "is_request_body_field": true, "entity": { @@ -135248,7 +136012,7 @@ "methods": [ { "name": "CreateWorkspaceBaseEnvironment", - "description": "Creates a new WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously generate a materialized environment\nto optimize dependency resolution and is only marked as done when the materialized environment has been\nsuccessfully generated or has failed.", + "description": "Creates a new WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously generate a materialized environment\nto optimize dependency resolution and is only marked as done when the materialized environment has been\nsuccessfully generated or has failed. Poll the returned operation with GetOperation.", "summary": "Create a workspace base environment.", "path": "/api/environments/v1/workspace-base-environments", "can_use_json": true, @@ -135374,7 +136138,7 @@ }, { "name": "base_environment_type", - "description": "The type of base environment (CPU or GPU).", + "description": "The type of base environment (CPU or GPU). The default is `CPU`.", "is_request_body_field": true, "entity": { "pascal_name": "BaseEnvironmentType", @@ -135418,7 +136182,7 @@ }, { "name": "filepath", - "description": "The WSFS or UC Volumes path to the environment YAML file.", + "description": "The workspace file or Unity Catalog volume path to the YAML file that defines the environment version and\ndependencies. The file name must end in `.yaml` or `.yml`. Create and update requests must set this field.", "is_request_body_field": true, "entity": { "is_string": true @@ -135444,7 +136208,7 @@ }, { "name": "message", - "description": "Status message providing additional details about the environment status.", + "description": "Status message providing additional details about the environment status.\nWhen the status is `FAILED`, the message contains the build error.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -135453,7 +136217,7 @@ }, { "name": "name", - "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\nThe server ignores this field on create and builds the name from `workspace_base_environment_id`, or from\n`display_name` plus a random suffix when no ID is given.", "is_request_body_field": true, "entity": { "is_string": true @@ -135461,7 +136225,7 @@ }, { "name": "spec", - "description": "The environment specification containing version and dependencies.", + "description": "The environment specification containing version and dependencies, read from the YAML file at `filepath`.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -135472,7 +136236,7 @@ }, { "name": "status", - "description": "The status of the materialized workspace base environment.", + "description": "The status of the materialized workspace base environment, which the server builds from the YAML file.\nThe status is `CREATED` once the build has succeeded.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -135534,7 +136298,7 @@ }, { "name": "DeleteWorkspaceBaseEnvironment", - "description": "Deletes a WorkspaceBaseEnvironment.\nDeleting a base environment may impact linked notebooks and jobs.\nThis operation is irreversible and should be performed only when you are certain the environment is no longer needed.", + "description": "Deletes a WorkspaceBaseEnvironment.\nDeleting a base environment may impact linked notebooks and jobs.\nThis operation is irreversible and should be performed only when you are certain the environment is no longer needed.\nDatabricks-provided base environments cannot be deleted.", "summary": "Delete a workspace base environment.", "path": "/api/environments/v1/{name=workspace-base-environments/*}", "has_required_positional_arguments": true, @@ -135656,7 +136420,7 @@ }, { "name": "GetOperation", - "description": "Gets the status of a long-running operation.\nClients can use this method to poll the operation result.", + "description": "Gets the status of a long-running operation.\nClients can use this method to poll the operation result.\nCreate, update and refresh return an operation named `operations/{workspace_base_environment_id}`.\nThe operation is done when the materialized environment build finishes. On success, `response` contains the\nWorkspaceBaseEnvironment with status `CREATED`. When the status is `FAILED`, `EXPIRED` or `INVALID`, `error` is\nset instead, and `error.message` carries the environment's status message when one is available.", "summary": "Get the status of a long-running operation.", "path": "/api/environments/v1/{name=operations/*}", "is_crud_read": true, @@ -135850,7 +136614,7 @@ }, { "name": "RefreshWorkspaceBaseEnvironment", - "description": "Refreshes the materialized environment for a WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.", + "description": "Refreshes the materialized environment for a WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.\nPoll the returned operation with GetOperation. Databricks-provided base environments cannot be refreshed.", "summary": "Refresh materialized workspace base environment.", "path": "/api/environments/v1/{name=workspace-base-environments/*}/refresh", "has_required_positional_arguments": true, @@ -135862,7 +136626,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "Required. The resource name of the workspace base environment to refresh.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -135873,7 +136637,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "Required. The resource name of the workspace base environment to refresh.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -135889,7 +136653,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "Required. The resource name of the workspace base environment to refresh.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -135900,7 +136664,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the workspace base environment to delete.\nFormat: workspace-base-environments/{workspace_base_environment}", + "description": "Required. The resource name of the workspace base environment to refresh.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -136087,7 +136851,7 @@ }, { "name": "UpdateWorkspaceBaseEnvironment", - "description": "Updates an existing WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.", + "description": "Updates an existing WorkspaceBaseEnvironment.\nThis is a long-running operation. The operation will asynchronously regenerate the materialized environment\nand is only marked as done when the materialized environment has been successfully generated or has failed.\nThe existing materialized environment remains available until it expires.\nPoll the returned operation with GetOperation. Databricks-provided base environments cannot be updated.", "summary": "Update a workspace base environment.", "path": "/api/environments/v1/{name=workspace-base-environments/*}", "can_use_json": true, @@ -136101,6 +136865,7 @@ "required_fields": [ { "name": "name", + "description": "The resource name of the workspace base environment to update.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -136109,7 +136874,7 @@ }, { "name": "workspace_base_environment", - "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "description": "The workspace base environment with its new configuration.\nThe `name` path parameter identifies the environment to update. Set `display_name` and `filepath` on every\nupdate, even when they do not change. An update keeps the stored `base_environment_type`, but the YAML file is\nvalidated against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.", "required": true, "is_request_body_field": true, "entity": { @@ -136121,6 +136886,7 @@ "required_in_url_fields": [ { "name": "name", + "description": "The resource name of the workspace base environment to update.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -136131,7 +136897,7 @@ "required_request_body_fields": [ { "name": "workspace_base_environment", - "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "description": "The workspace base environment with its new configuration.\nThe `name` path parameter identifies the environment to update. Set `display_name` and `filepath` on every\nupdate, even when they do not change. An update keeps the stored `base_environment_type`, but the YAML file is\nvalidated against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.", "required": true, "is_request_body_field": true, "entity": { @@ -136143,7 +136909,7 @@ }, "request_body_field": { "name": "workspace_base_environment", - "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "description": "The workspace base environment with its new configuration.\nThe `name` path parameter identifies the environment to update. Set `display_name` and `filepath` on every\nupdate, even when they do not change. An update keeps the stored `base_environment_type`, but the YAML file is\nvalidated against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.", "required": true, "is_request_body_field": true, "entity": { @@ -136181,6 +136947,7 @@ "all_fields": [ { "name": "name", + "description": "The resource name of the workspace base environment to update.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -136189,7 +136956,7 @@ }, { "name": "workspace_base_environment", - "description": "Required. The workspace base environment with updated fields.\nThe name field is used to identify the environment to update.", + "description": "The workspace base environment with its new configuration.\nThe `name` path parameter identifies the environment to update. Set `display_name` and `filepath` on every\nupdate, even when they do not change. An update keeps the stored `base_environment_type`, but the YAML file is\nvalidated against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.", "required": true, "is_request_body_field": true, "entity": { @@ -136222,7 +136989,7 @@ }, { "name": "base_environment_type", - "description": "The type of base environment (CPU or GPU).", + "description": "The type of base environment (CPU or GPU). The default is `CPU`.", "is_request_body_field": true, "entity": { "pascal_name": "BaseEnvironmentType", @@ -136266,7 +137033,7 @@ }, { "name": "filepath", - "description": "The WSFS or UC Volumes path to the environment YAML file.", + "description": "The workspace file or Unity Catalog volume path to the YAML file that defines the environment version and\ndependencies. The file name must end in `.yaml` or `.yml`. Create and update requests must set this field.", "is_request_body_field": true, "entity": { "is_string": true @@ -136292,7 +137059,7 @@ }, { "name": "message", - "description": "Status message providing additional details about the environment status.", + "description": "Status message providing additional details about the environment status.\nWhen the status is `FAILED`, the message contains the build error.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -136301,7 +137068,7 @@ }, { "name": "name", - "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}", + "description": "The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\nThe server ignores this field on create and builds the name from `workspace_base_environment_id`, or from\n`display_name` plus a random suffix when no ID is given.", "is_request_body_field": true, "entity": { "is_string": true @@ -136309,7 +137076,7 @@ }, { "name": "spec", - "description": "The environment specification containing version and dependencies.", + "description": "The environment specification containing version and dependencies, read from the YAML file at `filepath`.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -136320,7 +137087,7 @@ }, { "name": "status", - "description": "The status of the materialized workspace base environment.", + "description": "The status of the materialized workspace base environment, which the server builds from the YAML file.\nThe status is `CREATED` once the build has succeeded.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -136361,6 +137128,7 @@ "required_positional_arguments": [ { "name": "name", + "description": "The resource name of the workspace base environment to update.\nFormat: workspace-base-environments/{workspace_base_environment}", "required": true, "is_path": true, "entity": { @@ -136625,7 +137393,7 @@ "required_fields": [ { "name": "name", - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "required": true, "is_request_body_field": true, "entity": { @@ -136636,7 +137404,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "required": true, "is_request_body_field": true, "entity": { @@ -136652,7 +137420,7 @@ "all_fields": [ { "name": "artifact_location", - "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", + "description": "URI of the location where the artifacts of the experiment's runs are stored, such as a Unity\nCatalog volume path of the form `dbfs:/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/\u003cpath\u003e`. The URI\nmust have a scheme other than `file` and must not point under the MLflow-managed prefix\n`dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed\nstorage. See https://docs.databricks.com/aws/en/mlflow/experiments for the supported\nlocations.", "is_request_body_field": true, "entity": { "is_string": true @@ -136660,7 +137428,7 @@ }, { "name": "name", - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "required": true, "is_request_body_field": true, "entity": { @@ -136669,7 +137437,7 @@ }, { "name": "tags", - "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", + "description": "Tags to set on the new experiment, as key-value pairs. A request can include at most 100\ntags.", "is_request_body_field": true, "entity": { "pascal_name": "ExperimentTagList", @@ -136693,7 +137461,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "required": true, "is_request_body_field": true, "entity": { @@ -137395,7 +138163,7 @@ }, { "name": "DeleteExperiment", - "description": "Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion.\nIf the experiment uses FileStore, artifacts associated with the experiment are also deleted.", + "description": "Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion.\nIf the experiment uses FileStore, artifacts associated with the experiment are also deleted.\nOnly workspace experiments can be deleted through this method.", "summary": "Delete an experiment.", "path": "/api/2.0/mlflow/experiments/delete", "can_use_json": true, @@ -138706,7 +139474,7 @@ }, { "name": "ListExperiments", - "description": "Gets a list of all experiments.", + "description": "Gets a list of all experiments, ordered by creation time with the newest first.", "summary": "List experiments.", "path": "/api/2.0/mlflow/experiments/list", "has_required_positional_arguments": true, @@ -138731,7 +139499,7 @@ }, { "name": "page_token", - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "is_query": true, "entity": { "is_string": true @@ -138761,7 +139529,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "is_query": true, "entity": { "is_string": true @@ -139413,7 +140181,7 @@ }, { "name": "RestoreExperiment", - "description": "Restore an experiment marked for deletion. This also restores\nassociated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying\nartifacts associated with experiment are also restored.\n\nThrows `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.", + "description": "Restore an experiment marked for deletion. This also restores\nassociated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying\nartifacts associated with experiment are also restored.\n\nOnly workspace experiments can be restored through this method.\n\nThrows `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.", "summary": "Restore an experiment.", "path": "/api/2.0/mlflow/experiments/restore", "can_use_json": true, @@ -139666,7 +140434,7 @@ "all_fields": [ { "name": "filter", - "description": "String representing a SQL filter condition (e.g. \"name ILIKE 'my-experiment%'\")", + "description": "Filter condition on the experiment name and tags. The `name` attribute and `tags.\u003ckey\u003e`\nsupport the operators `=`, `!=`, `LIKE` and `ILIKE` (case-insensitive `LIKE`), string values\nare wrapped in single quotes, and several conditions can be combined with `AND`. No wildcard\nis added automatically, so include `%` in a `LIKE` pattern where you need one.", "is_request_body_field": true, "entity": { "is_string": true @@ -139674,7 +140442,7 @@ }, { "name": "max_results", - "description": "Maximum number of experiments desired. Max threshold is 3000.", + "description": "Maximum number of experiments to return per page. Larger values are capped by the server, so\nuse `page_token` to retrieve further pages.", "is_request_body_field": true, "entity": { "is_int64": true @@ -139682,7 +140450,7 @@ }, { "name": "order_by", - "description": "List of columns for ordering search results, which can include experiment name and last updated\ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by experiment id DESC.", + "description": "Columns to order the results by, each given as `name`, `basename` (the last segment of the\nname), `experiment_id`, `creation_time` or `last_update_time` with an optional `ASC` or `DESC`\nsuffix, where `ASC` is the default. If omitted, results are ordered by last update time with\nthe most recently updated experiment first. Tiebreaks are done by experiment id DESC.", "is_request_body_field": true, "entity": { "pascal_name": "List", @@ -139693,7 +140461,7 @@ }, { "name": "page_token", - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "is_request_body_field": true, "entity": { "is_string": true @@ -139723,7 +140491,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "Token indicating the page of experiments to fetch", + "description": "Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.", "is_request_body_field": true, "entity": { "is_string": true @@ -140154,7 +140922,7 @@ }, { "name": "key", - "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "description": "Key of the tag. Keys are at most 255 characters long. Setting a key that already exists\nreplaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and\n`mlflow.experimentType` cannot be set.", "required": true, "is_request_body_field": true, "entity": { @@ -140163,7 +140931,7 @@ }, { "name": "value", - "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "description": "Value of the tag. Values are at most 65535 characters long.", "required": true, "is_request_body_field": true, "entity": { @@ -140183,7 +140951,7 @@ }, { "name": "key", - "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "description": "Key of the tag. Keys are at most 255 characters long. Setting a key that already exists\nreplaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and\n`mlflow.experimentType` cannot be set.", "required": true, "is_request_body_field": true, "entity": { @@ -140192,7 +140960,7 @@ }, { "name": "value", - "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "description": "Value of the tag. Values are at most 65535 characters long.", "required": true, "is_request_body_field": true, "entity": { @@ -140218,7 +140986,7 @@ }, { "name": "key", - "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "description": "Key of the tag. Keys are at most 255 characters long. Setting a key that already exists\nreplaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and\n`mlflow.experimentType` cannot be set.", "required": true, "is_request_body_field": true, "entity": { @@ -140227,7 +140995,7 @@ }, { "name": "value", - "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "description": "Value of the tag. Values are at most 65535 characters long.", "required": true, "is_request_body_field": true, "entity": { @@ -140247,7 +141015,7 @@ }, { "name": "key", - "description": "Name of the tag. Keys up to 250 bytes in size are supported.", + "description": "Key of the tag. Keys are at most 255 characters long. Setting a key that already exists\nreplaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and\n`mlflow.experimentType` cannot be set.", "required": true, "is_request_body_field": true, "entity": { @@ -140256,7 +141024,7 @@ }, { "name": "value", - "description": "String value of the tag being logged. Values up to 64KB in size are supported.", + "description": "Value of the tag. Values are at most 65535 characters long.", "required": true, "is_request_body_field": true, "entity": { @@ -140531,7 +141299,7 @@ }, { "name": "UpdateExperiment", - "description": "Updates experiment metadata.", + "description": "Updates experiment metadata. Only workspace experiments can be updated; a notebook experiment\ntakes its name from its notebook.", "summary": "Update an experiment.", "path": "/api/2.0/mlflow/experiments/update", "can_use_json": true, @@ -140582,7 +141350,7 @@ }, { "name": "new_name", - "description": "If provided, the experiment's name is changed to the new name. The new name must be unique.", + "description": "New name for the experiment, as an absolute path in the workspace. The new name must be\nunique.", "is_request_body_field": true, "entity": { "is_string": true @@ -142804,7 +143572,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -142813,7 +143581,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -142893,7 +143661,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -142904,7 +143672,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -142913,7 +143681,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -142993,7 +143761,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143010,7 +143778,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143019,7 +143787,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143099,7 +143867,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143110,7 +143878,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143119,7 +143887,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143199,7 +143967,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143220,7 +143988,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143229,7 +143997,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143309,7 +144077,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143320,7 +144088,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143329,7 +144097,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143409,7 +144177,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143421,7 +144189,7 @@ }, { "name": "columns", - "description": "List of columns associated with the external metadata object.", + "description": "Names of the columns of the object, used for column-level mappings in external lineage relationships.\nColumn names must be unique within the list, and the combined size of all column names is limited.", "is_request_body_field": true, "entity": { "pascal_name": "List", @@ -143450,7 +144218,7 @@ }, { "name": "description", - "description": "User-provided free-form text description.", + "description": "User-provided free-form text description of the object. The description must not exceed 5000 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -143458,7 +144226,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143467,7 +144235,7 @@ }, { "name": "id", - "description": "Unique identifier of the external metadata object.", + "description": "Unique identifier of the external metadata object. The ID is a UUID that the system assigns on creation.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -143485,7 +144253,7 @@ }, { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143494,7 +144262,7 @@ }, { "name": "owner", - "description": "Owner of the external metadata object.", + "description": "Owner of the external metadata object. Defaults to the creator. To change the owner, send an update whose\nupdate mask includes `owner`.", "is_request_body_field": true, "entity": { "is_string": true @@ -143502,7 +144270,7 @@ }, { "name": "properties", - "description": "A map of key-value properties attached to the external metadata object.", + "description": "Key-value properties attached to the object. Keys and values must be non-empty, and the combined length\nof all keys and values must not exceed 5000 characters.", "is_request_body_field": true, "entity": { "map_value": { @@ -143512,7 +144280,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143610,7 +144378,7 @@ }, { "name": "url", - "description": "URL associated with the external metadata object.", + "description": "URL of the object in the external system. When set, lineage graph viewers can follow it to the external\nasset. The URL must not exceed 2048 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -143620,7 +144388,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143629,7 +144397,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143709,7 +144477,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143720,7 +144488,7 @@ }, { "name": "DeleteExternalMetadata", - "description": "Deletes the external metadata object that matches the supplied name.\nThe caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.", + "description": "Deletes the external metadata object that matches the supplied name. Every external lineage relationship in\nwhich the object is the source or the target is deleted with it.\nThe caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.", "summary": "Delete an external metadata object.", "path": "/api/2.0/lineage-tracking/external-metadata/{name}", "has_required_positional_arguments": true, @@ -143734,6 +144502,7 @@ "required_fields": [ { "name": "name", + "description": "Name of the external metadata object to delete.", "required": true, "is_path": true, "entity": { @@ -143744,6 +144513,7 @@ "required_in_url_fields": [ { "name": "name", + "description": "Name of the external metadata object to delete.", "required": true, "is_path": true, "entity": { @@ -143758,6 +144528,7 @@ "all_fields": [ { "name": "name", + "description": "Name of the external metadata object to delete.", "required": true, "is_path": true, "entity": { @@ -143768,6 +144539,7 @@ "required_positional_arguments": [ { "name": "name", + "description": "Name of the external metadata object to delete.", "required": true, "is_path": true, "entity": { @@ -143793,6 +144565,7 @@ "required_fields": [ { "name": "name", + "description": "Name of the external metadata object to get.", "required": true, "is_path": true, "entity": { @@ -143803,6 +144576,7 @@ "required_in_url_fields": [ { "name": "name", + "description": "Name of the external metadata object to get.", "required": true, "is_path": true, "entity": { @@ -143818,7 +144592,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143827,7 +144601,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -143907,7 +144681,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -143918,7 +144692,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -143927,7 +144701,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144007,7 +144781,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144019,6 +144793,7 @@ "all_fields": [ { "name": "name", + "description": "Name of the external metadata object to get.", "required": true, "is_path": true, "entity": { @@ -144029,6 +144804,7 @@ "required_positional_arguments": [ { "name": "name", + "description": "Name of the external metadata object to get.", "required": true, "is_path": true, "entity": { @@ -144058,7 +144834,7 @@ "all_fields": [ { "name": "page_size", - "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000.", + "description": "Specifies the maximum number of external metadata objects to return in a single response.\nThe value must be less than or equal to 1000. Defaults to 1000 when omitted.", "is_query": true, "entity": { "is_int": true @@ -144104,7 +144880,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_path": true, "entity": { @@ -144122,7 +144898,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": "Comma-separated list of the fields to update, for example `description,properties`. Only the listed\nfields change. The other fields keep their current values. The mask must not be empty.", "required": true, "is_query": true, "entity": { @@ -144133,7 +144909,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_path": true, "entity": { @@ -144142,7 +144918,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": "Comma-separated list of the fields to update, for example `description,properties`. Only the listed\nfields change. The other fields keep their current values. The mask must not be empty.", "required": true, "is_query": true, "entity": { @@ -144173,7 +144949,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144182,7 +144958,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144262,7 +145038,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144273,7 +145049,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144282,7 +145058,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144362,7 +145138,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144379,7 +145155,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144388,7 +145164,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144468,7 +145244,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144479,7 +145255,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144488,7 +145264,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144568,7 +145344,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144589,7 +145365,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144598,7 +145374,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144678,7 +145454,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144689,7 +145465,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144698,7 +145474,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144778,7 +145554,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144790,7 +145566,7 @@ }, { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_path": true, "entity": { @@ -144799,7 +145575,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": "Comma-separated list of the fields to update, for example `description,properties`. Only the listed\nfields change. The other fields keep their current values. The mask must not be empty.", "required": true, "is_query": true, "entity": { @@ -144808,7 +145584,7 @@ }, { "name": "columns", - "description": "List of columns associated with the external metadata object.", + "description": "Names of the columns of the object, used for column-level mappings in external lineage relationships.\nColumn names must be unique within the list, and the combined size of all column names is limited.", "is_request_body_field": true, "entity": { "pascal_name": "List", @@ -144837,7 +145613,7 @@ }, { "name": "description", - "description": "User-provided free-form text description.", + "description": "User-provided free-form text description of the object. The description must not exceed 5000 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -144845,7 +145621,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -144854,7 +145630,7 @@ }, { "name": "id", - "description": "Unique identifier of the external metadata object.", + "description": "Unique identifier of the external metadata object. The ID is a UUID that the system assigns on creation.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -144872,7 +145648,7 @@ }, { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_request_body_field": true, "entity": { @@ -144881,7 +145657,7 @@ }, { "name": "owner", - "description": "Owner of the external metadata object.", + "description": "Owner of the external metadata object. Defaults to the creator. To change the owner, send an update whose\nupdate mask includes `owner`.", "is_request_body_field": true, "entity": { "is_string": true @@ -144889,7 +145665,7 @@ }, { "name": "properties", - "description": "A map of key-value properties attached to the external metadata object.", + "description": "Key-value properties attached to the object. Keys and values must be non-empty, and the combined length\nof all keys and values must not exceed 5000 characters.", "is_request_body_field": true, "entity": { "map_value": { @@ -144899,7 +145675,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -144997,7 +145773,7 @@ }, { "name": "url", - "description": "URL associated with the external metadata object.", + "description": "URL of the object in the external system. When set, lineage graph viewers can follow it to the external\nasset. The URL must not exceed 2048 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -145007,7 +145783,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the external metadata object.", + "description": "Name of the external metadata object. The name is unique within the metastore, must follow the\n[Unity Catalog naming requirements](https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements),\nand is stored in lowercase. It cannot be changed after creation, and external lineage relationships\nrefer to the object by this name.", "required": true, "is_path": true, "entity": { @@ -145016,7 +145792,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": "Comma-separated list of the fields to update, for example `description,properties`. Only the listed\nfields change. The other fields keep their current values. The mask must not be empty.", "required": true, "is_query": true, "entity": { @@ -145025,7 +145801,7 @@ }, { "name": "system_type", - "description": "Type of external system.", + "description": "Type of the external system that holds the object. Use `OTHER` for a system that is not in the list.", "required": true, "is_request_body_field": true, "entity": { @@ -145105,7 +145881,7 @@ }, { "name": "entity_type", - "description": "Type of entity within the external system.", + "description": "Type of the object within the external system, such as a table, a report, or a dashboard. The value is\nfree-form text of at most 255 characters.", "required": true, "is_request_body_field": true, "entity": { @@ -146764,6 +147540,17 @@ "is_object": true } }, + { + "name": "operations", + "description": "Operations associated with this materialized feature.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MaterializedFeatureOperations", + "is_object": true + } + }, { "name": "pipeline_id", "description": "The ID of the pipeline that materializes this feature. This is only present for streaming features.", @@ -150553,6 +151340,17 @@ "is_object": true } }, + { + "name": "operations", + "description": "Operations associated with this materialized feature.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MaterializedFeatureOperations", + "is_object": true + } + }, { "name": "pipeline_id", "description": "The ID of the pipeline that materializes this feature. This is only present for streaming features.", @@ -159881,7 +160679,7 @@ }, { "name": "is_default_for_provider", - "description": "if the credential is the default for the given provider", + "description": "Set to true to make the new credential the default for its Git provider, replacing the\ncurrent default. The first credential created for a provider becomes the default\nregardless of this value.", "is_request_body_field": true, "entity": { "is_bool": true @@ -159889,7 +160687,7 @@ }, { "name": "name", - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup. It must not\nexceed 100 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -159905,7 +160703,7 @@ }, { "name": "principal_id", - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal for which the credential will be created. Only service principal managers can perform this action.", "is_request_body_field": true, "entity": { "is_int64": true @@ -159975,7 +160773,7 @@ }, { "name": "principal_id", - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal whose credential will be deleted. Only service principal managers can perform this action.", "is_query": true, "entity": { "is_int64": true @@ -160068,7 +160866,7 @@ }, { "name": "principal_id", - "description": "The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action.", + "description": "The ID of the service principal whose credential will be returned. Only service principal managers can perform this action.", "is_query": true, "entity": { "is_int64": true @@ -160117,7 +160915,7 @@ }, { "name": "Update", - "description": "Updates the specified Git credential.", + "description": "Updates the specified Git credential.\nFields that are omitted keep their current values.", "summary": "Update a credential.", "path": "/api/2.0/git-credentials/{credential_id}", "can_use_json": true, @@ -160140,7 +160938,7 @@ }, { "name": "git_provider", - "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.\nMust match the Git provider of the existing credential; the provider cannot be changed.", "required": true, "is_request_body_field": true, "entity": { @@ -160162,7 +160960,7 @@ "required_request_body_fields": [ { "name": "git_provider", - "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.\nMust match the Git provider of the existing credential; the provider cannot be changed.", "required": true, "is_request_body_field": true, "entity": { @@ -160196,7 +160994,7 @@ }, { "name": "git_provider", - "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.\nMust match the Git provider of the existing credential; the provider cannot be changed.", "required": true, "is_request_body_field": true, "entity": { @@ -160213,7 +161011,7 @@ }, { "name": "is_default_for_provider", - "description": "if the credential is the default for the given provider", + "description": "Set to true to make this credential the default for its Git provider, replacing the\ncurrent default. Cannot be set to false; make another credential the default instead.", "is_request_body_field": true, "entity": { "is_bool": true @@ -160221,7 +161019,7 @@ }, { "name": "name", - "description": "the name of the git credential, used for identification and ease of lookup", + "description": "The name of the Git credential, used for identification and ease of lookup. It must not\nexceed 100 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -160256,7 +161054,7 @@ }, { "name": "git_provider", - "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.", + "description": "Git provider. This field is case-insensitive. The available Git providers are `gitHub`,\n`bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including\nMicrosoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket\nData Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.\nMust match the Git provider of the existing credential; the provider cannot be changed.", "required": true, "is_request_body_field": true, "entity": { @@ -161992,7 +162790,7 @@ "all_fields": [ { "name": "displayName", - "description": "String that represents a human-readable group name", + "description": "Sets the human-readable name of the group. The name must be unique within the account and must\nnot exceed 255 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -162000,6 +162798,7 @@ }, { "name": "externalId", + "description": "Sets the identifier of the group in an external identity provider.", "is_request_body_field": true, "entity": { "is_string": true @@ -162007,7 +162806,7 @@ }, { "name": "id", - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "is_request_body_field": true, "entity": { "is_string": true @@ -162015,6 +162814,7 @@ }, { "name": "members", + "description": "Lists the members of the group. Each entry identifies a user, service principal or group in the\naccount by its ID in the value sub-attribute.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -162036,7 +162836,7 @@ }, { "name": "roles", - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the group. The only supported role value is\n`account_admin`.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -162197,7 +162997,7 @@ }, { "name": "count", - "description": "Desired number of results per page. Default is 10000.", + "description": "Specifies the number of results per page. When omitted, the server uses its default page size.", "is_query": true, "entity": { "is_int64": true @@ -162263,7 +163063,7 @@ }, "limit": { "name": "count", - "description": "Desired number of results per page. Default is 10000.", + "description": "Specifies the number of results per page. When omitted, the server uses its default page size.", "is_query": true, "entity": { "is_int64": true @@ -162286,7 +163086,7 @@ "required_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a group in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -162297,7 +163097,7 @@ "required_in_url_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a group in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -162312,7 +163112,7 @@ "all_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a group in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -162321,6 +163121,7 @@ }, { "name": "Operations", + "description": "Lists the patch operations to apply to the group.", "is_request_body_field": true, "entity": { "pascal_name": "PatchList", @@ -162350,7 +163151,7 @@ "required_positional_arguments": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a group in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -162374,7 +163175,7 @@ "required_fields": [ { "name": "id", - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "required": true, "is_path": true, "entity": { @@ -162385,7 +163186,7 @@ "required_in_url_fields": [ { "name": "id", - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "required": true, "is_path": true, "entity": { @@ -162400,7 +163201,7 @@ "all_fields": [ { "name": "displayName", - "description": "String that represents a human-readable group name", + "description": "Sets the human-readable name of the group. The name must be unique within the account and must\nnot exceed 255 characters.", "is_request_body_field": true, "entity": { "is_string": true @@ -162408,6 +163209,7 @@ }, { "name": "externalId", + "description": "Sets the identifier of the group in an external identity provider.", "is_request_body_field": true, "entity": { "is_string": true @@ -162415,7 +163217,7 @@ }, { "name": "id", - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "required": true, "is_path": true, "entity": { @@ -162424,6 +163226,7 @@ }, { "name": "members", + "description": "Lists the members of the group. Each entry identifies a user, service principal or group in the\naccount by its ID in the value sub-attribute.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -162445,7 +163248,7 @@ }, { "name": "roles", - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the group. The only supported role value is\n`account_admin`.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -162459,7 +163262,7 @@ "required_positional_arguments": [ { "name": "id", - "description": "Databricks group ID", + "description": "Identifies the group within Databricks.", "required": true, "is_path": true, "entity": { @@ -162866,7 +163669,7 @@ }, { "name": "group_id", - "description": "The Databricks ID of the group.", + "description": "The Databricks ID of the group. It is a numeric string that Databricks assigns when the group\nis created, and it is the `{group_id}` segment of `name`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -162875,7 +163678,7 @@ }, { "name": "group_name", - "description": "The name of the group.", + "description": "The display name of the group. It must be unique in the account, must not be blank, and must be\nshorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of a\ngroup that Databricks manages, such as `admins` or `users`.", "is_request_body_field": true, "entity": { "is_string": true @@ -167161,7 +167964,7 @@ }, { "name": "group_id", - "description": "The Databricks ID of the group.", + "description": "The Databricks ID of the group. It is a numeric string that Databricks assigns when the group\nis created, and it is the `{group_id}` segment of `name`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -167170,7 +167973,7 @@ }, { "name": "group_name", - "description": "The name of the group.", + "description": "The display name of the group. It must be unique in the account, must not be blank, and must be\nshorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of a\ngroup that Databricks manages, such as `admins` or `users`.", "is_request_body_field": true, "entity": { "is_string": true @@ -171508,6 +172311,7 @@ }, { "name": "health", + "description": "An optional set of health rules that can be defined for this job.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -172856,7 +173660,7 @@ }, { "name": "job_parameters", - "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "description": "Job-level parameters used in the run, for example `\"param\": \"overriding_val\"`.", "is_request_body_field": true, "entity": { "map_value": { @@ -176868,7 +177672,7 @@ }, { "name": "CreateSchedule", - "description": "Create dashboard schedule.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", + "description": "Creates a schedule for a dashboard. The dashboard must be published before a schedule can be\ncreated for it.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", "summary": "Create dashboard schedule.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules", "can_use_json": true, @@ -176939,7 +177743,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -176951,7 +177755,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -176969,7 +177773,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -176981,7 +177785,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177014,7 +177818,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177026,7 +177830,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177049,7 +177853,7 @@ }, { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177069,7 +177873,7 @@ }, { "name": "display_name", - "description": "The display name for schedule.", + "description": "The name of the schedule, as shown in the dashboard's list of schedules.", "is_request_body_field": true, "entity": { "is_string": true @@ -177086,7 +177890,7 @@ }, { "name": "pause_status", - "description": "The status indicates whether this schedule is paused or not.", + "description": "Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but\nthe dashboard is not refreshed and no notifications are sent until the schedule is unpaused.", "is_request_body_field": true, "entity": { "pascal_name": "SchedulePauseStatus", @@ -177122,7 +177926,7 @@ }, { "name": "warehouse_id", - "description": "The warehouse id to run the dashboard with for the schedule.", + "description": "The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If\nomitted, the warehouse of the published dashboard is used.", "is_request_body_field": true, "entity": { "is_string": true @@ -177142,7 +177946,7 @@ }, { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177154,7 +177958,7 @@ }, { "name": "CreateSubscription", - "description": "Create schedule subscription.\n\nThe caller must be a workspace user with one of the following\n[entitlements](https://docs.databricks.com/security/auth/entitlements):\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", + "description": "Create schedule subscription. Subscribes a workspace user or a notification destination to the\nschedule, so that it receives a snapshot of the dashboard each time the schedule runs.\nSubscribing yourself requires CAN VIEW permission on the dashboard; subscribing another user or a\nnotification destination requires CAN EDIT. On dashboards published without embedded\ncredentials, you can only subscribe yourself. If the subscriber is already subscribed to the\nschedule, the existing subscription is returned.\n\nThe caller must be a workspace user with one of the following\n[entitlements](https://docs.databricks.com/security/auth/entitlements):\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", "summary": "Create schedule subscription.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions", "can_use_json": true, @@ -177245,7 +178049,7 @@ "required_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177257,7 +178061,7 @@ "required_request_body_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177275,7 +178079,7 @@ "required_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177287,7 +178091,7 @@ "required_request_body_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177330,7 +178134,7 @@ "required_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177342,7 +178146,7 @@ "required_request_body_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177385,7 +178189,7 @@ }, { "name": "etag", - "description": "The etag for the subscription. Must be left empty on create, can be optionally provided on delete\nto ensure that the subscription has not been deleted since the last read.", + "description": "The etag of the subscription. It must be left empty on create. It can be passed as the `etag`\nparameter of the delete method to make sure the subscription has not changed since it was read.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -177404,7 +178208,7 @@ }, { "name": "skip_notify", - "description": "Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.\nIf not defined, defaults to false in the backend to match the current behavior (refresh and notify)", + "description": "Whether the subscription is refresh-only. When true, each scheduled run refreshes the dashboard\ndata for the subscriber without sending a notification. Defaults to false. Refresh-only\nsubscriptions are only allowed on dashboards published without embedded credentials.", "is_request_body_field": true, "entity": { "is_bool": true @@ -177412,7 +178216,7 @@ }, { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177464,7 +178268,7 @@ }, { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -177476,7 +178280,7 @@ }, { "name": "DeleteSchedule", - "description": "Delete dashboard schedule.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", + "description": "Deletes a schedule together with all of its subscriptions.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", "summary": "Delete dashboard schedule.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}", "has_required_positional_arguments": true, @@ -177580,7 +178384,7 @@ }, { "name": "DeleteSubscription", - "description": "Delete schedule subscription.\n\nThe caller must be a workspace user with one of the following\n[entitlements](https://docs.databricks.com/security/auth/entitlements):\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", + "description": "Delete schedule subscription. The subscriber receives no further snapshots from the schedule.\nDeleting your own subscription requires CAN VIEW permission on the dashboard; deleting another\nuser's or a notification destination's subscription requires CAN EDIT.\n\nThe caller must be a workspace user with one of the following\n[entitlements](https://docs.databricks.com/security/auth/entitlements):\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", "summary": "Delete schedule subscription.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}/subscriptions/{subscription_id}", "has_required_positional_arguments": true, @@ -177592,7 +178396,7 @@ "required_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177601,7 +178405,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177621,7 +178425,7 @@ "required_in_url_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177630,7 +178434,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177654,7 +178458,7 @@ "all_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177663,7 +178467,7 @@ }, { "name": "etag", - "description": "The etag for the subscription. Can be optionally provided to ensure that the subscription has not been\nmodified since the last read.", + "description": "The etag of the subscription, as returned when it was read. If it is provided and no longer\nmatches, the request fails with ABORTED and the subscription is not deleted.", "is_query": true, "entity": { "is_string": true @@ -177671,7 +178475,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177691,7 +178495,7 @@ "required_positional_arguments": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177700,7 +178504,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177782,7 +178586,7 @@ }, { "name": "GetPublished", - "description": "Get the current published dashboard.\n\nThe caller must be a workspace user with one of the following entitlements:\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", + "description": "Get the current published dashboard. The request fails with NOT_FOUND if the dashboard has\nnever been published or has been unpublished.\n\nThe caller must be a workspace user with one of the following entitlements:\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", "summary": "Get published dashboard.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published", "is_crud_read": true, @@ -177902,7 +178706,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177914,7 +178718,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -177980,7 +178784,7 @@ "required_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -177989,7 +178793,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178009,7 +178813,7 @@ "required_in_url_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178018,7 +178822,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178043,7 +178847,7 @@ "required_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -178055,7 +178859,7 @@ "required_request_body_fields": [ { "name": "subscriber", - "description": "Subscriber details for users and destinations to be added as subscribers to the schedule.", + "description": "The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and\n`destination_subscriber` must be set.", "required": true, "is_request_body_field": true, "entity": { @@ -178068,7 +178872,7 @@ "all_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178077,7 +178881,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178097,7 +178901,7 @@ "required_positional_arguments": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscription belongs.", + "description": "UUID identifying the dashboard to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178106,7 +178910,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscription belongs.", + "description": "UUID identifying the schedule to which the subscription belongs.", "required": true, "is_path": true, "entity": { @@ -178206,7 +179010,7 @@ "required_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard to which the schedules belongs.", + "description": "UUID identifying the dashboard to which the schedules belong.", "required": true, "is_path": true, "entity": { @@ -178217,7 +179021,7 @@ "required_in_url_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard to which the schedules belongs.", + "description": "UUID identifying the dashboard to which the schedules belong.", "required": true, "is_path": true, "entity": { @@ -178233,7 +179037,7 @@ "all_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard to which the schedules belongs.", + "description": "UUID identifying the dashboard to which the schedules belong.", "required": true, "is_path": true, "entity": { @@ -178260,7 +179064,7 @@ "required_positional_arguments": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard to which the schedules belongs.", + "description": "UUID identifying the dashboard to which the schedules belong.", "required": true, "is_path": true, "entity": { @@ -178295,7 +179099,7 @@ "required_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscriptions belongs.", + "description": "UUID identifying the dashboard to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178304,7 +179108,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscriptions belongs.", + "description": "UUID identifying the schedule to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178315,7 +179119,7 @@ "required_in_url_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscriptions belongs.", + "description": "UUID identifying the dashboard to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178324,7 +179128,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscriptions belongs.", + "description": "UUID identifying the schedule to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178340,7 +179144,7 @@ "all_fields": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscriptions belongs.", + "description": "UUID identifying the dashboard to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178365,7 +179169,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscriptions belongs.", + "description": "UUID identifying the schedule to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178376,7 +179180,7 @@ "required_positional_arguments": [ { "name": "dashboard_id", - "description": "UUID identifying the dashboard which the subscriptions belongs.", + "description": "UUID identifying the dashboard to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178385,7 +179189,7 @@ }, { "name": "schedule_id", - "description": "UUID identifying the schedule which the subscriptions belongs.", + "description": "UUID identifying the schedule to which the subscriptions belong.", "required": true, "is_path": true, "entity": { @@ -178575,7 +179379,7 @@ }, { "name": "Revert", - "description": "Revert a dashboard's definition in draft mode to the last published version.", + "description": "Revert a dashboard's definition in draft mode to the last published version. The draft's\ndatasets, pages and widgets are replaced with those of the current published version, and the\nupdated draft is returned. The dashboard must have been published at least once; the published\nversion itself is not changed.", "summary": "Revert dashboard.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/revert", "can_use_json": true, @@ -178624,7 +179428,7 @@ }, { "name": "etag", - "description": "The etag for the dashboard. Optionally, it can be provided to verify that the dashboard\nhas not been modified from its last retrieval.", + "description": "The etag of the draft dashboard, as returned by the get dashboard API. When provided, the\nrequest fails with ABORTED if the draft has been modified since that etag was read.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -178708,7 +179512,7 @@ }, { "name": "Unpublish", - "description": "Unpublish the dashboard.", + "description": "Unpublish the dashboard. This deletes the published version, so viewers can no longer open\nit, and pauses the dashboard's schedules. The draft is not changed; publish it again to make\nthe dashboard available to viewers.", "summary": "Unpublish dashboard.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published", "has_required_positional_arguments": true, @@ -178991,7 +179795,7 @@ }, { "name": "UpdateSchedule", - "description": "Update dashboard schedule.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", + "description": "Updates a schedule. The request body replaces the stored schedule, so fields omitted from the\nbody are reset to their defaults.\n\nRequires the [Databricks SQL access](https://docs.databricks.com/security/auth/entitlements)\nentitlement. Grant Databricks SQL access in addition to Workspace access.", "summary": "Update dashboard schedule.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/schedules/{schedule_id}", "can_use_json": true, @@ -179081,7 +179885,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179093,7 +179897,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179111,7 +179915,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179123,7 +179927,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179156,7 +179960,7 @@ "required_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179168,7 +179972,7 @@ "required_request_body_fields": [ { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179201,7 +180005,7 @@ }, { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179221,7 +180025,7 @@ }, { "name": "display_name", - "description": "The display name for schedule.", + "description": "The name of the schedule, as shown in the dashboard's list of schedules.", "is_request_body_field": true, "entity": { "is_string": true @@ -179238,7 +180042,7 @@ }, { "name": "pause_status", - "description": "The status indicates whether this schedule is paused or not.", + "description": "Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but\nthe dashboard is not refreshed and no notifications are sent until the schedule is unpaused.", "is_request_body_field": true, "entity": { "pascal_name": "SchedulePauseStatus", @@ -179274,7 +180078,7 @@ }, { "name": "warehouse_id", - "description": "The warehouse id to run the dashboard with for the schedule.", + "description": "The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If\nomitted, the warehouse of the published dashboard is used.", "is_request_body_field": true, "entity": { "is_string": true @@ -179304,7 +180108,7 @@ }, { "name": "cron_schedule", - "description": "The cron expression describing the frequency of the periodic refresh for this schedule.", + "description": "The cron expression and time zone that define when the schedule runs.", "required": true, "is_request_body_field": true, "entity": { @@ -179329,7 +180133,7 @@ "methods": [ { "name": "GetPublishedDashboardTokenInfo", - "description": "Get a required authorization details and scopes of a published dashboard to mint an OAuth token.\n\nThe caller must be a workspace user with one of the following entitlements:\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", + "description": "Get the OAuth scope and authorization details needed to mint a token that is scoped to viewing\nthe published dashboard, for example to embed it in an external application. Pass the response\nfields, with `authorization_details` serialized as a JSON string, to the workspace OAuth token\nendpoint with the `client_credentials` grant to mint the token. See\n[Embedding for external users](https://docs.databricks.com/dashboards/share/embedding/external-embed).\n\nThe caller must be a workspace user with one of the following entitlements:\nWorkspace access, Databricks SQL access, or Consumer access.\n\nAccount-level users who are not members of the workspace cannot call this\nendpoint, even if the dashboard has been shared with them.", "summary": "Read information of a published dashboard to mint an OAuth token.", "path": "/api/2.0/lakeview/dashboards/{dashboard_id}/published/tokeninfo", "is_crud_read": true, @@ -179380,7 +180184,7 @@ }, { "name": "external_value", - "description": "Provided external value to be included in the custom claim.", + "description": "Value to carry in the token for this viewer, such as a tenant or region key. Dashboard dataset\nqueries can reference it as `__aibi_external_value` to filter data per viewer. The combined size\nof `external_value` and `external_viewer_id` must be less than 1 KB.", "is_query": true, "entity": { "is_string": true @@ -179388,7 +180192,7 @@ }, { "name": "external_viewer_id", - "description": "Provided external viewer id to be included in the custom claim.", + "description": "Identifier of the viewer in the external application. It is recorded in dashboard audit logs, so\nit should be unique per viewer and must not contain personally identifiable information.", "is_query": true, "entity": { "is_string": true @@ -179423,7 +180227,7 @@ "cli_launch_stage_display": "Beta", "list": { "request": { - "pascal_name": "ListDatasourcesRequest" + "pascal_name": "ListBuiltinParserVersionsRequest" } }, "methods": [ @@ -180033,6 +180837,713 @@ } ] }, + { + "name": "CreateParser", + "description": "Creates a parser and its first version in one call.", + "summary": "Create a parser.", + "path": "/api/2.0/lakewatch/parsers", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateParserRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parser", + "description": "The parser to create. `spec` and `description` become version 1.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Parser", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "parser", + "description": "The parser to create. `spec` and `description` become version 1.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Parser", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "parser", + "description": "The parser to create. `spec` and `description` become version 1.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Parser", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "Parser", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "parser", + "description": "The parser to create. `spec` and `description` become version 1.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Parser", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "When the parser was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The principal that created this parser. Each version records its own\n`created_by`.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Principal", + "is_object": true + } + }, + { + "name": "description", + "description": "Description of version 1. Accepted only by `CreateParser`; read a version's\ndescription with `GetParserVersion`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_catalog_name", + "description": "The current name of the parser's UC catalog. Tracks UC renames; when the\ncurrent name cannot be looked up, the name as of the parser's last write.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_schema_name", + "description": "The current name of the parser's UC schema. Tracks UC renames; when the\ncurrent name cannot be looked up, the name as of the parser's last write.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "latest_version", + "description": "Newest version of this parser. Read its spec by passing this to\n`GetParserVersion`, or by using the `latest` alias. Absent when every version\nhas been deleted.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "name", + "description": "Resource name. Format: `parsers/{parser_id}`, where the leaf is the\nimmutable server-assigned UUID. Create-time placement names are stored\nseparately and do not affect the resource name.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "The principal that owns this parser. Server-set from the authenticated\ncreator, never supplied by the client. Beta reads by UUID perform no\nauthorization. Owner-gated write RPCs are outside this API's current\nimplementation scope.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Principal", + "is_object": true + } + }, + { + "name": "parser_id", + "description": "The parser's server-assigned UUID. It is not currently a UC securable ID,\nis immutable for the life of the resource, is the leaf of `name`, and is\nreturned by CreateParser.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "CreateParserVersion", + "description": "Appends a new immutable version, advancing the parser's latest-version\npointer. This is how a parser is edited; versions are never\nchanged in place.", + "summary": "Create a parser version.", + "path": "/api/2.0/lakewatch/{parent=parsers/*}/versions", + "can_use_json": true, + "is_crud_create": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "CreateParserVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the parser to append a version to. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_version", + "description": "The version to append.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ParserVersion", + "is_object": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the parser to append a version to. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "parser_version", + "description": "The version to append.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ParserVersion", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "parser_version", + "description": "The version to append.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ParserVersion", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + "response": { + "pascal_name": "ParserVersion", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "parent", + "description": "Resource name of the parser to append a version to. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_version", + "description": "The version to append.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "ParserVersion", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + } + }, + { + "name": "create_time", + "description": "When this version was appended.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "The principal that appended this version.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "Principal", + "is_object": true + } + }, + { + "name": "description", + "description": "Free-form description of this version, set when the version is created.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name. Format:\n`parsers/{parser_id}/versions/{version}`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "The parent parser's name, copied from the container on read. Denormalized so a\ncaller that needs identity alongside the spec reads the version alone rather\nthan the container as well. Populated by `GetParserVersion`; List omits it, as\nList omits `spec`.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "version", + "description": "Version number, assigned by the server when the version is appended.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the parser to append a version to. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "CreateRule", "description": "Creates a new rule.", @@ -181100,6 +182611,130 @@ } ] }, + { + "name": "DeleteParser", + "description": "Deletes a parser and all of its versions. Refused while any\ndata source references it.", + "summary": "Delete a parser.", + "path": "/api/2.0/lakewatch/{name=parsers/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteParserRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "DeleteParserVersion", + "description": "Deletes one version of a parser. Returns NOT_FOUND when the parser or the\nversion does not exist, and a conflict (HTTP 409) only while a data source\nreferences the version. Deleting the last version leaves the parser in place\nwith no versions.", + "summary": "Delete a parser version.", + "path": "/api/2.0/lakewatch/{name=parsers/*/versions/*}", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "DeleteParserVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is a version number written without sign or leading zeros,\nsuch as `3`. Unlike GetParserVersion, the alias `latest` and forms such as\n`007` or `+3` are rejected, so a delete always names one fixed version.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is a version number written without sign or leading zeros,\nsuch as `3`. Unlike GetParserVersion, the alias `latest` and forms such as\n`007` or `+3` are rejected, so a delete always names one fixed version.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "is_empty_response": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is a version number written without sign or leading zeros,\nsuch as `3`. Unlike GetParserVersion, the alias `latest` and forms such as\n`007` or `+3` are rejected, so a delete always names one fixed version.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is a version number written without sign or leading zeros,\nsuch as `3`. Unlike GetParserVersion, the alias `latest` and forms such as\n`007` or `+3` are rejected, so a delete always names one fixed version.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "DeleteRule", "description": "Deletes a rule by its resource name.", @@ -181222,6 +182857,134 @@ } ] }, + { + "name": "GetBuiltinParser", + "description": "Returns a built-in parser's identity and latest-version\npointer. Does not return the spec.", + "summary": "Get a built-in parser.", + "path": "/api/2.0/lakewatch/{name=builtin-parsers/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetBuiltinParserRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name. Format: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name. Format: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "BuiltinParser", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name. Format: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name. Format: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetBuiltinParserVersion", + "description": "Returns one version of a built-in parser, including its spec.", + "summary": "Get a built-in parser version.", + "path": "/api/2.0/lakewatch/{name=builtin-parsers/*/versions/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetBuiltinParserVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`builtin-parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`builtin-parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "BuiltinParserVersion", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`builtin-parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`builtin-parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "GetCommonConfig", "description": "Returns the common Lakewatch configuration for a catalog.", @@ -181481,6 +183244,234 @@ } ] }, + { + "name": "GetParser", + "description": "Returns a parser's identity and latest-version pointer. Does\nnot return the spec; read a spec with GetParserVersion.", + "summary": "Get a parser.", + "path": "/api/2.0/lakewatch/{name=parsers/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetParserRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Parser", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog, set on create. Reads return the value as\nsupplied; the current UC catalog name is reported in\n`effective_catalog_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema, set on create. Reads return the value as\nsupplied; the current UC schema name is reported in `effective_schema_name`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parser_name", + "description": "Client-supplied parser name, stored as supplied and fixed at create time.\nMust be a valid UC identifier. A custom parser is not currently a UC securable\nand this field has no rename path.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "spec", + "description": "Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read\na version's spec with `GetParserVersion`.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the parser. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetParserVersion", + "description": "Returns one version of a parser, including its spec.", + "summary": "Get a parser version.", + "path": "/api/2.0/lakewatch/{name=parsers/*/versions/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetParserVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`. `latest`\nis NOT_FOUND when every version of the parser has been deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`. `latest`\nis NOT_FOUND when every version of the parser has been deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ParserVersion", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "spec", + "description": "The field definitions for this log source, as a YAML document. Validated on\nwrite, so an invalid spec is never stored.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`. `latest`\nis NOT_FOUND when every version of the parser has been deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the version. Format:\n`parsers/{parser_id}/versions/{version}`,\nwhere `{version}` is either a version number or the alias `latest`. `latest`\nis NOT_FOUND when every version of the parser has been deleted.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "GetRule", "description": "Returns a single rule by its resource name.", @@ -181768,6 +183759,154 @@ } ] }, + { + "name": "ListBuiltinParserVersions", + "description": "Lists a built-in parser's published versions, oldest first\n(ascending 1..resource_revision), without their specs.", + "summary": "List built-in parser versions.", + "path": "/api/2.0/lakewatch/{parent=builtin-parsers/*}/versions", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListBuiltinParserVersionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the built-in parser whose versions are listed.\nFormat: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the built-in parser whose versions are listed.\nFormat: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListBuiltinParserVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of results to return in one page. If unset or 0, at most 100 versions\nare returned. The maximum allowed value is 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous `ListBuiltinParserVersions` response, used to fetch the\nnext page of results.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Resource name of the built-in parser whose versions are listed.\nFormat: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the built-in parser whose versions are listed.\nFormat: `builtin-parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous `ListBuiltinParserVersions` response, used to fetch the\nnext page of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListBuiltinParsers", + "description": "Lists the built-in parsers Databricks publishes, without their\nspecs.", + "summary": "List built-in parsers.", + "path": "/api/2.0/lakewatch/builtin-parsers", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListBuiltinParsersRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListBuiltinParsersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "filter", + "description": "AIP-160 filter expression. Built-ins are filterable by their `tags`; the\nexact tag-filter grammar is defined by the server.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous `ListBuiltinParsers` response, used to fetch the next\npage of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous `ListBuiltinParsers` response, used to fetch the next\npage of results.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, { "name": "ListDatasources", "description": "Lists the datasources in a Unity Catalog catalog, optionally narrowed to one schema or\nfiltered by name. Results are paginated. Datasources that are still being created or\ndeleted are not listed.", @@ -181889,6 +184028,204 @@ } } }, + { + "name": "ListParserVersions", + "description": "Lists a parser's versions, oldest first, without their specs.", + "summary": "List parser versions.", + "path": "/api/2.0/lakewatch/{parent=parsers/*}/versions", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListParserVersionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the parser whose versions are listed. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the parser whose versions are listed. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListParserVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous `ListParserVersions` response, used to fetch the next\npage of results. Send the same `parent` when requesting later pages; a token from a\nrequest for a different parser is rejected.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Resource name of the parser whose versions are listed. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the parser whose versions are listed. Format:\n`parsers/{parser_id}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous `ListParserVersions` response, used to fetch the next\npage of results. Send the same `parent` when requesting later pages; a token from a\nrequest for a different parser is rejected.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListParsers", + "description": "Lists parsers in a catalog, without their specs.", + "summary": "List parsers.", + "path": "/api/2.0/lakewatch/parsers", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListParsersRequest", + "is_object": true, + "required_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog to list parsers from. Required:\nList is scoped to a single catalog, mirroring the Unity Catalog\ntables/functions APIs, which take catalog_name as a request field (bound to\na query parameter) rather than a catalog path segment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog to list parsers from. Required:\nList is scoped to a single catalog, mirroring the Unity Catalog\ntables/functions APIs, which take catalog_name as a request field (bound to\na query parameter) rather than a catalog path segment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListParsersResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog to list parsers from. Required:\nList is scoped to a single catalog, mirroring the Unity Catalog\ntables/functions APIs, which take catalog_name as a request field (bound to\na query parameter) rather than a catalog path segment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "filter", + "description": "AIP-160 filter expression. Parsers are filterable by `parser_name`.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "page_size", + "description": "Maximum number of results to return in one page. This is a best-effort upper\nbound, not a guarantee: the server may return fewer items than requested (even\nzero) while more results still exist. If unset or 0, the server picks a default.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Page token from a previous `ListParsers` response, used to fetch the next page of\nresults. Send the other request fields unchanged when requesting later pages; a\ntoken from a request with different fields is rejected.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "schema_name", + "description": "Name of the parent UC schema. Optional: when set, results are narrowed to\nthis schema; when omitted, parsers across all schemas in\n`catalog_name` are returned.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "catalog_name", + "description": "Name of the parent UC catalog to list parsers from. Required:\nList is scoped to a single catalog, mirroring the Unity Catalog\ntables/functions APIs, which take catalog_name as a request field (bound to\na query parameter) rather than a catalog path segment.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Page token from a previous `ListParsers` response, used to fetch the next page of\nresults. Send the other request fields unchanged when requesting later pages; a\ntoken from a request with different fields is rejected.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, { "name": "ListRules", "description": "Lists rules, with optional filtering and pagination.", @@ -184716,7 +187053,7 @@ "methods": [ { "name": "AllClusterStatuses", - "description": "Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster\nvia the API or the libraries UI.", + "description": "Get the status of all libraries on all clusters in the workspace. A status is returned for all libraries\ninstalled on each cluster via the API or the libraries UI. If the workspace has more library statuses than\nthe response limit allows, the request fails; call the per-cluster status method for each cluster instead.", "summary": "Get all statuses.", "path": "/api/2.0/libraries/all-cluster-statuses", "is_legacy_empty_request": true, @@ -184734,7 +187071,7 @@ }, { "name": "ClusterStatus", - "description": "Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API\nor the libraries UI.\nThe order of returned libraries is as follows:\n1. Libraries set to be installed on this cluster, in the order that the libraries were added\nto the cluster, are returned first.\n2. Libraries that were previously requested to be installed on this cluster or,\nbut are now marked for removal, in no particular order, are returned last.", + "description": "Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API\nor the libraries UI.\nThe order of returned libraries is as follows:\n1. Libraries set to be installed on this cluster, in the order that the libraries were added\nto the cluster, are returned first.\n2. Libraries that were previously requested to be installed on this cluster but are now\nmarked for removal, in no particular order, are returned last.", "summary": "Get status.", "path": "/api/2.0/libraries/cluster-status", "has_required_positional_arguments": true, @@ -188990,7 +191327,7 @@ "required_fields": [ { "name": "name", - "description": "Register model under this name", + "description": "Name of the existing registered model to create the version under.", "required": true, "is_request_body_field": true, "entity": { @@ -188999,7 +191336,7 @@ }, { "name": "source", - "description": "URI indicating the location of the model artifacts.", + "description": "URI of the model artifacts to register, such as the artifact path of an MLflow run or a\n`models:/\u003cmodel_name\u003e/\u003cversion\u003e` URI of an existing `READY` model version. The registry copies\nthe artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.", "required": true, "is_request_body_field": true, "entity": { @@ -189010,7 +191347,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Register model under this name", + "description": "Name of the existing registered model to create the version under.", "required": true, "is_request_body_field": true, "entity": { @@ -189019,7 +191356,7 @@ }, { "name": "source", - "description": "URI indicating the location of the model artifacts.", + "description": "URI of the model artifacts to register, such as the artifact path of an MLflow run or a\n`models:/\u003cmodel_name\u003e/\u003cversion\u003e` URI of an existing `READY` model version. The registry copies\nthe artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.", "required": true, "is_request_body_field": true, "entity": { @@ -189035,7 +191372,7 @@ "all_fields": [ { "name": "description", - "description": "Optional description for model version.", + "description": "Description of the model version.", "is_request_body_field": true, "entity": { "is_string": true @@ -189043,7 +191380,7 @@ }, { "name": "name", - "description": "Register model under this name", + "description": "Name of the existing registered model to create the version under.", "required": true, "is_request_body_field": true, "entity": { @@ -189052,7 +191389,7 @@ }, { "name": "run_id", - "description": "MLflow run ID for correlation, if `source` was generated by an experiment run in\nMLflow tracking server", + "description": "ID of the MLflow run that produced the model artifacts, if `source` comes from a run in the\nMLflow tracking server. The ID is at most 32 characters long.", "is_request_body_field": true, "entity": { "is_string": true @@ -189068,7 +191405,7 @@ }, { "name": "source", - "description": "URI indicating the location of the model artifacts.", + "description": "URI of the model artifacts to register, such as the artifact path of an MLflow run or a\n`models:/\u003cmodel_name\u003e/\u003cversion\u003e` URI of an existing `READY` model version. The registry copies\nthe artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.", "required": true, "is_request_body_field": true, "entity": { @@ -189077,7 +191414,7 @@ }, { "name": "tags", - "description": "Additional metadata for model version.", + "description": "Tags to set on the new model version.", "is_request_body_field": true, "entity": { "pascal_name": "ModelVersionTagList", @@ -189091,7 +191428,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Register model under this name", + "description": "Name of the existing registered model to create the version under.", "required": true, "is_request_body_field": true, "entity": { @@ -189100,7 +191437,7 @@ }, { "name": "source", - "description": "URI indicating the location of the model artifacts.", + "description": "URI of the model artifacts to register, such as the artifact path of an MLflow run or a\n`models:/\u003cmodel_name\u003e/\u003cversion\u003e` URI of an existing `READY` model version. The registry copies\nthe artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.", "required": true, "is_request_body_field": true, "entity": { @@ -191112,7 +193449,7 @@ "all_fields": [ { "name": "filter", - "description": "String filter condition, like \"name='my-model-name'\". Must be a single boolean condition,\nwith string values wrapped in single quotes.", + "description": "Filter condition on `name`, `run_id`, `source` or `tags.\u003ckey\u003e`. The filter must constrain at\nleast one of `name`, `run_id` or `source`. Conditions use `=`, `!=`, `LIKE` or `ILIKE`, and\n`run_id` also supports `IN`. String values are wrapped in single quotes, and several\nconditions can be combined with `AND`.", "is_query": true, "entity": { "is_string": true @@ -191128,7 +193465,7 @@ }, { "name": "order_by", - "description": "List of columns to be ordered by including model name, version, stage with an\noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", + "description": "Columns to order the results by, each given as `name`, `version`, `current_stage` or\n`last_updated_timestamp` with an optional `ASC` or `DESC` suffix, where `ASC` is the default.\nTiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by\nversion DESC.", "is_query": true, "entity": { "pascal_name": "List", @@ -192066,7 +194403,7 @@ }, { "name": "UpdateModelVersion", - "description": "Updates the model version.", + "description": "Updates the description of a model version.", "summary": "Update model version.", "path": "/api/2.0/mlflow/model-versions/update", "can_use_json": true, @@ -192125,7 +194462,7 @@ "all_fields": [ { "name": "description", - "description": "If provided, updates the description for this `registered_model`.", + "description": "New description for the model version.", "is_request_body_field": true, "entity": { "is_string": true @@ -203908,7 +206245,7 @@ }, { "name": "database_id", - "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf database_id is not specified in the request, it is generated automatically.", + "description": "The ID used to identify and manage the Database resource through the API.\nThe Postgres database name is specified in `spec.postgres_database`.\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 database_id is not specified in the request, it is generated automatically.", "is_query": true, "entity": { "is_string": true @@ -203925,7 +206262,7 @@ }, { "name": "replace_existing", - "description": "If true, update the database if it already exists instead of returning an\nerror.", + "description": "If true, update the database if it already exists instead of returning an\nerror. This requires `database_id` to be set. Without `database_id`, the request\nfollows the normal create path and fails if the database name already exists.", "is_query": true, "entity": { "is_bool": true @@ -204359,9 +206696,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -204400,9 +206734,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -204457,9 +206788,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -204498,9 +206826,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -204571,9 +206896,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -204701,9 +207023,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -205142,7 +207461,7 @@ }, { "name": "CreateSnapshot", - "description": "Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.", + "description": "Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.\nReturns a long-running operation. Poll it until done is true; its response holds the new\nsnapshot.", "summary": "Create a Snapshot.", "path": "/api/2.0/postgres/{parent=projects/*}/snapshots", "can_use_json": true, @@ -205166,7 +207485,7 @@ }, { "name": "snapshot", - "description": "The snapshot to create.", + "description": "The snapshot to create. Only `spec` is read from this message; the system\nsets the other fields.", "required": true, "is_request_body_field": true, "entity": { @@ -205176,7 +207495,7 @@ }, { "name": "snapshot_id", - "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation.", + "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation. The ID must be\n3 to 63 characters long, start with a lowercase letter, end with a\nlowercase letter or digit, and contain only lowercase letters, digits, and\nhyphens.", "required": true, "is_query": true, "entity": { @@ -205196,7 +207515,7 @@ }, { "name": "snapshot_id", - "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation.", + "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation. The ID must be\n3 to 63 characters long, start with a lowercase letter, end with a\nlowercase letter or digit, and contain only lowercase letters, digits, and\nhyphens.", "required": true, "is_query": true, "entity": { @@ -205207,7 +207526,7 @@ "required_request_body_fields": [ { "name": "snapshot", - "description": "The snapshot to create.", + "description": "The snapshot to create. Only `spec` is read from this message; the system\nsets the other fields.", "required": true, "is_request_body_field": true, "entity": { @@ -205219,7 +207538,7 @@ }, "request_body_field": { "name": "snapshot", - "description": "The snapshot to create.", + "description": "The snapshot to create. Only `spec` is read from this message; the system\nsets the other fields.", "required": true, "is_request_body_field": true, "entity": { @@ -205243,7 +207562,7 @@ }, { "name": "snapshot", - "description": "The snapshot to create.", + "description": "The snapshot to create. Only `spec` is read from this message; the system\nsets the other fields.", "required": true, "is_request_body_field": true, "entity": { @@ -205253,7 +207572,7 @@ }, { "name": "snapshot_id", - "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation.", + "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation. The ID must be\n3 to 63 characters long, start with a lowercase letter, end with a\nlowercase letter or digit, and contain only lowercase letters, digits, and\nhyphens.", "required": true, "is_query": true, "entity": { @@ -205289,7 +207608,7 @@ }, { "name": "spec", - "description": "Client-provided configuration of the snapshot.", + "description": "Client-provided configuration of the snapshot. When you create a snapshot,\nset exactly one of `expire_time`, `ttl`, or `no_expiry`.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -205330,7 +207649,7 @@ }, { "name": "snapshot_id", - "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation.", + "description": "Client-chosen ID for the snapshot. It becomes the final segment of the\nsnapshot resource name and cannot be changed after creation. The ID must be\n3 to 63 characters long, start with a lowercase letter, end with a\nlowercase letter or digit, and contain only lowercase letters, digits, and\nhyphens.", "required": true, "is_query": true, "entity": { @@ -205351,7 +207670,7 @@ }, { "name": "CreateSyncedTable", - "description": "Create a Synced Table.", + "description": "Create a Synced Table. Creates the synced table in Unity Catalog and the Postgres table on the\nbranch, and starts the pipeline that loads the initial data from the source table.", "summary": "Create a Synced Database Table.", "path": "/api/2.0/postgres/synced_tables", "can_use_json": true, @@ -205366,6 +207685,7 @@ "required_fields": [ { "name": "synced_table", + "description": "The synced table to create. Its configuration is read from spec, and its name comes from\nsynced_table_id.", "required": true, "is_request_body_field": true, "entity": { @@ -205397,6 +207717,7 @@ "required_request_body_fields": [ { "name": "synced_table", + "description": "The synced table to create. Its configuration is read from spec, and its name comes from\nsynced_table_id.", "required": true, "is_request_body_field": true, "entity": { @@ -205408,6 +207729,7 @@ }, "request_body_field": { "name": "synced_table", + "description": "The synced table to create. Its configuration is read from spec, and its name comes from\nsynced_table_id.", "required": true, "is_request_body_field": true, "entity": { @@ -205422,6 +207744,7 @@ "all_fields": [ { "name": "synced_table", + "description": "The synced table to create. Its configuration is read from spec, and its name comes from\nsynced_table_id.", "required": true, "is_request_body_field": true, "entity": { @@ -205440,6 +207763,7 @@ }, { "name": "create_time", + "description": "The time when the synced table was created.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -205449,7 +207773,7 @@ }, { "name": "name", - "description": "Output only. The Full resource name of the synced table in Postgres\nwhere (catalog, schema, table) are the UC entity names.\n\nFormat \"synced_tables/{catalog}.{schema}.{table}\"\n\nFor the corresponding source table in the Unity catalog look for the \"source_table_full_name\" attribute.", + "description": "The full resource name of the synced table, where (catalog, schema, table) are the Unity Catalog\nnames of the synced table.\n\nFormat: \"synced_tables/{catalog}.{schema}.{table}\".\n\nFor the corresponding source table in Unity Catalog, look for the \"source_table_full_name\" attribute.", "is_request_body_field": true, "entity": { "is_string": true @@ -205478,7 +207802,7 @@ }, { "name": "synced_table_id", - "description": "The part of the name, chosen by the user when the resource was created.", + "description": "The three-part Unity Catalog name of the synced table, in the format \"{catalog}.{schema}.{table}\".\nIt is the synced_table_id that was used to create the synced table and the last component of name.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -205830,7 +208154,7 @@ }, { "name": "DeleteDatabase", - "description": "Delete a Database.", + "description": "Deletes the specified Postgres database.", "summary": "Delete a Database.", "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", "has_required_positional_arguments": true, @@ -206210,7 +208534,7 @@ }, { "name": "DeleteSnapshot", - "description": "Deletes the specified snapshot.", + "description": "Deletes the specified snapshot. A deleted snapshot cannot be recovered. Returns a long-running\noperation. Poll it until done is true.", "summary": "Delete a Snapshot.", "path": "/api/2.0/postgres/{name=projects/*/snapshots/*}", "has_required_positional_arguments": true, @@ -206283,7 +208607,7 @@ }, { "name": "DeleteSyncedTable", - "description": "Delete a Synced Table.", + "description": "Delete a Synced Table. Drops the Postgres table, removes the synced table from its pipeline, and\ndeletes it from Unity Catalog. The pipeline itself is deleted when no other synced table uses it.", "summary": "Delete a Synced Database Table.", "path": "/api/2.0/postgres/{name=synced_tables/*}", "has_required_positional_arguments": true, @@ -206895,7 +209219,7 @@ }, { "name": "GetDatabase", - "description": "Get a Database.", + "description": "Retrieves information about the specified Postgres database.", "summary": "Get a Database.", "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", "is_crud_read": true, @@ -207090,9 +209414,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -207131,9 +209452,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -207906,7 +210224,7 @@ }, { "name": "ListDatabases", - "description": "List Databases.", + "description": "Returns a list of Postgres databases in the branch.", "summary": "List postgres databases in a branch.", "path": "/api/2.0/postgres/{parent=projects/*/branches/*}/databases", "has_required_positional_arguments": true, @@ -209167,7 +211485,7 @@ }, { "name": "UpdateDatabase", - "description": "Update a Database.", + "description": "Updates the specified Postgres database. Only the fields named in `update_mask` change.", "summary": "Update a Database.", "path": "/api/2.0/postgres/{name=projects/*/branches/*/databases/*}", "can_use_json": true, @@ -209201,7 +211519,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "description": "The list of fields to update. The updatable fields are `spec.role` and\n`spec.postgres_database`.", "required": true, "is_query": true, "entity": { @@ -209221,7 +211539,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "description": "The list of fields to update. The updatable fields are `spec.role` and\n`spec.postgres_database`.", "required": true, "is_query": true, "entity": { @@ -209278,7 +211596,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "description": "The list of fields to update. The updatable fields are `spec.role` and\n`spec.postgres_database`.", "required": true, "is_query": true, "entity": { @@ -209365,7 +211683,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update.", + "description": "The list of fields to update. The updatable fields are `spec.role` and\n`spec.postgres_database`.", "required": true, "is_query": true, "entity": { @@ -209732,9 +212050,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -209773,9 +212088,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -209830,9 +212142,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -209871,9 +212180,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -209953,9 +212259,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -210092,9 +212395,6 @@ "enum": [ { "content": "MIGRATION_TYPE_ONE_TIME_COPY" - }, - { - "content": "MIGRATION_TYPE_ONLINE" } ] } @@ -215288,6 +217588,14 @@ "is_string": true } }, + { + "name": "skill_max_results", + "description": "Maximum number of skills to return.", + "is_query": true, + "entity": { + "is_int": true + } + }, { "name": "table_max_results", "description": "Maximum number of tables to return.", @@ -219236,7 +221544,7 @@ "all_fields": [ { "name": "filter_by", - "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", + "description": "An optional filter object to limit query history results. Accepts parameters such as user IDs, warehouse IDs, and statuses to narrow the returned data.\nIn a URL, the parameters of this filter are specified with dot notation. For example: `filter_by.statement_ids`.", "is_query": true, "is_optional_object": true, "entity": { @@ -219254,7 +221562,7 @@ }, { "name": "max_results", - "description": "Limit the number of results returned in one page. Must be less than 1000 and the default is 100.", + "description": "Limit the number of results returned in one page. Must be no more than 1000; the default is 100.", "is_query": true, "entity": { "is_int": true @@ -219262,7 +221570,7 @@ }, { "name": "page_token", - "description": "A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", + "description": "A token that can be used to get the next page of results. The token can contain characters that need to be encoded before using it in a URL.\nFor example, the character '+' needs to be replaced by %2B. This field is optional.", "is_query": true, "entity": { "is_string": true @@ -225325,7 +227633,7 @@ }, { "name": "custom_max_retention_hours", - "description": "Custom maximum retention period in hours for the schema.", + "description": "Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "is_request_body_field": true, "entity": { "is_int64": true @@ -225352,7 +227660,7 @@ }, { "name": "storage_root", - "description": "Storage root URL for managed tables within schema.", + "description": "Managed tables and volumes in the schema are stored under this storage root URL. The path must be\ninside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted,\nmanaged data is stored under the parent catalog's storage root, or under the metastore's root storage\nlocation when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and\nschemas in a federated Hive metastore catalog must set one.", "is_request_body_field": true, "entity": { "is_string": true @@ -225394,7 +227702,7 @@ "required_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225405,7 +227713,7 @@ "required_in_url_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225430,7 +227738,7 @@ }, { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225441,7 +227749,7 @@ "required_positional_arguments": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225465,7 +227773,7 @@ "required_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225476,7 +227784,7 @@ "required_in_url_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225492,7 +227800,7 @@ "all_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225501,7 +227809,7 @@ }, { "name": "include_browse", - "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "description": "Whether to return the schema when the principal can only access selective metadata for it through the\nBROWSE privilege. The response then has browse_only set to true.", "is_query": true, "entity": { "is_bool": true @@ -225511,7 +227819,7 @@ "required_positional_arguments": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225570,7 +227878,7 @@ }, { "name": "include_browse", - "description": "Whether to include schemas in the response for which the principal can only access selective metadata for", + "description": "Whether to include schemas for which the principal can only access selective metadata through the\nBROWSE privilege. Such schemas are returned with browse_only set to true.", "is_query": true, "entity": { "is_bool": true @@ -225640,7 +227948,7 @@ "required_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225651,7 +227959,7 @@ "required_in_url_fields": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225675,7 +227983,7 @@ }, { "name": "custom_max_retention_hours", - "description": "Custom maximum retention period in hours for the schema.", + "description": "Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "is_request_body_field": true, "entity": { "is_int64": true @@ -225683,7 +227991,7 @@ }, { "name": "enable_predictive_optimization", - "description": "Whether predictive optimization should be enabled for this object and objects under it.", + "description": "Whether predictive optimization is enabled for this schema and the objects under it. Valid values are\nENABLE, DISABLE, and INHERIT, where INHERIT applies the parent catalog's setting. New schemas start as\nINHERIT. It cannot be set when creating a schema; use the update method instead.", "is_request_body_field": true, "entity": { "pascal_name": "EnablePredictiveOptimization", @@ -225702,7 +228010,7 @@ }, { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -225719,7 +228027,7 @@ }, { "name": "owner", - "description": "Username of current owner of schema.", + "description": "The user or group that owns the schema. The creator becomes the owner, and the owner can be changed\nonly through the update method.", "is_request_body_field": true, "entity": { "is_string": true @@ -225739,7 +228047,7 @@ "required_positional_arguments": [ { "name": "full_name", - "description": "Full name of the schema.", + "description": "Full name of the schema, in the form catalog_name.schema_name.", "required": true, "is_path": true, "entity": { @@ -226024,7 +228332,7 @@ }, { "name": "DeleteSecret", - "description": "Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``\npermission on the Secret Scope.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-secret-scope\",\n\"key\": \"my-secret-key\"\n}\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``BAD_REQUEST`` if system user attempts to delete an internal secret, or request is made against Azure KeyVault backed scope.", + "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.", "summary": "Delete a secret.", "path": "/api/2.0/secrets/delete", "can_use_json": true, @@ -226284,7 +228592,7 @@ }, { "name": "GetSecret", - "description": "Gets a secret for a given key and scope. This API can only be called from the DBUtils\ninterface. Users need the READ permission to make this call.\n\nExample response:\n\n.. code::\n\n{\n\"key\": \"my-string-key\",\n\"value\": \u003cbytes of the secret value\u003e\n}\n\nNote that the secret value returned is in bytes. The interpretation of the bytes\nis determined by the caller in DBUtils and the type the data is decoded into.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\n\nNote: This is explicitly an undocumented API. It also doesn't need to be supported\nfor the /preview prefix, because it's not a customer-facing API (i.e. only used\nfor DBUtils SecretUtils to fetch secrets).\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.\nThrows ``BAD_REQUEST`` if normal user calls get secret outside of a notebook.\nAKV specific errors:\nThrows ``INVALID_PARAMETER_VALUE`` if secret name is not alphanumeric or too long.\nThrows ``PERMISSION_DENIED`` if secret manager cannot access AKV with 403 error\nThrows ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other 4xx error", + "description": "Gets the bytes representation of a secret value for the specified scope and key.\nUsers need the READ permission to make this call.\n\nThe secret value is returned as bytes regardless of whether it was written with\n``string_value`` or ``bytes_value``, so the caller decides how to decode it. Values\nreturned by this API are not redacted.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nAzure Key Vault-backed scopes can also return the following errors:\nThrows ``INVALID_PARAMETER_VALUE`` if the secret name is not alphanumeric or is too long.\nThrows ``PERMISSION_DENIED`` if Databricks cannot access the key vault (HTTP 403).\nThrows ``MALFORMED_REQUEST`` if Databricks cannot access the key vault with any other 4xx error.", "summary": "Get a secret.", "path": "/api/2.0/secrets/get", "has_required_positional_arguments": true, @@ -226461,7 +228769,7 @@ }, { "name": "ListSecrets", - "description": "Lists the secret keys that are stored at this scope. This is a metadata-only\noperation; secret data cannot be retrieved using this API. Users need the READ\npermission to make this call.\n\nExample response:\n\n.. code::\n\n{\n\"secrets\": [\n{\n\"key\": \"my-string-key\"\",\n\"last_updated_timestamp\": \"1520467595000\"\n},\n{\n\"key\": \"my-byte-key\",\n\"last_updated_timestamp\": \"1520467595000\"\n},\n]\n}\n\nThe lastUpdatedTimestamp returned is in milliseconds since epoch.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", + "description": "Lists the secret keys that are stored at this scope. This is a metadata-only\noperation; secret data cannot be retrieved using this API. Users need the READ\npermission to make this call.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.", "summary": "List secret keys.", "path": "/api/2.0/secrets/list", "has_required_positional_arguments": true, @@ -226701,7 +229009,7 @@ }, { "name": "PutSecret", - "description": "Inserts a secret under the provided scope with the given name. If a secret already\nexists with the same name, this command overwrites the existing secret's value.\nThe server encrypts the secret using the secret scope's encryption settings before\nstoring it. You must have ``WRITE`` or ``MANAGE`` permission on the secret scope.\n\nThe secret key must consist of alphanumeric characters, dashes, underscores,\nand periods, and cannot exceed 128 characters. The maximum allowed secret\nvalue size is 128 KB. The maximum number of secrets in a given scope is\n1000.\n\nExample request:\n\n.. code::\n\n{\n\"scope\": \"my-databricks-scope\",\n\"key\": \"my-string-key\",\n\"string_value\": \"foobar\"\n}\n\nThe input fields \"string_value\" or \"bytes_value\"\nspecify the type of the secret, which will determine the value returned when\nthe secret value is requested. Exactly one must be specified.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded.\nThrows ``INVALID_PARAMETER_VALUE`` if the request parameters are invalid.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``MALFORMED_REQUEST`` if request is incorrectly formatted or conflicting.\nThrows ``BAD_REQUEST`` if request is made against Azure KeyVault backed scope.", + "description": "Inserts a secret under the provided scope with the given name. If a secret already\nexists with the same name, this command overwrites the existing secret's value.\nThe server encrypts the secret using the secret scope's encryption settings before\nstoring it. You must have ``WRITE`` or ``MANAGE`` permission on the secret scope.\n\nThe secret key must consist of alphanumeric characters, dashes, underscores,\nand periods, and cannot exceed 128 characters. The maximum allowed secret\nvalue size is 128 KB. The maximum number of secrets in a given scope is\n1000.\n\nExactly one of ``string_value`` or ``bytes_value`` must be specified. The server\nstores both kinds of value as bytes and does not record which one was used.\n\nThrows ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.\nThrows ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded.\nThrows ``INVALID_PARAMETER_VALUE`` if the request parameters are invalid.\nThrows ``PERMISSION_DENIED`` if the user does not have permission to make this API call.\nThrows ``MALFORMED_REQUEST`` if request is incorrectly formatted or conflicting.\nThrows ``BAD_REQUEST`` if request is made against Azure KeyVault backed scope.", "summary": "Add a secret.", "path": "/api/2.0/secrets/put", "can_use_json": true, @@ -226715,7 +229023,7 @@ "required_fields": [ { "name": "scope", - "description": "The name of the scope to which the secret will be associated with.", + "description": "The name of the scope to store the secret in.", "required": true, "is_request_body_field": true, "entity": { @@ -226735,7 +229043,7 @@ "required_request_body_fields": [ { "name": "scope", - "description": "The name of the scope to which the secret will be associated with.", + "description": "The name of the scope to store the secret in.", "required": true, "is_request_body_field": true, "entity": { @@ -226759,7 +229067,7 @@ "all_fields": [ { "name": "bytes_value", - "description": "If specified, value will be stored as bytes.", + "description": "The secret value as raw bytes. The bytes must be base64-encoded in the JSON request body.", "is_request_body_field": true, "entity": { "is_string": true @@ -226776,7 +229084,7 @@ }, { "name": "scope", - "description": "The name of the scope to which the secret will be associated with.", + "description": "The name of the scope to store the secret in.", "required": true, "is_request_body_field": true, "entity": { @@ -226785,7 +229093,7 @@ }, { "name": "string_value", - "description": "If specified, note that the value will be stored in UTF-8 (MB4) form.", + "description": "The secret value as text. The server stores it as the UTF-8 encoding of the string.", "is_request_body_field": true, "entity": { "is_string": true @@ -226795,7 +229103,7 @@ "required_positional_arguments": [ { "name": "scope", - "description": "The name of the scope to which the secret will be associated with.", + "description": "The name of the scope to store the secret in.", "required": true, "is_request_body_field": true, "entity": { @@ -230140,7 +232448,7 @@ "all_fields": [ { "name": "active", - "description": "If this user is active", + "description": "Indicates whether the service principal is active. A deactivated service principal cannot\nauthenticate or access Databricks APIs, but it keeps its permissions.", "is_request_body_field": true, "entity": { "is_bool": true @@ -230148,7 +232456,7 @@ }, { "name": "applicationId", - "description": "UUID relating to the service principal", + "description": "Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this\nfield. On AWS and GCP, Databricks generates the application ID and rejects requests that set\nit.", "is_request_body_field": true, "entity": { "is_string": true @@ -230156,7 +232464,7 @@ }, { "name": "displayName", - "description": "String that represents a concatenation of given and family names.", + "description": "Sets the human-readable name of the service principal. The name is required unless the\nrequest sets `applicationId`.", "is_request_body_field": true, "entity": { "is_string": true @@ -230164,6 +232472,7 @@ }, { "name": "externalId", + "description": "Sets the identifier of the service principal in an external identity provider.", "is_request_body_field": true, "entity": { "is_string": true @@ -230171,7 +232480,7 @@ }, { "name": "id", - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "is_request_body_field": true, "entity": { "is_string": true @@ -230179,7 +232488,7 @@ }, { "name": "roles", - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the service principal. The only supported role\nvalue is `account_admin`.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -230193,7 +232502,7 @@ }, { "name": "Delete", - "description": "Delete a single service principal in the Databricks account.", + "description": "Deletes a single service principal from the Databricks account.", "summary": "Delete a service principal.", "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", "has_required_positional_arguments": true, @@ -230253,7 +232562,7 @@ }, { "name": "Get", - "description": "Gets the details for a single service principal define in the Databricks account.", + "description": "Gets the details for a single service principal in the Databricks account.", "summary": "Get service principal details.", "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", "is_crud_read": true, @@ -230429,7 +232738,7 @@ "required_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a service principal in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -230440,7 +232749,7 @@ "required_in_url_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a service principal in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -230455,7 +232764,7 @@ "all_fields": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a service principal in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -230464,6 +232773,7 @@ }, { "name": "Operations", + "description": "Lists the patch operations to apply to the service principal.", "is_request_body_field": true, "entity": { "pascal_name": "PatchList", @@ -230493,7 +232803,7 @@ "required_positional_arguments": [ { "name": "id", - "description": "Unique ID in the Databricks workspace.", + "description": "Unique ID for a service principal in the Databricks account.", "required": true, "is_path": true, "entity": { @@ -230504,7 +232814,7 @@ }, { "name": "Update", - "description": "Updates the details of a single service principal.\n\nThis action replaces the existing service principal with the same name.", + "description": "Updates the details of a single service principal.\n\nThis action replaces the existing service principal that has the given ID.", "summary": "Replace service principal.", "path": "/api/2.0/accounts/{account_id}/scim/v2/ServicePrincipals/{id}", "can_use_json": true, @@ -230517,7 +232827,7 @@ "required_fields": [ { "name": "id", - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "required": true, "is_path": true, "entity": { @@ -230528,7 +232838,7 @@ "required_in_url_fields": [ { "name": "id", - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "required": true, "is_path": true, "entity": { @@ -230543,7 +232853,7 @@ "all_fields": [ { "name": "active", - "description": "If this user is active", + "description": "Indicates whether the service principal is active. A deactivated service principal cannot\nauthenticate or access Databricks APIs, but it keeps its permissions.", "is_request_body_field": true, "entity": { "is_bool": true @@ -230551,7 +232861,7 @@ }, { "name": "applicationId", - "description": "UUID relating to the service principal", + "description": "Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this\nfield. On AWS and GCP, Databricks generates the application ID and rejects requests that set\nit.", "is_request_body_field": true, "entity": { "is_string": true @@ -230559,7 +232869,7 @@ }, { "name": "displayName", - "description": "String that represents a concatenation of given and family names.", + "description": "Sets the human-readable name of the service principal. The name is required unless the\nrequest sets `applicationId`.", "is_request_body_field": true, "entity": { "is_string": true @@ -230567,6 +232877,7 @@ }, { "name": "externalId", + "description": "Sets the identifier of the service principal in an external identity provider.", "is_request_body_field": true, "entity": { "is_string": true @@ -230574,7 +232885,7 @@ }, { "name": "id", - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "required": true, "is_path": true, "entity": { @@ -230583,7 +232894,7 @@ }, { "name": "roles", - "description": "Indicates if the group has the admin role.", + "description": "Lists the account roles that are assigned to the service principal. The only supported role\nvalue is `account_admin`.", "is_request_body_field": true, "entity": { "pascal_name": "ComplexValueList", @@ -230597,7 +232908,7 @@ "required_positional_arguments": [ { "name": "id", - "description": "Databricks service principal ID.", + "description": "Identifies the service principal within Databricks.", "required": true, "is_path": true, "entity": { @@ -234546,7 +236857,7 @@ "methods": [ { "name": "GetSoftwareArtifact", - "description": "Gets a software artifact.", + "description": "Gets a software artifact by its resource name. Returns `NOT_FOUND` if the artifact does not\nexist.", "summary": "Get a software artifact.", "path": "/api/2.1/unity-catalog/{name=software-artifacts/*}", "is_crud_read": true, @@ -234610,7 +236921,7 @@ }, { "name": "GetSoftwareArtifactVersion", - "description": "Gets a software artifact version.", + "description": "Gets a software artifact version by its resource name. Returns `NOT_FOUND` if the version does\nnot exist.", "summary": "Get a software artifact version.", "path": "/api/2.1/unity-catalog/{name=software-artifacts/*/versions/*}", "is_crud_read": true, @@ -234625,7 +236936,7 @@ "required_fields": [ { "name": "name", - "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "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.", "required": true, "is_path": true, "entity": { @@ -234636,7 +236947,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "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.", "required": true, "is_path": true, "entity": { @@ -234652,7 +236963,7 @@ "all_fields": [ { "name": "name", - "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "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.", "required": true, "is_path": true, "entity": { @@ -234663,7 +236974,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "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.", "required": true, "is_path": true, "entity": { @@ -234856,7 +237167,7 @@ }, { "name": "ResolveSoftwareArtifactVersion", - "description": "Resolves a software artifact version from its tag alias.", + "description": "Resolves a software artifact version from its tag alias. Returns `NOT_FOUND` if the artifact or\nthe alias does not exist.", "summary": "Resolve a software artifact version.", "path": "/api/2.1/unity-catalog/{parent=software-artifacts/*}/versions:resolve", "can_use_json": true, @@ -234873,7 +237184,7 @@ "required_fields": [ { "name": "parent", - "description": "Resource name of the software artifact containing the alias.", + "description": "Resource name of the software artifact containing the alias, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", "required": true, "is_path": true, "entity": { @@ -234882,7 +237193,7 @@ }, { "name": "alias", - "description": "Image tag alias selecting the version.", + "description": "Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128\ncharacters, made of letters, digits, underscores, periods, and hyphens, and must not start with\na period or hyphen.", "required": true, "is_request_body_field": true, "entity": { @@ -234893,7 +237204,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "Resource name of the software artifact containing the alias.", + "description": "Resource name of the software artifact containing the alias, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", "required": true, "is_path": true, "entity": { @@ -234904,7 +237215,7 @@ "required_request_body_fields": [ { "name": "alias", - "description": "Image tag alias selecting the version.", + "description": "Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128\ncharacters, made of letters, digits, underscores, periods, and hyphens, and must not start with\na period or hyphen.", "required": true, "is_request_body_field": true, "entity": { @@ -234920,7 +237231,7 @@ "all_fields": [ { "name": "alias", - "description": "Image tag alias selecting the version.", + "description": "Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128\ncharacters, made of letters, digits, underscores, periods, and hyphens, and must not start with\na period or hyphen.", "required": true, "is_request_body_field": true, "entity": { @@ -234929,7 +237240,7 @@ }, { "name": "parent", - "description": "Resource name of the software artifact containing the alias.", + "description": "Resource name of the software artifact containing the alias, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", "required": true, "is_path": true, "entity": { @@ -234940,7 +237251,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "Resource name of the software artifact containing the alias.", + "description": "Resource name of the software artifact containing the alias, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", "required": true, "is_path": true, "entity": { @@ -234949,7 +237260,7 @@ }, { "name": "alias", - "description": "Image tag alias selecting the version.", + "description": "Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128\ncharacters, made of letters, digits, underscores, periods, and hyphens, and must not start with\na period or hyphen.", "required": true, "is_request_body_field": true, "entity": { @@ -235082,7 +237393,7 @@ }, { "name": "create_time", - "description": "Time at which this software artifact was created.", + "description": "Time at which the artifact was created, formatted as an RFC 3339 timestamp in JSON.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -235109,7 +237420,7 @@ }, { "name": "owner", - "description": "Principal name (a user, service principal, or group) that owns this artifact.", + "description": "Principal that owns the artifact, given as a user's email address, a service principal's\napplication ID, or a group name.", "is_request_body_field": true, "entity": { "is_string": true @@ -235117,7 +237428,7 @@ }, { "name": "update_time", - "description": "Time at which this software artifact was last updated.", + "description": "Time at which the artifact was last updated, formatted as an RFC 3339 timestamp in JSON.", "is_output_only": true, "is_request_body_field": true, "is_optional_object": true, @@ -240634,7 +242945,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240654,7 +242965,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240680,7 +242991,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240700,7 +243011,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240735,7 +243046,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240755,7 +243066,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240772,7 +243083,7 @@ "all_fields": [ { "name": "catalog_name", - "description": "the catalog for which the system schema is to enabled in", + "description": "Name of the catalog in which to enable the system schema. The supported values are `system` and `samples`. If not\nset, the system schema is enabled in the `system` catalog.", "is_request_body_field": true, "entity": { "is_string": true @@ -240789,7 +243100,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -240809,7 +243120,7 @@ }, { "name": "schema_name", - "description": "Full name of the system schema.", + "description": "Name of the system schema, without the catalog prefix.", "required": true, "is_path": true, "entity": { @@ -241208,6 +243519,7 @@ }, { "name": "table_type", + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "required": true, "is_request_body_field": true, "entity": { @@ -241245,6 +243557,7 @@ }, { "name": "data_source_format", + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "required": true, "is_request_body_field": true, "entity": { @@ -241345,7 +243658,7 @@ }, { "name": "storage_location", - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "required": true, "is_request_body_field": true, "entity": { @@ -241383,6 +243696,7 @@ }, { "name": "table_type", + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "required": true, "is_request_body_field": true, "entity": { @@ -241420,6 +243734,7 @@ }, { "name": "data_source_format", + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "required": true, "is_request_body_field": true, "entity": { @@ -241520,7 +243835,7 @@ }, { "name": "storage_location", - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "required": true, "is_request_body_field": true, "entity": { @@ -241557,6 +243872,7 @@ }, { "name": "data_source_format", + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "required": true, "is_request_body_field": true, "entity": { @@ -241685,7 +244001,7 @@ }, { "name": "storage_location", - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "required": true, "is_request_body_field": true, "entity": { @@ -241694,6 +244010,7 @@ }, { "name": "table_type", + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "required": true, "is_request_body_field": true, "entity": { @@ -241760,6 +244077,7 @@ }, { "name": "table_type", + "description": "The type of the table. MANAGED tables store their data in storage that Unity Catalog manages, EXTERNAL\ntables store it in a registered external location, FOREIGN tables mirror objects of an external database\nthrough a connection, and the shallow clone types reference the data files of a base table. VIEW,\nMATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view definition. See\nhttps://docs.databricks.com/aws/en/tables/ for an overview of the table types.", "required": true, "is_request_body_field": true, "entity": { @@ -241797,6 +244115,7 @@ }, { "name": "data_source_format", + "description": "The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign tables report\nthe external system that holds them, for example SNOWFLAKE_FORMAT or MYSQL_FORMAT.", "required": true, "is_request_body_field": true, "entity": { @@ -241897,7 +244216,7 @@ }, { "name": "storage_location", - "description": "Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).", + "description": "The cloud storage URL under which the data files of the table are stored.\nFor an EXTERNAL table, it must be set on creation to a path within an existing external location.\nFor a MANAGED table, the server assigns a path under the managed storage location of the parent schema,\ncatalog or metastore and returns it in this field. Views have no storage location.", "required": true, "is_request_body_field": true, "entity": { @@ -242455,7 +244774,7 @@ }, { "name": "owner", - "description": "Username of current owner of table.", + "description": "The user or group that owns the table. The principal that creates the table becomes its owner.", "is_request_body_field": true, "entity": { "is_string": true @@ -246278,7 +248597,7 @@ }, { "name": "RetrieveUserVisibleMetrics", - "description": "Retrieve user-visible metrics for an endpoint", + "description": "Retrieve time series of usage and health metrics for an endpoint and its indexes, such as\nrequest counts, request latency percentiles and endpoint utilization.", "summary": "Retrieve user-visible metrics for an endpoint.", "path": "/api/2.0/vector-search/endpoints/{name}/metrics", "can_use_json": true, @@ -246292,7 +248611,7 @@ "required_fields": [ { "name": "name", - "description": "AI Search endpoint name", + "description": "Name of the endpoint whose metrics to retrieve.", "required": true, "is_path": true, "entity": { @@ -246303,7 +248622,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "AI Search endpoint name", + "description": "Name of the endpoint whose metrics to retrieve.", "required": true, "is_path": true, "entity": { @@ -246319,7 +248638,7 @@ "all_fields": [ { "name": "end_time", - "description": "End time for metrics query", + "description": "End of the time range. Defaults to the current time. Must be later than `start_time`.", "is_request_body_field": true, "entity": { "is_string": true @@ -246327,7 +248646,7 @@ }, { "name": "granularity_in_seconds", - "description": "Granularity in seconds", + "description": "Requested interval between data points, in seconds. Defaults to 60, which is also the minimum.\nThe server may return a finer or coarser interval: 60 seconds only for time ranges of 1 hour or\nless, otherwise 300 seconds or more. Read the interval from the returned timestamps.", "is_request_body_field": true, "entity": { "is_int": true @@ -246335,7 +248654,7 @@ }, { "name": "metrics", - "description": "List of metrics to retrieve", + "description": "Metrics to retrieve. Each entry names a metric and optionally narrows it with labels or a\npercentile. An unknown metric name fails the whole request, and an empty list returns no series.", "is_request_body_field": true, "entity": { "pascal_name": "MetricList", @@ -246347,7 +248666,7 @@ }, { "name": "name", - "description": "AI Search endpoint name", + "description": "Name of the endpoint whose metrics to retrieve.", "required": true, "is_path": true, "entity": { @@ -246356,7 +248675,7 @@ }, { "name": "page_token", - "description": "Token for pagination", + "description": "Not used. The response returns all data points in one page.", "is_request_body_field": true, "entity": { "is_string": true @@ -246364,7 +248683,7 @@ }, { "name": "start_time", - "description": "Start time for metrics query", + "description": "Start of the time range. Required. Must be within the last 169 hours.", "is_request_body_field": true, "entity": { "is_string": true @@ -246374,7 +248693,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "AI Search endpoint name", + "description": "Name of the endpoint whose metrics to retrieve.", "required": true, "is_path": true, "entity": { @@ -246882,7 +249201,7 @@ "methods": [ { "name": "CreateIndex", - "description": "Create a new index.", + "description": "Create a new index on an endpoint. Creating a Delta Sync index also creates the pipeline that\npopulates it from the source table; a Direct Vector Access index starts empty and is populated\nthrough Upsert data into an index.", "summary": "Create an index.", "path": "/api/2.0/vector-search/indexes", "can_use_json": true, @@ -246897,7 +249216,7 @@ "required_fields": [ { "name": "name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246915,7 +249234,7 @@ }, { "name": "primary_key", - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "required": true, "is_request_body_field": true, "entity": { @@ -246924,6 +249243,7 @@ }, { "name": "index_type", + "description": "Type of index to create, which determines which spec field is required.", "required": true, "is_request_body_field": true, "entity": { @@ -246942,7 +249262,7 @@ "required_request_body_fields": [ { "name": "name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246960,7 +249280,7 @@ }, { "name": "primary_key", - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "required": true, "is_request_body_field": true, "entity": { @@ -246969,6 +249289,7 @@ }, { "name": "index_type", + "description": "Type of index to create, which determines which spec field is required.", "required": true, "is_request_body_field": true, "entity": { @@ -247040,6 +249361,7 @@ }, { "name": "index_type", + "description": "Type of index to create, which determines which spec field is required.", "required": true, "is_request_body_field": true, "entity": { @@ -247056,7 +249378,7 @@ }, { "name": "name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247065,7 +249387,7 @@ }, { "name": "primary_key", - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "required": true, "is_request_body_field": true, "entity": { @@ -247076,7 +249398,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247094,7 +249416,7 @@ }, { "name": "primary_key", - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "required": true, "is_request_body_field": true, "entity": { @@ -247103,6 +249425,7 @@ }, { "name": "index_type", + "description": "Type of index to create, which determines which spec field is required.", "required": true, "is_request_body_field": true, "entity": { @@ -247121,7 +249444,7 @@ }, { "name": "DeleteDataVectorIndex", - "description": "Handles the deletion of data from a specified vector index.", + "description": "Delete rows from a Direct Vector Access index by primary key. The response reports how many\nrows were deleted and the primary keys of the rows that failed.", "summary": "Delete data from index.", "path": "/api/2.0/vector-search/indexes/{index_name}/delete-data", "can_use_json": true, @@ -247144,7 +249467,7 @@ }, { "name": "primary_keys", - "description": "List of primary keys for the data to be deleted.", + "description": "Primary keys of the rows to delete. At least one key is required.", "required": true, "is_query": true, "entity": { @@ -247167,7 +249490,7 @@ }, { "name": "primary_keys", - "description": "List of primary keys for the data to be deleted.", + "description": "Primary keys of the rows to delete. At least one key is required.", "required": true, "is_query": true, "entity": { @@ -247195,7 +249518,7 @@ }, { "name": "primary_keys", - "description": "List of primary keys for the data to be deleted.", + "description": "Primary keys of the rows to delete. At least one key is required.", "required": true, "is_query": true, "entity": { @@ -247220,7 +249543,7 @@ }, { "name": "DeleteIndex", - "description": "Delete an index.", + "description": "Delete an index and the data it holds. The source table of a Delta Sync index is not affected.", "summary": "Delete an index.", "path": "/api/2.0/vector-search/indexes/{index_name}", "has_required_positional_arguments": true, @@ -247232,7 +249555,7 @@ "required_fields": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247243,7 +249566,7 @@ "required_in_url_fields": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247260,7 +249583,7 @@ "all_fields": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247271,7 +249594,7 @@ "required_positional_arguments": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247295,7 +249618,7 @@ "required_fields": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247306,7 +249629,7 @@ "required_in_url_fields": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247330,7 +249653,7 @@ }, { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247341,7 +249664,7 @@ "required_positional_arguments": [ { "name": "index_name", - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index.", "required": true, "is_path": true, "entity": { @@ -247364,7 +249687,7 @@ "required_fields": [ { "name": "endpoint_name", - "description": "Name of the endpoint", + "description": "Name of the endpoint whose indexes to list.", "required": true, "is_query": true, "entity": { @@ -247375,7 +249698,7 @@ "required_in_url_fields": [ { "name": "endpoint_name", - "description": "Name of the endpoint", + "description": "Name of the endpoint whose indexes to list.", "required": true, "is_query": true, "entity": { @@ -247391,7 +249714,7 @@ "all_fields": [ { "name": "endpoint_name", - "description": "Name of the endpoint", + "description": "Name of the endpoint whose indexes to list.", "required": true, "is_query": true, "entity": { @@ -247400,7 +249723,7 @@ }, { "name": "page_token", - "description": "Token for pagination", + "description": "Page token returned by a previous call, used to get the next page of results.", "is_query": true, "entity": { "is_string": true @@ -247410,7 +249733,7 @@ "required_positional_arguments": [ { "name": "endpoint_name", - "description": "Name of the endpoint", + "description": "Name of the endpoint whose indexes to list.", "required": true, "is_query": true, "entity": { @@ -247422,7 +249745,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "Token for pagination", + "description": "Page token returned by a previous call, used to get the next page of results.", "is_query": true, "entity": { "is_string": true @@ -247433,7 +249756,7 @@ }, { "name": "QueryIndex", - "description": "Query the specified vector index.", + "description": "Query an index with a vector, text, or both, and return the requested columns of the\nbest-matching rows.", "summary": "Query an index.", "path": "/api/2.0/vector-search/indexes/{index_name}/query", "can_use_json": true, @@ -247457,7 +249780,7 @@ }, { "name": "columns", - "description": "List of column names to include in the response.", + "description": "Names of the columns to return for each result. At least one column is required, and only\ncolumns that are part of the index can be returned.", "required": true, "is_request_body_field": true, "entity": { @@ -247482,7 +249805,7 @@ "required_request_body_fields": [ { "name": "columns", - "description": "List of column names to include in the response.", + "description": "Names of the columns to return for each result. At least one column is required, and only\ncolumns that are part of the index can be returned.", "required": true, "is_request_body_field": true, "entity": { @@ -247501,7 +249824,7 @@ "all_fields": [ { "name": "columns", - "description": "List of column names to include in the response.", + "description": "Names of the columns to return for each result. At least one column is required, and only\ncolumns that are part of the index can be returned.", "required": true, "is_request_body_field": true, "entity": { @@ -247535,7 +249858,7 @@ }, { "name": "filters_json", - "description": "JSON string representing query filters.\n\nExample filters:\n\n- `{\"id \u003c\": 5}`: Filter for id less than 5.\n- `{\"id \u003e\": 5}`: Filter for id greater than 5.\n- `{\"id \u003c=\": 5}`: Filter for id less than equal to 5.\n- `{\"id \u003e=\": 5}`: Filter for id greater than equal to 5.\n- `{\"id\": 5}`: Filter for id equal to 5.", + "description": "Filters to apply to the results, as a JSON object serialized to a string. Each key is a column\nname, optionally followed by a space and an operator, and each value is the value or list of\nvalues to compare the column against. A key without an operator matches the value exactly, or\nany of the listed values. Supported operators are `NOT`, `\u003c`, `\u003c=`, `\u003e`, `\u003e=`, `OR` and `LIKE`;\nsee https://docs.databricks.com/aws/en/ai-search/query-ai-search for their semantics. This\nfield is not supported on storage-optimized endpoints.", "is_request_body_field": true, "entity": { "is_string": true @@ -247552,7 +249875,7 @@ }, { "name": "num_results", - "description": "Number of results to return. Defaults to 10.", + "description": "Maximum number of results to return. It must be greater than 0 and defaults to 10. By default,\na `HYBRID` query can return at most 200 results.", "is_request_body_field": true, "entity": { "is_int": true @@ -247571,7 +249894,7 @@ }, { "name": "query_text", - "description": "Query text. Required for Delta Sync Index using model endpoint.", + "description": "Text to search for. Use it for an index with Databricks-managed embeddings, which embeds the\ntext with the index's embedding model endpoint, and for `FULL_TEXT` queries on any index. A\n`HYBRID` query on an index with managed embeddings requires only `query_text`.", "is_request_body_field": true, "entity": { "is_string": true @@ -247587,7 +249910,7 @@ }, { "name": "query_vector", - "description": "Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.", + "description": "Embedding vector to search for. Use it for an index whose embeddings you compute yourself: a\nDirect Vector Access index or a Delta Sync index with `embedding_vector_columns`. A `HYBRID`\nquery on a Delta Sync index with `embedding_vector_columns`, or on a Direct Vector Access index\nwithout `embedding_source_columns`, requires both `query_vector` and `query_text`. A Direct\nVector Access index with `embedding_source_columns` can be queried with `query_text` alone.", "is_request_body_field": true, "entity": { "pascal_name": "List", @@ -247681,7 +250004,7 @@ "all_fields": [ { "name": "endpoint_name", - "description": "Name of the endpoint.", + "description": "Name of the endpoint that serves the index.", "is_request_body_field": true, "entity": { "is_string": true @@ -247719,7 +250042,7 @@ }, { "name": "ScanIndex", - "description": "Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.", + "description": "Scan an index and return the first `num_results` rows after the exclusive `last_primary_key`.\nRepeat the call with the returned `last_primary_key` to read the whole index.", "summary": "Scan an index.", "path": "/api/2.0/vector-search/indexes/{index_name}/scan", "can_use_json": true, @@ -247798,7 +250121,7 @@ }, { "name": "SyncIndex", - "description": "Triggers a synchronization process for a specified vector index.", + "description": "Start a sync of a Delta Sync index with a `TRIGGERED` pipeline from its source table. An index\nwith a `CONTINUOUS` pipeline syncs automatically and rejects manual syncs.", "summary": "Synchronize an index.", "path": "/api/2.0/vector-search/indexes/{index_name}/sync", "has_required_positional_arguments": true, @@ -247860,7 +250183,7 @@ }, { "name": "UpsertDataVectorIndex", - "description": "Handles the upserting of data into a specified vector index.", + "description": "Insert rows into a Direct Vector Access index, replacing existing rows that have the same\nprimary key. The response reports how many rows succeeded and the primary keys of the rows that\nfailed.", "summary": "Upsert data into an index.", "path": "/api/2.0/vector-search/indexes/{index_name}/upsert-data", "can_use_json": true, @@ -247883,7 +250206,7 @@ }, { "name": "inputs_json", - "description": "JSON string representing the data to be upserted.", + "description": "Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column\nnames from `schema_json` to values and must include the primary key. A row whose primary key\nalready exists in the index is replaced.", "required": true, "is_request_body_field": true, "entity": { @@ -247905,7 +250228,7 @@ "required_request_body_fields": [ { "name": "inputs_json", - "description": "JSON string representing the data to be upserted.", + "description": "Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column\nnames from `schema_json` to values and must include the primary key. A row whose primary key\nalready exists in the index is replaced.", "required": true, "is_request_body_field": true, "entity": { @@ -247930,7 +250253,7 @@ }, { "name": "inputs_json", - "description": "JSON string representing the data to be upserted.", + "description": "Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column\nnames from `schema_json` to values and must include the primary key. A row whose primary key\nalready exists in the index is replaced.", "required": true, "is_request_body_field": true, "entity": { @@ -247950,7 +250273,7 @@ }, { "name": "inputs_json", - "description": "JSON string representing the data to be upserted.", + "description": "Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column\nnames from `schema_json` to values and must include the primary key. A row whose primary key\nalready exists in the index is replaced.", "required": true, "is_request_body_field": true, "entity": { @@ -248800,7 +251123,7 @@ "all_fields": [ { "name": "auto_stop_mins", - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "is_request_body_field": true, "entity": { "is_int": true @@ -249447,7 +251770,7 @@ "all_fields": [ { "name": "auto_stop_mins", - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "is_request_body_field": true, "entity": { "is_int": true @@ -252936,7 +255259,7 @@ }, { "name": "tag_value", - "description": "The value of the tag", + "description": "The value of the tag. If the value is omitted, the tag is assigned with its key only.", "is_request_body_field": true, "entity": { "is_string": true @@ -253475,7 +255798,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 fields to update. Only `tag_value` can be updated, because the entity\ntype, entity ID and tag key identify the tag assignment.", "required": true, "is_query": true, "entity": { @@ -253513,7 +255836,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 fields to update. Only `tag_value` can be updated, because the entity\ntype, entity ID and tag key identify the tag assignment.", "required": true, "is_query": true, "entity": { @@ -253762,7 +256085,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 fields to update. Only `tag_value` can be updated, because the entity\ntype, entity ID and tag key identify the tag assignment.", "required": true, "is_query": true, "entity": { @@ -253798,7 +256121,7 @@ }, { "name": "tag_value", - "description": "The value of the tag", + "description": "The value of the tag. If the value is omitted, the tag is assigned with its key only.", "is_request_body_field": true, "entity": { "is_string": true @@ -253835,7 +256158,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 fields to update. Only `tag_value` can be updated, because the entity\ntype, entity ID and tag key identify the tag assignment.", "required": true, "is_query": true, "entity": { @@ -254220,7 +256543,7 @@ }, { "name": "group_id", - "description": "The Databricks ID of the group.", + "description": "The Databricks ID of the group. It is a numeric string that Databricks assigns when the group\nis created, and it is the `{group_id}` segment of `name`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -254229,7 +256552,7 @@ }, { "name": "group_name", - "description": "The name of the group.", + "description": "The display name of the group. It must be unique in the account, must not be blank, and must be\nshorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of a\ngroup that Databricks manages, such as `admins` or `users`.", "is_request_body_field": true, "entity": { "is_string": true @@ -257605,7 +259928,7 @@ }, { "name": "group_id", - "description": "The Databricks ID of the group.", + "description": "The Databricks ID of the group. It is a numeric string that Databricks assigns when the group\nis created, and it is the `{group_id}` segment of `name`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -257614,7 +259937,7 @@ }, { "name": "group_name", - "description": "The name of the group.", + "description": "The display name of the group. It must be unique in the account, must not be blank, and must be\nshorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of a\ngroup that Databricks manages, such as `admins` or `users`.", "is_request_body_field": true, "entity": { "is_string": true diff --git a/.nextchanges/dependency-updates/go-sdk-v0.201.0.md b/.nextchanges/dependency-updates/go-sdk-v0.201.0.md new file mode 100644 index 00000000000..d1d2662700a --- /dev/null +++ b/.nextchanges/dependency-updates/go-sdk-v0.201.0.md @@ -0,0 +1 @@ +* Update the Go SDK to [v0.201.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.201.0). diff --git a/acceptance/bundle/refschema/output/materialization_sets.txt b/acceptance/bundle/refschema/output/materialization_sets.txt index 3d1682d1766..589e01994b4 100644 --- a/acceptance/bundle/refschema/output/materialization_sets.txt +++ b/acceptance/bundle/refschema/output/materialization_sets.txt @@ -43,6 +43,8 @@ resources.materialization_sets.*.materialized_features[*].online_store_config.ca resources.materialization_sets.*.materialized_features[*].online_store_config.online_store_name string ALL resources.materialization_sets.*.materialized_features[*].online_store_config.schema_name string ALL resources.materialization_sets.*.materialized_features[*].online_store_config.table_name_prefix string ALL +resources.materialization_sets.*.materialized_features[*].operations *ml.MaterializedFeatureOperations ALL +resources.materialization_sets.*.materialized_features[*].operations.latest_entity_purge_operation string ALL resources.materialization_sets.*.materialized_features[*].pipeline_id string ALL resources.materialization_sets.*.materialized_features[*].pipeline_schedule_state ml.MaterializedFeaturePipelineScheduleState ALL resources.materialization_sets.*.materialized_features[*].streaming_mode *ml.StreamingMode ALL diff --git a/acceptance/bundle/refschema/output/vector_search_indexes.txt b/acceptance/bundle/refschema/output/vector_search_indexes.txt index 6246bf1fdc7..281865e202b 100644 --- a/acceptance/bundle/refschema/output/vector_search_indexes.txt +++ b/acceptance/bundle/refschema/output/vector_search_indexes.txt @@ -44,6 +44,12 @@ resources.vector_search_indexes.*.modified_status string INPUT resources.vector_search_indexes.*.name string ALL resources.vector_search_indexes.*.primary_key string ALL resources.vector_search_indexes.*.status *vectorsearch.VectorIndexStatus REMOTE +resources.vector_search_indexes.*.status.detailed_state vectorsearch.IndexStatus REMOTE +resources.vector_search_indexes.*.status.failed_status *vectorsearch.FailedStatus REMOTE +resources.vector_search_indexes.*.status.failed_status.error_code string REMOTE +resources.vector_search_indexes.*.status.failed_status.error_message string REMOTE +resources.vector_search_indexes.*.status.failed_status.last_processed_commit_timestamp *time.Time REMOTE +resources.vector_search_indexes.*.status.failed_status.last_processed_commit_version int64 REMOTE resources.vector_search_indexes.*.status.index_url string REMOTE resources.vector_search_indexes.*.status.indexed_row_count int64 REMOTE resources.vector_search_indexes.*.status.message string REMOTE 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/cmd/workspace/arg-validation/output.txt b/acceptance/cmd/workspace/arg-validation/output.txt index b1a15a33517..738b31da3c7 100644 --- a/acceptance/cmd/workspace/arg-validation/output.txt +++ b/acceptance/cmd/workspace/arg-validation/output.txt @@ -11,7 +11,7 @@ Flags: --apply-policy-default-values[=true|false] When set to true, fixed and default values from the policy will be used for fields that are omitted. --autotermination-minutes int Automatically terminates the cluster after it is inactive for this time in minutes. --cluster-name string Cluster name requested by the user. - --data-security-mode DataSecurityMode Supported values: [ + --data-security-mode DataSecurityMode Data security mode decides what data governance model to use when accessing data from a cluster. Supported values: [ DATA_SECURITY_MODE_AUTO, DATA_SECURITY_MODE_DEDICATED, DATA_SECURITY_MODE_STANDARD, @@ -32,7 +32,7 @@ Flags: --instance-pool-id string The optional ID of the instance pool to which the cluster belongs. --is-single-node[=true|false] This field can only be used when kind = CLASSIC_PREVIEW. --json JSON either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes)) - --kind Kind Supported values: [CLASSIC_PREVIEW] + --kind Kind The kind of compute described by this compute specification. Supported values: [CLASSIC_PREVIEW] --no-wait[=true|false] do not wait to reach RUNNING state --node-type-id string This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. --num-workers int Number of worker nodes that this cluster should have. 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/direct/dresources/configs/materialization_sets.generated.yml b/bundle/direct/dresources/configs/materialization_sets.generated.yml index a4e314a2921..5ec042f2206 100644 --- a/bundle/direct/dresources/configs/materialization_sets.generated.yml +++ b/bundle/direct/dresources/configs/materialization_sets.generated.yml @@ -30,6 +30,8 @@ ignore_remote_changes: reason: spec:output_only - field: materialized_features[*].materialization_set_id reason: spec:output_only + - field: materialized_features[*].operations + reason: spec:output_only - field: materialized_features[*].pipeline_id reason: spec:output_only - field: materialized_features[*].table_name diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 58abf721658..0c980344562 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -1021,16 +1021,6 @@ resources: "dependencies": "description": |- List of pip dependencies, as supported by the version of pip in this environment. - "git_source": - "$fields": - "sparse_checkout": - "description": |- - PLACEHOLDER - "health": - "$fields": - "rules": - "description": |- - PLACEHOLDER "job_clusters": "$fields": "new_cluster": @@ -1134,21 +1124,11 @@ resources: "python_named_params": "description": |- PLACEHOLDER - "webhook_notifications": - "$fields": - "on_duration_warning_threshold_exceeded": - "$fields": - "id": - "description": |- - PLACEHOLDER "trigger": "$fields": "model": "description": |- PLACEHOLDER - "table_update": - "description": |- - PLACEHOLDER "materialization_sets": "description": |- The materialization set definitions for the bundle, where each key is the name of the materialization set. diff --git a/bundle/internal/validation/generated/enum_fields.go b/bundle/internal/validation/generated/enum_fields.go index 381a3baeb46..846f445bfd1 100644 --- a/bundle/internal/validation/generated/enum_fields.go +++ b/bundle/internal/validation/generated/enum_fields.go @@ -294,7 +294,7 @@ var EnumFields = map[string][]string{ "resources.pipelines.*.ingestion_definition.objects[*].table.connector_options.tiktok_ads_options.data_level": {"AUCTION_AD", "AUCTION_ADGROUP", "AUCTION_ADVERTISER", "AUCTION_CAMPAIGN"}, "resources.pipelines.*.ingestion_definition.objects[*].table.connector_options.tiktok_ads_options.report_type": {"AUDIENCE", "BASIC", "BUSINESS_CENTER", "DSA", "GMV_MAX", "PLAYABLE_AD"}, "resources.pipelines.*.ingestion_definition.objects[*].table.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, - "resources.pipelines.*.ingestion_definition.source_type": {"BIGQUERY", "CONFLUENCE", "DYNAMICS365", "FOREIGN_CATALOG", "GA4_RAW_DATA", "GOOGLE_DRIVE", "JIRA", "MANAGED_POSTGRESQL", "META_MARKETING", "MYSQL", "NETSUITE", "ONEDRIVE", "ORACLE", "POSTGRESQL", "RABBITMQ", "SALESFORCE", "SERVICENOW", "SHAREPOINT", "SMARTSHEET", "SQLSERVER", "TERADATA", "TIKTOK_ADS", "WORKDAY_RAAS", "ZENDESK"}, + "resources.pipelines.*.ingestion_definition.source_type": {"BIGQUERY", "CONFLUENCE", "DYNAMICS365", "FOREIGN_CATALOG", "GA4_RAW_DATA", "GOOGLE_ADS", "GOOGLE_DRIVE", "JIRA", "MANAGED_POSTGRESQL", "META_MARKETING", "MYSQL", "NETSUITE", "ONEDRIVE", "ORACLE", "POSTGRESQL", "RABBITMQ", "SALESFORCE", "SERVICENOW", "SHAREPOINT", "SMARTSHEET", "SQLSERVER", "TERADATA", "TIKTOK_ADS", "WORKDAY_RAAS", "ZENDESK"}, "resources.pipelines.*.ingestion_definition.table_configuration.scd_type": {"APPEND_ONLY", "SCD_TYPE_1", "SCD_TYPE_2"}, "resources.pipelines.*.permissions[*].level": {"CAN_MANAGE", "CAN_RUN", "CAN_VIEW", "IS_OWNER"}, "resources.pipelines.*.restart_window.days_of_week[*]": {"FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY"}, diff --git a/bundle/internal/validation/generated/required_fields.go b/bundle/internal/validation/generated/required_fields.go index b9892ca7e54..4cfb58ac22f 100644 --- a/bundle/internal/validation/generated/required_fields.go +++ b/bundle/internal/validation/generated/required_fields.go @@ -188,7 +188,7 @@ var RequiredFields = map[string][]string{ "resources.jobs.*.permissions[*]": {"level"}, "resources.jobs.*.queue": {"enabled"}, "resources.jobs.*.schedule": {"quartz_cron_expression", "timezone_id"}, - "resources.jobs.*.schedule.sql_condition": {"sql_query_id", "warehouse_id"}, + "resources.jobs.*.schedule.sql_condition": {"warehouse_id"}, "resources.jobs.*.tasks[*]": {"task_key"}, "resources.jobs.*.tasks[*].ai_function_task": {"output"}, "resources.jobs.*.tasks[*].ai_function_task.ai_classify": {"version"}, @@ -300,7 +300,7 @@ var RequiredFields = map[string][]string{ "resources.jobs.*.trigger.job_completion.jobs[*]": {"job_id", "workspace_id"}, "resources.jobs.*.trigger.model": {"condition"}, "resources.jobs.*.trigger.periodic": {"interval", "unit"}, - "resources.jobs.*.trigger.sql_condition": {"sql_query_id", "warehouse_id"}, + "resources.jobs.*.trigger.sql_condition": {"warehouse_id"}, "resources.jobs.*.trigger.table_update": {"table_names"}, "resources.jobs.*.triggers[*].continuous.maintenance_window": {"day_of_week", "start_hour", "timezone_id"}, "resources.jobs.*.triggers[*].file_arrival": {"url"}, @@ -309,7 +309,7 @@ var RequiredFields = map[string][]string{ "resources.jobs.*.triggers[*].model": {"condition"}, "resources.jobs.*.triggers[*].periodic": {"interval", "unit"}, "resources.jobs.*.triggers[*].schedule": {"quartz_cron_expression", "timezone_id"}, - "resources.jobs.*.triggers[*].sql_condition": {"sql_query_id", "warehouse_id"}, + "resources.jobs.*.triggers[*].sql_condition": {"warehouse_id"}, "resources.jobs.*.triggers[*].table_update": {"table_names"}, "resources.jobs.*.webhook_notifications.on_duration_warning_threshold_exceeded[*]": {"id"}, "resources.jobs.*.webhook_notifications.on_failure[*]": {"id"}, diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 2d5a35b5a5e..b0fd7b7d3bd 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -454,7 +454,7 @@ "x-databricks-launch-stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "GA" }, @@ -484,7 +484,7 @@ "x-databricks-launch-stage": "GA" }, "data_security_mode": { - "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-databricks-launch-stage": "GA" }, @@ -494,7 +494,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-databricks-launch-stage": "GA" }, @@ -544,7 +544,7 @@ "x-databricks-launch-stage": "GA" }, "kind": { - "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", "x-databricks-launch-stage": "GA" }, @@ -627,7 +627,7 @@ "x-databricks-launch-stage": "GA" }, "workload_type": { - "description": "Cluster Attributes showing for clusters workload types.", + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-databricks-launch-stage": "GA" } @@ -1653,7 +1653,7 @@ "x-databricks-launch-stage": "GA" }, "job_parameters": { - "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "description": "Job-level parameters used in the run, for example `\"param\": \"overriding_val\"`.", "$ref": "#/$defs/map/string", "x-databricks-launch-stage": "GA" }, @@ -1908,7 +1908,7 @@ "type": "object", "properties": { "artifact_location": { - "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", + "description": "URI of the location where the artifacts of the experiment's runs are stored, such as a Unity\nCatalog volume path of the form `dbfs:/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/\u003cpath\u003e`. The URI\nmust have a scheme other than `file` and must not point under the MLflow-managed prefix\n`dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed\nstorage. See https://docs.databricks.com/aws/en/mlflow/experiments for the supported\nlocations.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -1917,7 +1917,7 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "Experiment name.", + "description": "Name of the experiment, as an absolute path in the workspace. Experiments cannot be created\nunder `/Repos`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -1927,7 +1927,7 @@ "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. For the same principal, resource permissions take precedence over top-level or target permissions.\n\nSee [permissions](https://docs.databricks.com/dev-tools/bundles/settings.html#permissions) and [link](https://docs.databricks.com/dev-tools/bundles/permissions.html)." }, "tags": { - "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", + "description": "Tags to set on the new experiment, as key-value pairs. A request can include at most 100\ntags.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag", "x-databricks-launch-stage": "GA" }, @@ -2748,7 +2748,7 @@ "$ref": "#/$defs/bool" }, "role": { - "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", + "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nThe role must be in the same branch as the database.\nTo change the owner, pass valid existing Role name when updating the Database\n\nRequired when creating the Database.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" } @@ -3025,7 +3025,7 @@ "doNotSuggest": true }, "branch": { - "description": "[Beta] The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", + "description": "[Beta] The full resource name of the branch that contains the synced table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".\n\nA value must be specified when creating a synced table inside a standard catalog. Inside a\nLakebase catalog it can be omitted, and if specified it must match the branch of that catalog.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, @@ -3035,7 +3035,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "existing_pipeline_id": { - "description": "[Beta] ID of an existing pipeline to bin-pack this synced table into.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "description": "[Beta] ID of an existing pipeline to bin-pack this synced table into. The pipeline must be a synced\ntable pipeline that runs continuously if and only if scheduling_policy is CONTINUOUS.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned in status.pipeline_id.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, @@ -3050,22 +3050,22 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "new_pipeline_spec": { - "description": "[Beta] Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", + "description": "[Beta] Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned in status.pipeline_id.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", "x-databricks-launch-stage": "PUBLIC_BETA" }, "postgres_database": { - "description": "[Beta] The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog.", + "description": "[Beta] The name of the Postgres database where the synced table is created. A value must be specified\non creation. If the synced table is created inside a Lakebase catalog, the value must match the\nPostgres database of that catalog.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, "primary_key_columns": { - "description": "[Beta] Primary Key columns to be used for data insert/update in the destination.", + "description": "[Beta] Primary Key columns to be used for data insert/update in the destination. At least one column\nmust be specified.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, "scheduling_policy": { - "description": "[Beta] Scheduling policy of the underlying pipeline.", + "description": "[Beta] Scheduling policy of the underlying pipeline. A value must be specified on creation. See\nhttps://docs.databricks.com/aws/en/oltp/projects/sync-tables for how to choose a sync mode.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", "x-databricks-launch-stage": "PUBLIC_BETA" }, @@ -3303,7 +3303,7 @@ "x-databricks-launch-stage": "GA" }, "custom_max_retention_hours": { - "description": "[Public Preview] Custom maximum retention period in hours for the schema.", + "description": "[Public Preview] Dropped objects in the schema remain recoverable for this number of hours before they are permanently\npurged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set\ntheir own value inherit the parent catalog's value.", "$ref": "#/$defs/int64", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, @@ -3327,7 +3327,7 @@ "x-databricks-launch-stage": "GA" }, "storage_root": { - "description": "Storage root URL for managed tables within schema.", + "description": "Managed tables and volumes in the schema are stored under this storage root URL. The path must be\ninside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted,\nmanaged data is stored under the parent catalog's storage root, or under the metastore's root storage\nlocation when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and\nschemas in a federated Hive metastore catalog must set one.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -3502,7 +3502,7 @@ "description": "Creates a new SQL warehouse.", "properties": { "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", + "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 1 min for serverless warehouses.\n- Must be == 0 or \u003e= 10 mins for classic and pro warehouses.\n- 0 indicates no autostop.\n\nDefaults to 120 mins", "$ref": "#/$defs/int", "x-databricks-launch-stage": "GA" }, @@ -3580,9 +3580,9 @@ "x-databricks-launch-stage": "GA" }, "statement_timeout": { - "description": "[Beta] Warehouse statement timeout in seconds.", + "description": "[Public Preview] Warehouse statement timeout in seconds.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA" + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "tags": { "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", @@ -3791,7 +3791,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "index_type": { - "description": "There are 2 types of AI Search indexes:\n- `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.\n- `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.", + "description": "Type of index to create, which determines which spec field is required.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType", "x-databricks-launch-stage": "GA" }, @@ -3800,12 +3800,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "Name of the index", + "description": "Three-level Unity Catalog name of the index to create.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "primary_key": { - "description": "Primary key of the index", + "description": "Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of\nthe source table; for a Direct Vector Access index it must be declared in `schema_json`. It\ncannot be the embedding source or embedding vector column.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -6103,27 +6103,27 @@ "x-databricks-launch-stage": "GA" }, "amazon_bedrock": { - "description": "Amazon Bedrock provider configuration.", + "description": "Configuration for Amazon Bedrock. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", "x-databricks-launch-stage": "GA" }, "anthropic": { - "description": "Anthropic provider configuration. Exactly one of `direct` or `relayed` must\nbe set on Create; the two are mutually exclusive.", + "description": "Configuration for Anthropic. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAnthropicProviderConfig", "x-databricks-launch-stage": "GA" }, "azure_openai": { - "description": "Azure OpenAI provider configuration.", + "description": "Configuration for Azure OpenAI. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAzureOpenAiProviderConfig", "x-databricks-launch-stage": "GA" }, "bedrock_mantle": { - "description": "Amazon Bedrock provider configuration.", + "description": "Configuration for Amazon Bedrock Mantle, with the same fields as\n`amazon_bedrock`. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", "x-databricks-launch-stage": "GA" }, "custom": { - "description": "Custom OpenAI-compatible provider configuration.", + "description": "Configuration for a custom OpenAI-compatible provider. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderConfig", "x-databricks-launch-stage": "GA" }, @@ -6143,7 +6143,7 @@ "x-databricks-launch-stage": "GA" }, "gemini_enterprise": { - "description": "Gemini Enterprise provider configuration.", + "description": "Configuration for Google Gemini Enterprise. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig", "x-databricks-launch-stage": "GA" }, @@ -6153,12 +6153,12 @@ "x-databricks-launch-stage": "GA" }, "microsoft_foundry": { - "description": "Microsoft Foundry provider configuration.", + "description": "Configuration for Microsoft Foundry. Set this field when\n`provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigMicrosoftFoundryProviderConfig", "x-databricks-launch-stage": "GA" }, "openai": { - "description": "OpenAI provider configuration.", + "description": "Configuration for OpenAI. Set this field when `provider_type` is\n`EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigOpenAiProviderConfig", "x-databricks-launch-stage": "GA" }, @@ -6391,7 +6391,7 @@ "x-databricks-launch-stage": "GA" }, "api_key_value": { - "description": "Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supplied as inline plaintext via `ProviderSecret.plaintext`.", + "description": "Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supply the value in `api_key_value.plaintext`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", "x-databricks-launch-stage": "GA" } @@ -6726,7 +6726,7 @@ "description": "A secret value supplied as part of an inline provider config. The caller\nsupplies the value as inline `plaintext` on writes; the platform stores it\nencrypted. The `plaintext` field is `INPUT_ONLY` and never round-trips on\nreads.", "properties": { "plaintext": { - "description": "Inline plaintext credential. INPUT_ONLY: the value never round-trips on\nreads. Get and List responses omit `plaintext`; the enclosing secret\nobject remains present to indicate that a secret is configured.", + "description": "Inline plaintext credential. The value is write-only and never\nround-trips on reads. Get and List responses omit `plaintext`; the\nenclosing secret object remains present to indicate that a secret is\nconfigured.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -7775,7 +7775,7 @@ "x-databricks-launch-stage": "GA" }, "log_analytics_info": { - "description": "Defines values necessary to configure and run Azure Log Analytics agent", + "description": "Defines values necessary to configure and run Azure Log Analytics agent.\nBoth `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo", "x-databricks-launch-stage": "GA" }, @@ -7913,7 +7913,7 @@ "x-databricks-launch-stage": "GA" }, "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", + "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 43200 minutes (30 days).\nUsers can also set this value to 0 to explicitly disable automatic termination.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "GA" }, @@ -7943,7 +7943,7 @@ "x-databricks-launch-stage": "GA" }, "data_security_mode": { - "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-databricks-launch-stage": "GA" }, @@ -7953,7 +7953,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "docker_image": { - "description": "Custom docker image BYOC", + "description": "Custom Docker image for the cluster's nodes, used with\n[Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-databricks-launch-stage": "GA" }, @@ -8003,7 +8003,7 @@ "x-databricks-launch-stage": "GA" }, "kind": { - "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", "x-databricks-launch-stage": "GA" }, @@ -8073,7 +8073,7 @@ "x-databricks-launch-stage": "GA" }, "workload_type": { - "description": "Cluster Attributes showing for clusters workload types.", + "description": "Types of workloads that can use the cluster, such as notebooks or jobs.\nIf omitted, the cluster can be used for both notebooks and jobs.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-databricks-launch-stage": "GA" } @@ -8290,12 +8290,12 @@ "type": "object", "properties": { "password": { - "description": "Password of the user", + "description": "Password for authenticating to the Docker registry that hosts the image.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "username": { - "description": "Name of the user", + "description": "User name for authenticating to the Docker registry that hosts the image.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -8736,14 +8736,15 @@ "oneOf": [ { "type": "object", + "description": "A library to install on a cluster. Exactly one of the library-type fields must be set.", "properties": { "cran": { - "description": "Specification of a CRAN library to be installed as part of the library", + "description": "Specification of a CRAN library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RCranLibrary", "x-databricks-launch-stage": "GA" }, "egg": { - "description": "Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.", + "description": "Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above.\nUse a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file\nto install.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", @@ -8760,12 +8761,12 @@ "x-databricks-launch-stage": "GA" }, "pypi": { - "description": "Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", + "description": "Specification of a PyPI library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.PythonPyPiLibrary", "x-databricks-launch-stage": "GA" }, "requirements": { - "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`", + "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`.\nInstalling a requirements file requires Databricks Runtime 15.0 or above.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -8840,7 +8841,7 @@ "x-databricks-launch-stage": "GA" }, "exclusions": { - "description": "List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", + "description": "List of dependencies to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA" }, @@ -8892,7 +8893,7 @@ "type": "object", "properties": { "package": { - "description": "The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", + "description": "The name of the PyPI package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -11264,6 +11265,7 @@ "x-databricks-launch-stage": "GA" }, "sparse_checkout": { + "description": "Sparse checkout settings for the repository. When set, only the directories listed in `patterns` are checked out.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparseCheckout", "x-databricks-launch-stage": "GA" } @@ -11400,7 +11402,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "workspace_id": { - "description": "[Beta] The ID of the workspace containing the upstream job.\nThis can differ from the caller's workspace and downstream services enforce\ncorrect entitlements and CAN_VIEW permissions for the user + job combination.\nSDR: https://databricks.atlassian.net/browse/SDR-5267", + "description": "[Beta] The ID of the workspace containing the upstream job.\nThis can differ from the caller's workspace and downstream services enforce\ncorrect entitlements and CAN_VIEW permissions for the user + job combination.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" } @@ -11551,7 +11553,7 @@ "x-databricks-launch-stage": "GA" }, "spec": { - "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", + "description": "The environment specification, including the environment version and the dependencies to install before a task runs.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment", "x-databricks-launch-stage": "GA" } @@ -11859,6 +11861,7 @@ "description": "An optional set of health rules that can be defined for this job.", "properties": { "rules": { + "description": "The health rules to evaluate for each run.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule", "x-databricks-launch-stage": "GA" } @@ -12663,7 +12666,7 @@ "type": "object", "properties": { "patterns": { - "description": "List of patterns to include for sparse checkout.", + "description": "List of patterns to include for sparse checkout. Each pattern is the path of a directory relative to the repository root.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA" } @@ -12682,7 +12685,7 @@ "type": "object", "properties": { "sql_query_id": { - "description": "[Beta] The ID of the SQL query to evaluate as the trigger condition.", + "description": "[Beta] The ID of the SQL query to evaluate as the trigger condition.\nExactly one of `sql_query_id` or `file` must be set.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA" }, @@ -12699,7 +12702,6 @@ }, "additionalProperties": false, "required": [ - "sql_query_id", "warehouse_id" ] }, @@ -13291,7 +13293,7 @@ "doNotSuggest": true }, "health": { - "description": "An optional set of health rules that can be defined for this job.", + "description": "An optional set of health rules that can be defined for this task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", "x-databricks-launch-stage": "GA" }, @@ -13641,6 +13643,7 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "table_update": { + "description": "Table update trigger settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", "x-databricks-launch-stage": "GA" } @@ -13682,6 +13685,7 @@ "type": "object", "properties": { "id": { + "description": "The ID of the notification destination to call. Must be a UUID.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -14350,12 +14354,12 @@ "description": "A tag for an experiment.", "properties": { "key": { - "description": "The tag key.", + "description": "The tag key. Keys are at most 255 characters long.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, "value": { - "description": "The tag value.", + "description": "The tag value. Values are at most 65535 characters long.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -15298,6 +15302,19 @@ } ] }, + "ml.MaterializedFeatureOperations": { + "oneOf": [ + { + "type": "object", + "description": "References to operations on a materialized feature.", + "additionalProperties": false + }, + { + "type": "string", + "pattern": "\\$\\{(var(\\._*\\p{L}+([-_]*[\\p{L}\\p{N}]+)*(\\[[0-9]+\\])*)+)\\}" + } + ] + }, "ml.MaterializedFeaturePipelineScheduleState": { "oneOf": [ { @@ -16431,9 +16448,9 @@ "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "tiktok_ads_options": { - "description": "[Beta] TikTok Ads specific options for ingestion", + "description": "[Public Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", - "x-databricks-launch-stage": "PUBLIC_BETA" + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "zendesk_support_options": { "description": "[Public Preview] Zendesk Support specific options for ingestion", @@ -17261,6 +17278,7 @@ "JIRA", "CONFLUENCE", "META_MARKETING", + "GOOGLE_ADS", "TIKTOK_ADS", "ZENDESK", "SMARTSHEET", @@ -17287,7 +17305,8 @@ "[Beta]", "[Public Preview]", "[Beta]", - "[Beta]", + "[Private Preview]", + "[Public Preview]", "[Public Preview]", "[Public Preview]", "[Beta]", @@ -19038,49 +19057,49 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "data_level": { - "description": "[Beta] Deprecated. Use custom_report_options.data_level instead.", + "description": "[Public Preview] Deprecated. Use custom_report_options.data_level instead.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "dimensions": { - "description": "[Beta] Deprecated. Use custom_report_options.dimensions instead.", + "description": "[Public Preview] Deprecated. Use custom_report_options.dimensions instead.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "lookback_window_days": { - "description": "[Beta] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.", + "description": "[Public Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA" + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "metrics": { - "description": "[Beta] Deprecated. Use custom_report_options.metrics instead.", + "description": "[Public Preview] Deprecated. Use custom_report_options.metrics instead.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "query_lifetime": { - "description": "[Beta] Deprecated. Use custom_report_options.query_lifetime instead.", + "description": "[Public Preview] Deprecated. Use custom_report_options.query_lifetime instead.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "report_type": { - "description": "[Beta] Deprecated. Use custom_report_options.report_type instead.", + "description": "[Public Preview] Deprecated. Use custom_report_options.report_type instead.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "sync_start_date": { - "description": "[Beta] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.", + "description": "[Public Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_BETA" + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -19143,10 +19162,10 @@ "AUCTION_AD" ], "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]" + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -19169,12 +19188,12 @@ "GMV_MAX" ], "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]" + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -21798,12 +21817,12 @@ "x-databricks-launch-stage": "GA" }, "embedding_source_columns": { - "description": "The columns that contain the embedding source.", + "description": "The source table column whose text Databricks embeds, together with the embedding model\nendpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of\n`embedding_source_columns` or `embedding_vector_columns` must be specified unless the index\nsubtype is `FULL_TEXT`, and only one column is supported.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-databricks-launch-stage": "GA" }, "embedding_vector_columns": { - "description": "The columns that contain the embedding vectors.", + "description": "The source table column that contains precomputed embedding vectors. Set this instead of\n`embedding_source_columns` for an index with self-managed embeddings.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-databricks-launch-stage": "GA" }, @@ -21818,7 +21837,7 @@ "x-databricks-launch-stage": "GA" }, "source_table": { - "description": "The name of the source table.", + "description": "Three-level Unity Catalog name of the source table that the index is synced from.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21837,17 +21856,17 @@ "type": "object", "properties": { "embedding_source_columns": { - "description": "The columns that contain the embedding source. The format should be array[double].", + "description": "Embedding source configuration used to embed `query_text` when the index is queried with text,\nnaming the embedding model endpoint to use. The index stores the vectors you supply through\nupsert; this setting never computes embeddings for them.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-databricks-launch-stage": "GA" }, "embedding_vector_columns": { - "description": "The columns that contain the embedding vectors. The format should be array[double].", + "description": "The column that holds the embedding vectors you write to the index. Exactly one column must be\nspecified, and `schema_json` must declare it as `array\u003cfloat\u003e` or `array\u003cdouble\u003e`.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-databricks-launch-stage": "GA" }, "schema_json": { - "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", + "description": "JSON object that maps each column name of the index to its type, serialized to a string. The\nprimary key and the embedding vector column must be present.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21876,7 +21895,7 @@ "x-databricks-launch-stage": "GA" }, "name": { - "description": "Name of the column", + "description": "Name of the column that contains the text to embed.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } @@ -21900,7 +21919,7 @@ "x-databricks-launch-stage": "GA" }, "name": { - "description": "Name of the column", + "description": "Name of the column that contains the embedding vectors.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" } diff --git a/cmd/account/budget-policy/budget-policy.go b/cmd/account/budget-policy/budget-policy.go index f445489d3ca..1b22a18465c 100644 --- a/cmd/account/budget-policy/budget-policy.go +++ b/cmd/account/budget-policy/budget-policy.go @@ -76,7 +76,8 @@ func newCreate() *cobra.Command { Create a budget policy. - Creates a new policy.` + Creates a new usage policy. The creator is granted the manager role on the new + policy.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -145,7 +146,7 @@ func newDelete() *cobra.Command { Delete a budget policy. - Deletes a policy + Deletes a usage policy. Arguments: POLICY_ID: The Id of the policy.` @@ -205,7 +206,7 @@ func newGet() *cobra.Command { Get a budget policy. - Retrieves a policy by it's ID. + Retrieves a usage policy by its ID. Arguments: POLICY_ID: The Id of the policy.` @@ -281,8 +282,9 @@ func newList() *cobra.Command { List policies. - Lists all policies. Policies are returned in the alphabetically ascending - order of their names.` + Lists the usage policies that the caller has permission to view. Policies are + sorted by name in ascending order unless sort_spec requests a different + order.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -350,7 +352,8 @@ func newUpdate() *cobra.Command { Update a budget policy. - Updates a policy + Updates a usage policy. Changes apply only to serverless usage that starts + after the update, not to workloads that are already running. Arguments: POLICY_ID: The Id of the policy. This field is generated by Databricks and globally diff --git a/cmd/account/disaster-recovery/disaster-recovery.go b/cmd/account/disaster-recovery/disaster-recovery.go index 81a7a9d71a1..d36a1264f13 100644 --- a/cmd/account/disaster-recovery/disaster-recovery.go +++ b/cmd/account/disaster-recovery/disaster-recovery.go @@ -83,16 +83,23 @@ func newCreateFailoverGroup() *cobra.Command { cmd.Short = `Create a Failover Group.` cmd.Long = `Create a Failover Group. - Create a new failover group. + Create a failover group. The group starts in the CREATING state and moves to + INITIAL_REPLICATION while the first replication cycle copies all in-scope data + to the secondary region; failover becomes available once the group is ACTIVE. + Set validate_only to check the request without creating anything. Arguments: PARENT: The parent resource. Format: accounts/{account_id}. FAILOVER_GROUP_ID: Client-provided identifier for the failover group. Used to construct the resource name as {parent}/failover-groups/{failover_group_id}. - REGIONS: List of all regions participating in this failover group. - WORKSPACE_SETS: Workspace sets, each containing workspaces that replicate to each other. + REGIONS: The two cloud regions that participate in this failover group, the primary + and the secondary. Each workspace set contains one workspace in each + region. + WORKSPACE_SETS: Workspace sets, each containing workspaces that replicate to each other. A + failover group currently supports exactly one workspace set. INITIAL_PRIMARY_REGION: Initial primary region. Used only in Create requests to set the starting - primary region. Not returned in responses.` + primary region, and must be one of the regions in regions. Not returned + in responses.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -281,7 +288,8 @@ func newDeleteFailoverGroup() *cobra.Command { cmd.Short = `Delete a Failover Group.` cmd.Long = `Delete a Failover Group. - Delete a failover group. + Delete a failover group. Deleting stops replication for the group; stable URLs + linked to it are detached but not deleted. Arguments: NAME: The fully qualified resource name of the failover group to delete. Format: @@ -404,7 +412,15 @@ func newFailoverFailoverGroup() *cobra.Command { cmd.Short = `Failover a Failover Group to a new primary region.` cmd.Long = `Failover a Failover Group to a new primary region. - Initiate a failover to a new primary region. + Initiate a failover that makes target_primary_region the primary region. + Stable URLs linked to the group are pointed at the new primary workspace, + replication is reversed so that the former primary becomes the secondary, and + the group moves through FAILING_OVER to INITIAL_REPLICATION until it has a + replication point in the new direction. The group must be ACTIVE; repeating + the request while it is FAILING_OVER is accepted. To fail back, repeat the + request with the former primary region as the target once the group is ACTIVE + again. In an unplanned failover, data written after the replication point can + be lost. Arguments: NAME: The fully qualified resource name of the failover group to failover. @@ -412,7 +428,7 @@ func newFailoverFailoverGroup() *cobra.Command { TARGET_PRIMARY_REGION: The target primary region. Must be one of the participating regions and different from the current effective_primary_region. Serves as an idempotency check. - FAILOVER_TYPE: The type of failover to perform. + FAILOVER_TYPE: The type of failover to perform. FORCED is the only supported type. Supported values: [FORCED]` cmd.Annotations = make(map[string]string) @@ -498,7 +514,7 @@ func newGetFailoverGroup() *cobra.Command { cmd.Short = `Get a Failover Group.` cmd.Long = `Get a Failover Group. - Get a failover group. + Get a failover group, including its current state and replication point. Arguments: NAME: The fully qualified resource name of the failover group. Format: @@ -631,10 +647,11 @@ func newListFailoverGroups() *cobra.Command { cmd.Short = `List Failover Groups.` cmd.Long = `List Failover Groups. - List failover groups. + List the failover groups in an account. - List entries are abbreviated: state and replication_point are not - populated. Call GetFailoverGroup to retrieve the full resource. + List entries are abbreviated: state, replication_point and + unity_catalog_assets.location_mappings are not populated. Call + GetFailoverGroup to retrieve the full resource. Arguments: PARENT: The parent resource. Format: accounts/{account_id}.` @@ -780,16 +797,27 @@ func newUpdateFailoverGroup() *cobra.Command { cmd.Short = `Update a Failover Group.` cmd.Long = `Update a Failover Group. - Update a failover group. + Update a failover group. Only the fields named in update_mask change. You can + turn workspace asset replication on or off, attach or detach a stable URL, and + change the Unity Catalog catalogs and location mappings; the regions, the + workspace set name and the workspace IDs cannot be changed. Updates are + rejected while a create, failover or delete is in progress, and after a create + or delete has failed. Arguments: NAME: Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}. - UPDATE_MASK: Comma-separated list of fields to update. - REGIONS: List of all regions participating in this failover group. - WORKSPACE_SETS: Workspace sets, each containing workspaces that replicate to each other. + UPDATE_MASK: Comma-separated list of the fields to update. The supported paths are + workspace_sets, unity_catalog_assets, unity_catalog_assets.catalogs + and unity_catalog_assets.location_mappings; any other path is rejected. + REGIONS: The two cloud regions that participate in this failover group, the primary + and the secondary. Each workspace set contains one workspace in each + region. + WORKSPACE_SETS: Workspace sets, each containing workspaces that replicate to each other. A + failover group currently supports exactly one workspace set. INITIAL_PRIMARY_REGION: Initial primary region. Used only in Create requests to set the starting - primary region. Not returned in responses.` + primary region, and must be one of the regions in regions. Not returned + in responses.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/account/groups-v2/groups-v2.go b/cmd/account/groups-v2/groups-v2.go index 1dd7db79e7c..ca2b4f6d4ed 100644 --- a/cmd/account/groups-v2/groups-v2.go +++ b/cmd/account/groups-v2/groups-v2.go @@ -72,9 +72,9 @@ 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, `String that represents a human-readable group name.`) - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks group ID.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `Sets the human-readable name of the group.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Sets the identifier of the group in an external identity provider.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Identifies the group within Databricks.`) // TODO: array: members // TODO: complex arg: meta // TODO: array: roles @@ -357,7 +357,7 @@ func newPatch() *cobra.Command { Partially updates the details of a group. Arguments: - ID: Unique ID in the Databricks workspace.` + ID: Unique ID for a group in the Databricks account.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -423,8 +423,8 @@ 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.DisplayName, "display-name", updateReq.DisplayName, `String that represents a human-readable group name.`) - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `Sets the human-readable name of the group.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Sets the identifier of the group in an external identity provider.`) // TODO: array: members // TODO: complex arg: meta // TODO: array: roles @@ -436,7 +436,7 @@ func newUpdate() *cobra.Command { Updates the details of a group by replacing the entire group entity. Arguments: - ID: Databricks group ID` + ID: Identifies the group within Databricks.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/account/iam-v2/iam-v2.go b/cmd/account/iam-v2/iam-v2.go index e8bc3fa116b..5b0eaf45919 100644 --- a/cmd/account/iam-v2/iam-v2.go +++ b/cmd/account/iam-v2/iam-v2.go @@ -203,7 +203,7 @@ func newCreateGroup() *cobra.Command { cmd.Flags().Var(&createGroupJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().StringVar(&createGroupReq.Group.ExternalId, "external-id", createGroupReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) - cmd.Flags().StringVar(&createGroupReq.Group.GroupName, "group-name", createGroupReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&createGroupReq.Group.GroupName, "group-name", createGroupReq.Group.GroupName, `The display name of the group.`) cmd.Flags().StringVar(&createGroupReq.Group.Name, "name", createGroupReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "create-group PARENT" @@ -2829,7 +2829,7 @@ func newUpdateGroup() *cobra.Command { cmd.Flags().Var(&updateGroupJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().StringVar(&updateGroupReq.Group.ExternalId, "external-id", updateGroupReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) - cmd.Flags().StringVar(&updateGroupReq.Group.GroupName, "group-name", updateGroupReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&updateGroupReq.Group.GroupName, "group-name", updateGroupReq.Group.GroupName, `The display name of the group.`) cmd.Flags().StringVar(&updateGroupReq.Group.Name, "name", updateGroupReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "update-group NAME UPDATE_MASK" diff --git a/cmd/account/service-principals-v2/service-principals-v2.go b/cmd/account/service-principals-v2/service-principals-v2.go index 660420f429f..044469f91d5 100644 --- a/cmd/account/service-principals-v2/service-principals-v2.go +++ b/cmd/account/service-principals-v2/service-principals-v2.go @@ -71,11 +71,11 @@ func newCreate() *cobra.Command { cmd.Flags().Var(&createJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `String that represents a concatenation of given and family names.`) - cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, ``) - cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Databricks service principal ID.`) + cmd.Flags().BoolVar(&createReq.Active, "active", createReq.Active, `Indicates whether the service principal is active.`) + cmd.Flags().StringVar(&createReq.ApplicationId, "application-id", createReq.ApplicationId, `Sets the application ID of a Microsoft Entra ID service principal.`) + cmd.Flags().StringVar(&createReq.DisplayName, "display-name", createReq.DisplayName, `Sets the human-readable name of the service principal.`) + cmd.Flags().StringVar(&createReq.ExternalId, "external-id", createReq.ExternalId, `Sets the identifier of the service principal in an external identity provider.`) + cmd.Flags().StringVar(&createReq.Id, "id", createReq.Id, `Identifies the service principal within Databricks.`) // TODO: array: roles cmd.Use = "create" @@ -149,7 +149,7 @@ func newDelete() *cobra.Command { cmd.Short = `Delete a service principal.` cmd.Long = `Delete a service principal. - Delete a single service principal in the Databricks account. + Deletes a single service principal from the Databricks account. Arguments: ID: Unique ID for a service principal in the Databricks account.` @@ -207,8 +207,7 @@ func newGet() *cobra.Command { cmd.Short = `Get service principal details.` cmd.Long = `Get service principal details. - Gets the details for a single service principal define in the Databricks - account. + Gets the details for a single service principal in the Databricks account. Arguments: ID: Unique ID for a service principal in the Databricks account.` @@ -353,7 +352,7 @@ func newPatch() *cobra.Command { account. Arguments: - ID: Unique ID in the Databricks workspace.` + ID: Unique ID for a service principal in the Databricks account.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -419,10 +418,10 @@ 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.Active, "active", updateReq.Active, `If this user is active.`) - cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `UUID relating to the service principal.`) - cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `String that represents a concatenation of given and family names.`) - cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, ``) + cmd.Flags().BoolVar(&updateReq.Active, "active", updateReq.Active, `Indicates whether the service principal is active.`) + cmd.Flags().StringVar(&updateReq.ApplicationId, "application-id", updateReq.ApplicationId, `Sets the application ID of a Microsoft Entra ID service principal.`) + cmd.Flags().StringVar(&updateReq.DisplayName, "display-name", updateReq.DisplayName, `Sets the human-readable name of the service principal.`) + cmd.Flags().StringVar(&updateReq.ExternalId, "external-id", updateReq.ExternalId, `Sets the identifier of the service principal in an external identity provider.`) // TODO: array: roles cmd.Use = "update ID" @@ -431,10 +430,10 @@ func newUpdate() *cobra.Command { Updates the details of a single service principal. - This action replaces the existing service principal with the same name. + This action replaces the existing service principal that has the given ID. Arguments: - ID: Databricks service principal ID.` + ID: Identifies the service principal within Databricks.` 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 1e1b9c5e252..5c61de2d5dc 100644 --- a/cmd/workspace/agent-kit/agent-kit.go +++ b/cmd/workspace/agent-kit/agent-kit.go @@ -361,12 +361,14 @@ func newCreateMemoryStore() *cobra.Command { Create a memory store. - Creates a memory store in the caller's workspace. + Creates a memory store in the caller's workspace. Returns ALREADY_EXISTS + when a store with the requested ID already exists. Arguments: MANAGED_MEMORY_STORE_ID: Caller-provided, workspace-unique memory store ID. It must be 3-56 characters, begin with a lowercase letter, contain only lowercase letters, - digits, and hyphens, and end with a letter or digit.` + digits, and hyphens, and end with a letter or digit. It becomes the last + segment of the store's name and cannot be changed after creation.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -679,8 +681,9 @@ func newDeleteMemoryStore() *cobra.Command { Delete a memory store by resource name. - Deletes a memory store by resource name. Returns NOT_FOUND when the store - does not exist in the caller's workspace. + Deletes a memory store by resource name. Deleting a store also deletes all of + its memory entries, and its ID becomes available for reuse. Returns + NOT_FOUND when the store does not exist in the caller's workspace. Arguments: NAME: Resource name in the form memory-stores/{managed_memory_store_id}.` @@ -2591,8 +2594,9 @@ Update a memory store. Arguments: NAME: Resource name in the form memory-stores/{managed_memory_store_id}. - UPDATE_MASK: Only description and metadata may be updated. Selecting metadata - replaces the entire map.` + UPDATE_MASK: Only description and metadata may be updated. Selecting description + while leaving it unset clears it. Selecting metadata replaces the entire + map.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" diff --git a/cmd/workspace/ai-gateway/ai-gateway.go b/cmd/workspace/ai-gateway/ai-gateway.go index e02146d64e1..78f0df83a5d 100644 --- a/cmd/workspace/ai-gateway/ai-gateway.go +++ b/cmd/workspace/ai-gateway/ai-gateway.go @@ -112,7 +112,9 @@ func newCreateMcpService() *cobra.Command { Arguments: PARENT: Name of the parent schema. Format: schemas/{catalog}.{schema}. Each {...} component is capped at 255 characters individually. - MCP_SERVICE_ID: Name for the MCP service, e.g. "my_mcp_service".` + MCP_SERVICE_ID: Name of the MCP service within the parent schema. The name must not + contain periods, spaces, forward slashes, percent signs, or control + characters, and it is stored in lowercase.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -289,7 +291,10 @@ func newCreateModelProviderService() *cobra.Command { Arguments: PARENT: Name of the parent schema. Format: schemas/{catalog}.{schema}. Each {...} component is capped at 255 characters individually. - MODEL_PROVIDER_SERVICE_ID: Name for the model provider service, e.g. "openai_prod".` + MODEL_PROVIDER_SERVICE_ID: Name of the model provider service within the parent schema. The name must + not contain periods, spaces, forward slashes, percent signs, or control + characters, must not end in _DO_NOT_MODIFY, and must not exceed 241 + characters. It is stored in lowercase.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1639,8 +1644,9 @@ func newUpdateMcpService() *cobra.Command { Arguments: NAME: Resource name of the MCP service. Format: mcp-services/{catalog}.{schema}.{mcp_service}. Each {...} component is - capped at 255 characters individually. Server-derived on Create from - parent + mcp_service_id; required and immutable on Update/Get/Delete. + capped at 255 characters individually. The server derives the name on + Create from parent and mcp_service_id; it is required and immutable on + Update, Get, and Delete. UPDATE_MASK: Fields to update. Use config to replace the entire configuration. The replacement must include every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: @@ -1742,9 +1748,10 @@ func newUpdateModelProviderService() *cobra.Command { Arguments: NAME: Resource name of the provider service. Format: model-provider-services/{catalog}.{schema}.{model_provider_service}. - Each {...} component is capped at 255 characters individually. - Server-derived on Create from parent + model_provider_service_id; - required and immutable on Update/Get/Delete. + Each {...} component is capped at 255 characters individually. The + server derives the name on Create from parent and + model_provider_service_id; it is required and immutable on Update, Get, + and Delete. UPDATE_MASK: Fields to update. Use config to replace the entire configuration. The replacement must include every required field; any optional field you omit is cleared. To preserve sibling fields, use one or more granular paths: diff --git a/cmd/workspace/ai-search/ai-search.go b/cmd/workspace/ai-search/ai-search.go index d66cf4000c7..dbd50fc29c2 100644 --- a/cmd/workspace/ai-search/ai-search.go +++ b/cmd/workspace/ai-search/ai-search.go @@ -82,16 +82,16 @@ func newCreateEndpoint() *cobra.Command { cmd.Flags().Var(&createEndpointJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createEndpointReq.EndpointId, "endpoint-id", createEndpointReq.EndpointId, `The user-supplied short name for the Endpoint, per AIP-133.`) - cmd.Flags().StringVar(&createEndpointReq.Endpoint.BudgetPolicyId, "budget-policy-id", createEndpointReq.Endpoint.BudgetPolicyId, `The user-selected budget policy id for the endpoint.`) + cmd.Flags().StringVar(&createEndpointReq.EndpointId, "endpoint-id", createEndpointReq.EndpointId, `Short name of the endpoint, which becomes the last segment of name.`) + cmd.Flags().StringVar(&createEndpointReq.Endpoint.BudgetPolicyId, "budget-policy-id", createEndpointReq.Endpoint.BudgetPolicyId, `ID of the serverless budget policy to apply to the endpoint.`) // TODO: array: custom_tags // TODO: complex arg: endpoint_status - cmd.Flags().StringVar(&createEndpointReq.Endpoint.Name, "name", createEndpointReq.Endpoint.Name, `Name of the AI Search endpoint.`) + cmd.Flags().StringVar(&createEndpointReq.Endpoint.Name, "name", createEndpointReq.Endpoint.Name, `Full resource name of the endpoint, in the form workspaces/{workspace_id}/endpoints/{endpoint_id}.`) cmd.Flags().IntVar(&createEndpointReq.Endpoint.ReplicaCount, "replica-count", createEndpointReq.Endpoint.ReplicaCount, `The client-supplied desired number of replicas for the endpoint, applied at create/update time.`) // TODO: complex arg: scaling_info cmd.Flags().IntVar(&createEndpointReq.Endpoint.TargetQps, "target-qps", createEndpointReq.Endpoint.TargetQps, `Target QPS for the endpoint.`) // TODO: complex arg: throughput_info - cmd.Flags().StringVar(&createEndpointReq.Endpoint.UsagePolicyId, "usage-policy-id", createEndpointReq.Endpoint.UsagePolicyId, `The usage policy id applied to the endpoint.`) + 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.` @@ -540,7 +540,7 @@ func newListEndpoints() *cobra.Command { // branches, so the method-call path is always reached. var listEndpointsLimit int - cmd.Flags().IntVar(&listEndpointsReq.PageSize, "page-size", listEndpointsReq.PageSize, `Best-effort upper bound on the number of results to return.`) + cmd.Flags().IntVar(&listEndpointsReq.PageSize, "page-size", listEndpointsReq.PageSize, `Maximum number of endpoints to return in one page.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listEndpointsLimit, "limit", 0, `Maximum number of results to return.`) @@ -1012,15 +1012,15 @@ func newUpdateEndpoint() *cobra.Command { cmd.Flags().Var(&updateEndpointJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateEndpointReq.Endpoint.BudgetPolicyId, "budget-policy-id", updateEndpointReq.Endpoint.BudgetPolicyId, `The user-selected budget policy id for the endpoint.`) + cmd.Flags().StringVar(&updateEndpointReq.Endpoint.BudgetPolicyId, "budget-policy-id", updateEndpointReq.Endpoint.BudgetPolicyId, `ID of the serverless budget policy to apply to the endpoint.`) // TODO: array: custom_tags // TODO: complex arg: endpoint_status - cmd.Flags().StringVar(&updateEndpointReq.Endpoint.Name, "name", updateEndpointReq.Endpoint.Name, `Name of the AI Search endpoint.`) + cmd.Flags().StringVar(&updateEndpointReq.Endpoint.Name, "name", updateEndpointReq.Endpoint.Name, `Full resource name of the endpoint, in the form workspaces/{workspace_id}/endpoints/{endpoint_id}.`) cmd.Flags().IntVar(&updateEndpointReq.Endpoint.ReplicaCount, "replica-count", updateEndpointReq.Endpoint.ReplicaCount, `The client-supplied desired number of replicas for the endpoint, applied at create/update time.`) // TODO: complex arg: scaling_info cmd.Flags().IntVar(&updateEndpointReq.Endpoint.TargetQps, "target-qps", updateEndpointReq.Endpoint.TargetQps, `Target QPS for the endpoint.`) // TODO: complex arg: throughput_info - cmd.Flags().StringVar(&updateEndpointReq.Endpoint.UsagePolicyId, "usage-policy-id", updateEndpointReq.Endpoint.UsagePolicyId, `The usage policy id applied to the endpoint.`) + 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.` @@ -1028,19 +1028,19 @@ func newUpdateEndpoint() *cobra.Command { Update an AI Search endpoint. - Update an existing AI Search endpoint. Multi-bucket masks are supported and - dispatched in deterministic bucket order: budget policy, custom tags, - throughput, scaling/replicas, then metrics export. Per-bucket dispatch is not - atomic across buckets — if a later bucket fails, earlier buckets may already - have been applied. + 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 + budget_policy_id and custom_tags, one setting at a time, so if a later + setting fails, the earlier ones may already have been applied. Arguments: - NAME: Name of the AI Search endpoint. Server-assigned full resource path - (workspaces/{workspace}/endpoints/{endpoint}) on output. On create, the - user-supplied short name is conveyed via - CreateEndpointRequest.endpoint_id; the server composes the full name - and returns it on the response. - UPDATE_MASK: The list of fields to update. + NAME: Full resource name of the endpoint, in the form + workspaces/{workspace_id}/endpoints/{endpoint_id}. On create, the server + composes it from parent and endpoint_id and ignores any value supplied + in the request body. + UPDATE_MASK: Comma-separated list of Endpoint fields to update. The updatable fields + are budget_policy_id, usage_policy_id, custom_tags, replica_count, + and target_qps. The server rejects nested paths and unknown fields. ENDPOINT_TYPE: Type of endpoint. Required on create and immutable thereafter. Supported values: [STANDARD, STORAGE_OPTIMIZED]` diff --git a/cmd/workspace/clean-rooms/clean-rooms.go b/cmd/workspace/clean-rooms/clean-rooms.go index 76f8e0628ce..3199bfcb4ea 100644 --- a/cmd/workspace/clean-rooms/clean-rooms.go +++ b/cmd/workspace/clean-rooms/clean-rooms.go @@ -76,7 +76,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.CleanRoom.Comment, "comment", createReq.CleanRoom.Comment, ``) + cmd.Flags().StringVar(&createReq.CleanRoom.Comment, "comment", createReq.CleanRoom.Comment, `Free-form description of the clean room.`) cmd.Flags().BoolVar(&createReq.CleanRoom.EnableSharedOutput, "enable-shared-output", createReq.CleanRoom.EnableSharedOutput, `Whether allow task to write to shared output schema.`) cmd.Flags().StringVar(&createReq.CleanRoom.Name, "name", createReq.CleanRoom.Name, `The name of the clean room.`) // TODO: complex arg: output_catalog @@ -88,11 +88,11 @@ func newCreate() *cobra.Command { cmd.Long = `Create a clean room. Create a new clean room with the specified collaborators. This method is - asynchronous; the returned name field inside the clean_room field can be used - to poll the clean room status, using the [cleanrooms/get] method. When this - method returns, the clean room will be in a PROVISIONING state, with only - name, owner, comment, created_at and status populated. The clean room will be - usable once it enters an ACTIVE state. + asynchronous; the name field of the returned clean room can be used to poll + the clean room status, using the [cleanrooms/get] method. When this method + returns, the clean room will be in a PROVISIONING state, with only name, + owner, comment, created_at and status populated. The clean room will be usable + once it enters an ACTIVE state. The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the metastore. @@ -182,7 +182,10 @@ func newCreateOutputCatalog() *cobra.Command { cmd.Short = `Create an output catalog.` cmd.Long = `Create an output catalog. - Create the output catalog of the clean room. + Create the output catalog of the clean room. The output catalog is a catalog + in the caller's metastore where the output tables of the clean room runs that + the caller triggers are made available. Each collaborator can create one + output catalog per clean room, and the clean room must be ACTIVE. Arguments: CLEAN_ROOM_NAME: Name of the clean room.` @@ -314,7 +317,10 @@ func newGet() *cobra.Command { cmd.Short = `Get a clean room.` cmd.Long = `Get a clean room. - Get the details of a clean room given its name.` + Get the details of a clean room given its name. + + Arguments: + NAME: Name of the clean room.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go index 11b65b2e241..83f52af8e30 100644 --- a/cmd/workspace/clusters/clusters.go +++ b/cmd/workspace/clusters/clusters.go @@ -117,7 +117,7 @@ func newChangeOwner() *cobra.Command { be supplied as an argument to owner_username. Arguments: - CLUSTER_ID: + CLUSTER_ID: The ID of the cluster whose owner is changed. OWNER_USERNAME: New owner of the cluster_id after this RPC.` cmd.Annotations = make(map[string]string) @@ -211,7 +211,7 @@ func newCreate() *cobra.Command { // TODO: complex arg: cluster_log_conf cmd.Flags().StringVar(&createReq.ClusterName, "cluster-name", createReq.ClusterName, `Cluster name requested by the user.`) // TODO: map via StringToStringVar: custom_tags - cmd.Flags().Var(&createReq.DataSecurityMode, "data-security-mode", `Supported values: [ + cmd.Flags().Var(&createReq.DataSecurityMode, "data-security-mode", `Data security mode decides what data governance model to use when accessing data from a cluster. Supported values: [ DATA_SECURITY_MODE_AUTO, DATA_SECURITY_MODE_DEDICATED, DATA_SECURITY_MODE_STANDARD, @@ -234,7 +234,7 @@ func newCreate() *cobra.Command { // TODO: array: init_scripts cmd.Flags().StringVar(&createReq.InstancePoolId, "instance-pool-id", createReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs.`) cmd.Flags().BoolVar(&createReq.IsSingleNode, "is-single-node", createReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW.`) - cmd.Flags().Var(&createReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]`) + cmd.Flags().Var(&createReq.Kind, "kind", `The kind of compute described by this compute specification. Supported values: [CLASSIC_PREVIEW]`) cmd.Flags().StringVar(&createReq.NodeTypeId, "node-type-id", createReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster.`) cmd.Flags().IntVar(&createReq.NumWorkers, "num-workers", createReq.NumWorkers, `Number of worker nodes that this cluster should have.`) cmd.Flags().StringVar(&createReq.PolicyId, "policy-id", createReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable.`) @@ -495,7 +495,7 @@ func newEdit() *cobra.Command { // TODO: complex arg: cluster_log_conf cmd.Flags().StringVar(&editReq.ClusterName, "cluster-name", editReq.ClusterName, `Cluster name requested by the user.`) // TODO: map via StringToStringVar: custom_tags - cmd.Flags().Var(&editReq.DataSecurityMode, "data-security-mode", `Supported values: [ + cmd.Flags().Var(&editReq.DataSecurityMode, "data-security-mode", `Data security mode decides what data governance model to use when accessing data from a cluster. Supported values: [ DATA_SECURITY_MODE_AUTO, DATA_SECURITY_MODE_DEDICATED, DATA_SECURITY_MODE_STANDARD, @@ -518,7 +518,7 @@ func newEdit() *cobra.Command { // TODO: array: init_scripts cmd.Flags().StringVar(&editReq.InstancePoolId, "instance-pool-id", editReq.InstancePoolId, `The optional ID of the instance pool to which the cluster belongs.`) cmd.Flags().BoolVar(&editReq.IsSingleNode, "is-single-node", editReq.IsSingleNode, `This field can only be used when kind = CLASSIC_PREVIEW.`) - cmd.Flags().Var(&editReq.Kind, "kind", `Supported values: [CLASSIC_PREVIEW]`) + cmd.Flags().Var(&editReq.Kind, "kind", `The kind of compute described by this compute specification. Supported values: [CLASSIC_PREVIEW]`) cmd.Flags().StringVar(&editReq.NodeTypeId, "node-type-id", editReq.NodeTypeId, `This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster.`) cmd.Flags().IntVar(&editReq.NumWorkers, "num-workers", editReq.NumWorkers, `Number of worker nodes that this cluster should have.`) cmd.Flags().StringVar(&editReq.PolicyId, "policy-id", editReq.PolicyId, `The ID of the cluster policy used to create the cluster if applicable.`) @@ -1473,7 +1473,7 @@ func newRestart() *cobra.Command { cmd.Flags().Var(&restartJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&restartReq.RestartUser, "restart-user", restartReq.RestartUser, ``) + cmd.Flags().StringVar(&restartReq.RestartUser, "restart-user", restartReq.RestartUser, `User name recorded in the RESTARTING cluster event as the user who restarted the cluster.`) cmd.Use = "restart CLUSTER_ID" cmd.Short = `Restart cluster.` diff --git a/cmd/workspace/environments/environments.go b/cmd/workspace/environments/environments.go index 1950156c0d2..0f1efdfd9b8 100644 --- a/cmd/workspace/environments/environments.go +++ b/cmd/workspace/environments/environments.go @@ -89,7 +89,7 @@ func newCreateWorkspaceBaseEnvironment() *cobra.Command { cmd.Flags().StringVar(&createWorkspaceBaseEnvironmentReq.RequestId, "request-id", createWorkspaceBaseEnvironmentReq.RequestId, `A unique identifier for this request.`) cmd.Flags().StringVar(&createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironmentId, "workspace-base-environment-id", createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironmentId, `The ID to use for the workspace base environment, which will become the final component of the resource name.`) cmd.Flags().Var(&createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.BaseEnvironmentType, "base-environment-type", `The type of base environment (CPU or GPU). Supported values: [CPU, GPU]`) - cmd.Flags().StringVar(&createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, "filepath", createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, `The WSFS or UC Volumes path to the environment YAML file.`) + cmd.Flags().StringVar(&createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, "filepath", createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, `The workspace file or Unity Catalog volume path to the YAML file that defines the environment version and dependencies.`) cmd.Flags().StringVar(&createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Name, "name", createWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Name, `The resource name of the workspace base environment.`) // TODO: complex arg: spec @@ -100,7 +100,8 @@ func newCreateWorkspaceBaseEnvironment() *cobra.Command { Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously generate a materialized environment to optimize dependency resolution and is only marked as done when the materialized - environment has been successfully generated or has failed. + environment has been successfully generated or has failed. Poll the returned + operation with GetOperation. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -218,6 +219,7 @@ func newDeleteWorkspaceBaseEnvironment() *cobra.Command { Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact linked notebooks and jobs. This operation is irreversible and should be performed only when you are certain the environment is no longer needed. + Databricks-provided base environments cannot be deleted. Arguments: NAME: Required. The resource name of the workspace base environment to delete. @@ -339,7 +341,12 @@ func newGetOperation() *cobra.Command { cmd.Long = `Get the status of a long-running operation. Gets the status of a long-running operation. Clients can use this method to - poll the operation result. + poll the operation result. Create, update and refresh return an operation + named operations/{workspace_base_environment_id}. The operation is done when + the materialized environment build finishes. On success, response contains + the WorkspaceBaseEnvironment with status CREATED. When the status is + FAILED, EXPIRED or INVALID, error is set instead, and error.message + carries the environment's status message when one is available. Arguments: NAME: The name of the operation resource.` @@ -550,7 +557,9 @@ func newRefreshWorkspaceBaseEnvironment() *cobra.Command { a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing - materialized environment remains available until it expires. + materialized environment remains available until it expires. Poll the returned + operation with GetOperation. Databricks-provided base environments cannot be + refreshed. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -558,7 +567,7 @@ func newRefreshWorkspaceBaseEnvironment() *cobra.Command { completion using the get-operation command. Arguments: - NAME: Required. The resource name of the workspace base environment to delete. + NAME: Required. The resource name of the workspace base environment to refresh. Format: workspace-base-environments/{workspace_base_environment}` cmd.Annotations = make(map[string]string) @@ -746,7 +755,7 @@ func newUpdateWorkspaceBaseEnvironment() *cobra.Command { cmd.Flags().Var(&updateWorkspaceBaseEnvironmentJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().Var(&updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.BaseEnvironmentType, "base-environment-type", `The type of base environment (CPU or GPU). Supported values: [CPU, GPU]`) - cmd.Flags().StringVar(&updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, "filepath", updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, `The WSFS or UC Volumes path to the environment YAML file.`) + cmd.Flags().StringVar(&updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, "filepath", updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Filepath, `The workspace file or Unity Catalog volume path to the YAML file that defines the environment version and dependencies.`) cmd.Flags().StringVar(&updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Name, "name", updateWorkspaceBaseEnvironmentReq.WorkspaceBaseEnvironment.Name, `The resource name of the workspace base environment.`) // TODO: complex arg: spec @@ -758,7 +767,8 @@ func newUpdateWorkspaceBaseEnvironment() *cobra.Command { operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing materialized - environment remains available until it expires. + environment remains available until it expires. Poll the returned operation + with GetOperation. Databricks-provided base environments cannot be updated. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -766,7 +776,8 @@ func newUpdateWorkspaceBaseEnvironment() *cobra.Command { completion using the get-operation command. Arguments: - NAME: + NAME: The resource name of the workspace base environment to update. Format: + workspace-base-environments/{workspace_base_environment} DISPLAY_NAME: Human-readable display name for the workspace base environment.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/experiments/experiments.go b/cmd/workspace/experiments/experiments.go index e244c2aaef5..a1d687ba8b5 100644 --- a/cmd/workspace/experiments/experiments.go +++ b/cmd/workspace/experiments/experiments.go @@ -116,7 +116,7 @@ func newCreateExperiment() *cobra.Command { cmd.Flags().Var(&createExperimentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createExperimentReq.ArtifactLocation, "artifact-location", createExperimentReq.ArtifactLocation, `Location where all artifacts for the experiment are stored.`) + cmd.Flags().StringVar(&createExperimentReq.ArtifactLocation, "artifact-location", createExperimentReq.ArtifactLocation, `URI of the location where the artifacts of the experiment's runs are stored, such as a Unity Catalog volume path of the form dbfs:/Volumes////.`) // TODO: array: tags // TODO: complex arg: trace_location @@ -134,7 +134,8 @@ func newCreateExperiment() *cobra.Command { safe, clients should check for both error codes. Arguments: - NAME: Experiment name.` + NAME: Name of the experiment, as an absolute path in the workspace. Experiments + cannot be created under /Repos.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -504,7 +505,8 @@ func newDeleteExperiment() *cobra.Command { Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If the experiment uses FileStore, artifacts associated with the - experiment are also deleted. + experiment are also deleted. Only workspace experiments can be deleted through + this method. Arguments: EXPERIMENT_ID: ID of the associated experiment.` @@ -1653,7 +1655,8 @@ func newListExperiments() *cobra.Command { cmd.Short = `List experiments.` cmd.Long = `List experiments. - Gets a list of all experiments.` + Gets a list of all experiments, ordered by creation time with the newest + first.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2355,6 +2358,8 @@ func newRestoreExperiment() *cobra.Command { metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with experiment are also restored. + Only workspace experiments can be restored through this method. + Throws RESOURCE_DOES_NOT_EXIST if experiment was never created or was permanently deleted. @@ -2621,8 +2626,8 @@ func newSearchExperiments() *cobra.Command { cmd.Flags().Var(&searchExperimentsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&searchExperimentsReq.Filter, "filter", searchExperimentsReq.Filter, `String representing a SQL filter condition (e.g.`) - cmd.Flags().Int64Var(&searchExperimentsReq.MaxResults, "max-results", searchExperimentsReq.MaxResults, `Maximum number of experiments desired.`) + cmd.Flags().StringVar(&searchExperimentsReq.Filter, "filter", searchExperimentsReq.Filter, `Filter condition on the experiment name and tags.`) + cmd.Flags().Int64Var(&searchExperimentsReq.MaxResults, "max-results", searchExperimentsReq.MaxResults, `Maximum number of experiments to return per page.`) // TODO: array: order_by cmd.Flags().Var(&searchExperimentsReq.ViewType, "view-type", `Qualifier for type of experiments to be returned. Supported values: [ACTIVE_ONLY, ALL, DELETED_ONLY]`) @@ -2985,9 +2990,10 @@ func newSetExperimentTag() *cobra.Command { Arguments: EXPERIMENT_ID: ID of the experiment under which to log the tag. Must be provided. - KEY: Name of the tag. Keys up to 250 bytes in size are supported. - VALUE: String value of the tag being logged. Values up to 64KB in size are - supported.` + KEY: Key of the tag. Keys are at most 255 characters long. Setting a key that + already exists replaces its value. System tags such as mlflow.ownerId, + mlflow.ownerEmail and mlflow.experimentType cannot be set. + VALUE: Value of the tag. Values are at most 65535 characters long.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -3310,13 +3316,14 @@ func newUpdateExperiment() *cobra.Command { cmd.Flags().Var(&updateExperimentJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateExperimentReq.NewName, "new-name", updateExperimentReq.NewName, `If provided, the experiment's name is changed to the new name.`) + cmd.Flags().StringVar(&updateExperimentReq.NewName, "new-name", updateExperimentReq.NewName, `New name for the experiment, as an absolute path in the workspace.`) cmd.Use = "update-experiment EXPERIMENT_ID" cmd.Short = `Update an experiment.` cmd.Long = `Update an experiment. - Updates experiment metadata. + Updates experiment metadata. Only workspace experiments can be updated; a + notebook experiment takes its name from its notebook. Arguments: EXPERIMENT_ID: ID of the associated experiment.` diff --git a/cmd/workspace/external-metadata/external-metadata.go b/cmd/workspace/external-metadata/external-metadata.go index e5ecec90d28..abe0cdc729c 100644 --- a/cmd/workspace/external-metadata/external-metadata.go +++ b/cmd/workspace/external-metadata/external-metadata.go @@ -76,10 +76,10 @@ func newCreateExternalMetadata() *cobra.Command { cmd.Flags().Var(&createExternalMetadataJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: columns - cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Description, "description", createExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description.`) + cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Description, "description", createExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description of the object.`) cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Owner, "owner", createExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Url, "url", createExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object.`) + cmd.Flags().StringVar(&createExternalMetadataReq.ExternalMetadata.Url, "url", createExternalMetadataReq.ExternalMetadata.Url, `URL of the object in the external system.`) cmd.Use = "create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `*Public Preview* Create an external metadata object.` @@ -92,8 +92,14 @@ Create an external metadata object. **BROWSE** to all account users upon creation by default. Arguments: - NAME: Name of the external metadata object. - SYSTEM_TYPE: Type of external system. + NAME: Name of the external metadata object. The name is unique within the + metastore, must follow the [Unity Catalog naming requirements], and is + stored in lowercase. It cannot be changed after creation, and external + lineage relationships refer to the object by this name. + + [Unity Catalog naming requirements]: https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements + SYSTEM_TYPE: Type of the external system that holds the object. Use OTHER for a + system that is not in the list. Supported values: [ AMAZON_REDSHIFT, AZURE_SYNAPSE, @@ -119,7 +125,8 @@ Create an external metadata object. TERADATA, WORKDAY, ] - ENTITY_TYPE: Type of entity within the external system.` + ENTITY_TYPE: Type of the object within the external system, such as a table, a report, + or a dashboard. The value is free-form text of at most 255 characters.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -208,9 +215,13 @@ func newDeleteExternalMetadata() *cobra.Command { Delete an external metadata object. - Deletes the external metadata object that matches the supplied name. The - caller must be a metastore admin, the owner of the external metadata object, - or a user that has the **MANAGE** privilege.` + Deletes the external metadata object that matches the supplied name. Every + external lineage relationship in which the object is the source or the target + is deleted with it. The caller must be a metastore admin, the owner of the + external metadata object, or a user that has the **MANAGE** privilege. + + Arguments: + NAME: Name of the external metadata object to delete.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -269,7 +280,10 @@ Get an external metadata object. Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the owner of the external metadata object, or a user that - has the **BROWSE** privilege.` + has the **BROWSE** privilege. + + Arguments: + NAME: Name of the external metadata object to get.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -402,10 +416,10 @@ func newUpdateExternalMetadata() *cobra.Command { cmd.Flags().Var(&updateExternalMetadataJson, "json", `either inline JSON string or @path/to/file.json with request body`) // TODO: array: columns - cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Description, "description", updateExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description.`) + cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Description, "description", updateExternalMetadataReq.ExternalMetadata.Description, `User-provided free-form text description of the object.`) cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Owner, "owner", updateExternalMetadataReq.ExternalMetadata.Owner, `Owner of the external metadata object.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Url, "url", updateExternalMetadataReq.ExternalMetadata.Url, `URL associated with the external metadata object.`) + cmd.Flags().StringVar(&updateExternalMetadataReq.ExternalMetadata.Url, "url", updateExternalMetadataReq.ExternalMetadata.Url, `URL of the object in the external system.`) cmd.Use = "update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `*Public Preview* Update an external metadata object.` @@ -420,19 +434,17 @@ Update an external metadata object. updating the owner, they must also have the **MANAGE** privilege. Arguments: - NAME: Name of the external metadata object. - 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. - SYSTEM_TYPE: Type of external system. + NAME: Name of the external metadata object. The name is unique within the + metastore, must follow the [Unity Catalog naming requirements], and is + stored in lowercase. It cannot be changed after creation, and external + lineage relationships refer to the object by this name. + + [Unity Catalog naming requirements]: https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements + UPDATE_MASK: Comma-separated list of the fields to update, for example + description,properties. Only the listed fields change. The other fields + keep their current values. The mask must not be empty. + SYSTEM_TYPE: Type of the external system that holds the object. Use OTHER for a + system that is not in the list. Supported values: [ AMAZON_REDSHIFT, AZURE_SYNAPSE, @@ -458,7 +470,8 @@ Update an external metadata object. TERADATA, WORKDAY, ] - ENTITY_TYPE: Type of entity within the external system.` + ENTITY_TYPE: Type of the object within the external system, such as a table, a report, + or a dashboard. The value is free-form text of at most 255 characters.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" diff --git a/cmd/workspace/feature-engineering/feature-engineering.go b/cmd/workspace/feature-engineering/feature-engineering.go index 132d8921ba0..606ebf9383f 100644 --- a/cmd/workspace/feature-engineering/feature-engineering.go +++ b/cmd/workspace/feature-engineering/feature-engineering.go @@ -711,6 +711,7 @@ func newCreateMaterializedFeature() *cobra.Command { // TODO: complex arg: notifications // TODO: complex arg: offline_store_config // TODO: complex arg: online_store_config + // TODO: complex arg: operations cmd.Flags().Var(&createMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `Deprecated: This legacy pipeline setting does not control batch job scheduling. Supported values: [ACTIVE, PAUSED, SNAPSHOT]`) // TODO: complex arg: streaming_mode // TODO: complex arg: table_trigger @@ -2671,6 +2672,7 @@ func newUpdateMaterializedFeature() *cobra.Command { // TODO: complex arg: notifications // TODO: complex arg: offline_store_config // TODO: complex arg: online_store_config + // TODO: complex arg: operations cmd.Flags().Var(&updateMaterializedFeatureReq.MaterializedFeature.PipelineScheduleState, "pipeline-schedule-state", `Deprecated: This legacy pipeline setting does not control batch job scheduling. Supported values: [ACTIVE, PAUSED, SNAPSHOT]`) // TODO: complex arg: streaming_mode // TODO: complex arg: table_trigger diff --git a/cmd/workspace/git-credentials/git-credentials.go b/cmd/workspace/git-credentials/git-credentials.go index 3ce468c8013..f694e9a27f8 100644 --- a/cmd/workspace/git-credentials/git-credentials.go +++ b/cmd/workspace/git-credentials/git-credentials.go @@ -73,10 +73,10 @@ func newCreate() *cobra.Command { cmd.Flags().StringVar(&createReq.GitEmail, "git-email", createReq.GitEmail, `The authenticating email associated with your Git provider user account.`) cmd.Flags().StringVar(&createReq.GitUsername, "git-username", createReq.GitUsername, `The username provided with your Git provider account and associated with the credential.`) - cmd.Flags().BoolVar(&createReq.IsDefaultForProvider, "is-default-for-provider", createReq.IsDefaultForProvider, `if the credential is the default for the given provider.`) - cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `the name of the git credential, used for identification and ease of lookup.`) + cmd.Flags().BoolVar(&createReq.IsDefaultForProvider, "is-default-for-provider", createReq.IsDefaultForProvider, `Set to true to make the new credential the default for its Git provider, replacing the current default.`) + cmd.Flags().StringVar(&createReq.Name, "name", createReq.Name, `The name of the Git credential, used for identification and ease of lookup.`) cmd.Flags().StringVar(&createReq.PersonalAccessToken, "personal-access-token", createReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider.`) - cmd.Flags().Int64Var(&createReq.PrincipalId, "principal-id", createReq.PrincipalId, `The ID of the service principal whose credentials will be modified.`) + cmd.Flags().Int64Var(&createReq.PrincipalId, "principal-id", createReq.PrincipalId, `The ID of the service principal for which the credential will be created.`) cmd.Use = "create GIT_PROVIDER" cmd.Short = `Create a credential entry.` @@ -163,7 +163,7 @@ func newDelete() *cobra.Command { var deleteReq workspace.DeleteCredentialsRequest - cmd.Flags().Int64Var(&deleteReq.PrincipalId, "principal-id", deleteReq.PrincipalId, `The ID of the service principal whose credentials will be modified.`) + cmd.Flags().Int64Var(&deleteReq.PrincipalId, "principal-id", deleteReq.PrincipalId, `The ID of the service principal whose credential will be deleted.`) cmd.Use = "delete CREDENTIAL_ID" cmd.Short = `Delete a credential.` @@ -238,7 +238,7 @@ func newGet() *cobra.Command { var getReq workspace.GetCredentialsRequest - cmd.Flags().Int64Var(&getReq.PrincipalId, "principal-id", getReq.PrincipalId, `The ID of the service principal whose credentials will be modified.`) + cmd.Flags().Int64Var(&getReq.PrincipalId, "principal-id", getReq.PrincipalId, `The ID of the service principal whose credential will be returned.`) cmd.Use = "get CREDENTIAL_ID" cmd.Short = `Get a credential entry.` @@ -387,8 +387,8 @@ func newUpdate() *cobra.Command { cmd.Flags().StringVar(&updateReq.GitEmail, "git-email", updateReq.GitEmail, `The authenticating email associated with your Git provider user account.`) cmd.Flags().StringVar(&updateReq.GitUsername, "git-username", updateReq.GitUsername, `The username provided with your Git provider account and associated with the credential.`) - cmd.Flags().BoolVar(&updateReq.IsDefaultForProvider, "is-default-for-provider", updateReq.IsDefaultForProvider, `if the credential is the default for the given provider.`) - cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `the name of the git credential, used for identification and ease of lookup.`) + cmd.Flags().BoolVar(&updateReq.IsDefaultForProvider, "is-default-for-provider", updateReq.IsDefaultForProvider, `Set to true to make this credential the default for its Git provider, replacing the current default.`) + cmd.Flags().StringVar(&updateReq.Name, "name", updateReq.Name, `The name of the Git credential, used for identification and ease of lookup.`) cmd.Flags().StringVar(&updateReq.PersonalAccessToken, "personal-access-token", updateReq.PersonalAccessToken, `The personal access token used to authenticate to the corresponding Git provider.`) cmd.Flags().Int64Var(&updateReq.PrincipalId, "principal-id", updateReq.PrincipalId, `The ID of the service principal whose credentials will be modified.`) @@ -396,7 +396,8 @@ func newUpdate() *cobra.Command { cmd.Short = `Update a credential.` cmd.Long = `Update a credential. - Updates the specified Git credential. + Updates the specified Git credential. Fields that are omitted keep their + current values. Arguments: CREDENTIAL_ID: The ID for the corresponding credential to access. @@ -404,7 +405,9 @@ func newUpdate() *cobra.Command { are gitHub, bitbucketCloud, gitLab, azureDevOpsServices (Azure DevOps Services, including Microsoft Entra ID authentication), gitHubEnterprise, bitbucketServer (Bitbucket Data Center), - gitLabEnterpriseEdition (GitLab Self-Managed), and awsCodeCommit.` + gitLabEnterpriseEdition (GitLab Self-Managed), and awsCodeCommit. Must + match the Git provider of the existing credential; the provider cannot be + changed.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/lakeview-embedded/lakeview-embedded.go b/cmd/workspace/lakeview-embedded/lakeview-embedded.go index 93e84ae1f9f..133ba70bd43 100644 --- a/cmd/workspace/lakeview-embedded/lakeview-embedded.go +++ b/cmd/workspace/lakeview-embedded/lakeview-embedded.go @@ -56,8 +56,8 @@ func newGetPublishedDashboardTokenInfo() *cobra.Command { var getPublishedDashboardTokenInfoReq dashboards.GetPublishedDashboardTokenInfoRequest - cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalValue, "external-value", getPublishedDashboardTokenInfoReq.ExternalValue, `Provided external value to be included in the custom claim.`) - cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalViewerId, "external-viewer-id", getPublishedDashboardTokenInfoReq.ExternalViewerId, `Provided external viewer id to be included in the custom claim.`) + cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalValue, "external-value", getPublishedDashboardTokenInfoReq.ExternalValue, `Value to carry in the token for this viewer, such as a tenant or region key.`) + cmd.Flags().StringVar(&getPublishedDashboardTokenInfoReq.ExternalViewerId, "external-viewer-id", getPublishedDashboardTokenInfoReq.ExternalViewerId, `Identifier of the viewer in the external application.`) cmd.Use = "get-published-dashboard-token-info DASHBOARD_ID" cmd.Short = `*Public Preview* Read information of a published dashboard to mint an OAuth token.` @@ -65,8 +65,12 @@ func newGetPublishedDashboardTokenInfo() *cobra.Command { Read information of a published dashboard to mint an OAuth token. - Get a required authorization details and scopes of a published dashboard to - mint an OAuth token. + Get the OAuth scope and authorization details needed to mint a token that is + scoped to viewing the published dashboard, for example to embed it in an + external application. Pass the response fields, with authorization_details + serialized as a JSON string, to the workspace OAuth token endpoint with the + client_credentials grant to mint the token. See [Embedding for external + users]. The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access. @@ -74,6 +78,8 @@ Read information of a published dashboard to mint an OAuth token. Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them. + [Embedding for external users]: https://docs.databricks.com/dashboards/share/embedding/external-embed + Arguments: DASHBOARD_ID: UUID identifying the published dashboard.` diff --git a/cmd/workspace/lakeview/lakeview.go b/cmd/workspace/lakeview/lakeview.go index edd3b620d86..8ed02ba1f3a 100644 --- a/cmd/workspace/lakeview/lakeview.go +++ b/cmd/workspace/lakeview/lakeview.go @@ -160,15 +160,16 @@ func newCreateSchedule() *cobra.Command { cmd.Flags().Var(&createScheduleJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createScheduleReq.Schedule.DisplayName, "display-name", createScheduleReq.Schedule.DisplayName, `The display name for schedule.`) - cmd.Flags().Var(&createScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]`) - cmd.Flags().StringVar(&createScheduleReq.Schedule.WarehouseId, "warehouse-id", createScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule.`) + cmd.Flags().StringVar(&createScheduleReq.Schedule.DisplayName, "display-name", createScheduleReq.Schedule.DisplayName, `The name of the schedule, as shown in the dashboard's list of schedules.`) + cmd.Flags().Var(&createScheduleReq.Schedule.PauseStatus, "pause-status", `Whether the schedule is paused. Supported values: [PAUSED, UNPAUSED]`) + cmd.Flags().StringVar(&createScheduleReq.Schedule.WarehouseId, "warehouse-id", createScheduleReq.Schedule.WarehouseId, `The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes.`) cmd.Use = "create-schedule DASHBOARD_ID CRON_SCHEDULE" cmd.Short = `Create dashboard schedule.` cmd.Long = `Create dashboard schedule. - Create dashboard schedule. + Creates a schedule for a dashboard. The dashboard must be published before a + schedule can be created for it. Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to Workspace access. @@ -177,8 +178,7 @@ func newCreateSchedule() *cobra.Command { Arguments: DASHBOARD_ID: UUID identifying the dashboard to which the schedule belongs. - CRON_SCHEDULE: The cron expression describing the frequency of the periodic refresh for - this schedule.` + CRON_SCHEDULE: The cron expression and time zone that define when the schedule runs.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -260,13 +260,19 @@ func newCreateSubscription() *cobra.Command { cmd.Flags().Var(&createSubscriptionJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createSubscriptionReq.Subscription.SkipNotify, "skip-notify", createSubscriptionReq.Subscription.SkipNotify, `Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.`) + cmd.Flags().BoolVar(&createSubscriptionReq.Subscription.SkipNotify, "skip-notify", createSubscriptionReq.Subscription.SkipNotify, `Whether the subscription is refresh-only.`) cmd.Use = "create-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIBER" cmd.Short = `Create schedule subscription.` cmd.Long = `Create schedule subscription. - Create schedule subscription. + Create schedule subscription. Subscribes a workspace user or a notification + destination to the schedule, so that it receives a snapshot of the dashboard + each time the schedule runs. Subscribing yourself requires CAN VIEW permission + on the dashboard; subscribing another user or a notification destination + requires CAN EDIT. On dashboards published without embedded credentials, you + can only subscribe yourself. If the subscriber is already subscribed to the + schedule, the existing subscription is returned. The caller must be a workspace user with one of the following [entitlements]: Workspace access, Databricks SQL access, or Consumer access. @@ -279,8 +285,8 @@ func newCreateSubscription() *cobra.Command { Arguments: DASHBOARD_ID: UUID identifying the dashboard to which the subscription belongs. SCHEDULE_ID: UUID identifying the schedule to which the subscription belongs. - SUBSCRIBER: Subscriber details for users and destinations to be added as subscribers - to the schedule.` + SUBSCRIBER: The subscriber that receives the dashboard snapshot. Exactly one of + user_subscriber and destination_subscriber must be set.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -365,7 +371,7 @@ func newDeleteSchedule() *cobra.Command { cmd.Short = `Delete dashboard schedule.` cmd.Long = `Delete dashboard schedule. - Delete dashboard schedule. + Deletes a schedule together with all of its subscriptions. Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to Workspace access. @@ -426,13 +432,16 @@ func newDeleteSubscription() *cobra.Command { var deleteSubscriptionReq dashboards.DeleteSubscriptionRequest - cmd.Flags().StringVar(&deleteSubscriptionReq.Etag, "etag", deleteSubscriptionReq.Etag, `The etag for the subscription.`) + cmd.Flags().StringVar(&deleteSubscriptionReq.Etag, "etag", deleteSubscriptionReq.Etag, `The etag of the subscription, as returned when it was read.`) cmd.Use = "delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID" cmd.Short = `Delete schedule subscription.` cmd.Long = `Delete schedule subscription. - Delete schedule subscription. + Delete schedule subscription. The subscriber receives no further snapshots + from the schedule. Deleting your own subscription requires CAN VIEW permission + on the dashboard; deleting another user's or a notification destination's + subscription requires CAN EDIT. The caller must be a workspace user with one of the following [entitlements]: Workspace access, Databricks SQL access, or Consumer access. @@ -443,8 +452,8 @@ func newDeleteSubscription() *cobra.Command { [entitlements]: https://docs.databricks.com/security/auth/entitlements Arguments: - DASHBOARD_ID: UUID identifying the dashboard which the subscription belongs. - SCHEDULE_ID: UUID identifying the schedule which the subscription belongs. + DASHBOARD_ID: UUID identifying the dashboard to which the subscription belongs. + SCHEDULE_ID: UUID identifying the schedule to which the subscription belongs. SUBSCRIPTION_ID: UUID identifying the subscription.` cmd.Annotations = make(map[string]string) @@ -561,7 +570,8 @@ func newGetPublished() *cobra.Command { cmd.Short = `Get published dashboard.` cmd.Long = `Get published dashboard. - Get the current published dashboard. + Get the current published dashboard. The request fails with NOT_FOUND if the + dashboard has never been published or has been unpublished. The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access. @@ -706,8 +716,8 @@ func newGetSubscription() *cobra.Command { [entitlements]: https://docs.databricks.com/security/auth/entitlements Arguments: - DASHBOARD_ID: UUID identifying the dashboard which the subscription belongs. - SCHEDULE_ID: UUID identifying the schedule which the subscription belongs. + DASHBOARD_ID: UUID identifying the dashboard to which the subscription belongs. + SCHEDULE_ID: UUID identifying the schedule to which the subscription belongs. SUBSCRIPTION_ID: UUID identifying the subscription.` cmd.Annotations = make(map[string]string) @@ -863,7 +873,7 @@ func newListSchedules() *cobra.Command { [entitlements]: https://docs.databricks.com/security/auth/entitlements Arguments: - DASHBOARD_ID: UUID identifying the dashboard to which the schedules belongs.` + DASHBOARD_ID: UUID identifying the dashboard to which the schedules belong.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -946,8 +956,8 @@ func newListSubscriptions() *cobra.Command { [entitlements]: https://docs.databricks.com/security/auth/entitlements Arguments: - DASHBOARD_ID: UUID identifying the dashboard which the subscriptions belongs. - SCHEDULE_ID: UUID identifying the schedule which the subscriptions belongs.` + DASHBOARD_ID: UUID identifying the dashboard to which the subscriptions belong. + SCHEDULE_ID: UUID identifying the schedule to which the subscriptions belong.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1176,6 +1186,9 @@ func newRevert() *cobra.Command { cmd.Long = `Revert dashboard. Revert a dashboard's definition in draft mode to the last published version. + The draft's datasets, pages and widgets are replaced with those of the current + published version, and the updated draft is returned. The dashboard must have + been published at least once; the published version itself is not changed. Arguments: DASHBOARD_ID: UUID identifying the dashboard.` @@ -1304,7 +1317,9 @@ func newUnpublish() *cobra.Command { cmd.Short = `Unpublish dashboard.` cmd.Long = `Unpublish dashboard. - Unpublish the dashboard. + Unpublish the dashboard. This deletes the published version, so viewers can no + longer open it, and pauses the dashboard's schedules. The draft is not + changed; publish it again to make the dashboard available to viewers. Arguments: DASHBOARD_ID: UUID identifying the published dashboard.` @@ -1443,15 +1458,16 @@ func newUpdateSchedule() *cobra.Command { cmd.Flags().Var(&updateScheduleJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateScheduleReq.Schedule.DisplayName, "display-name", updateScheduleReq.Schedule.DisplayName, `The display name for schedule.`) - cmd.Flags().Var(&updateScheduleReq.Schedule.PauseStatus, "pause-status", `The status indicates whether this schedule is paused or not. Supported values: [PAUSED, UNPAUSED]`) - cmd.Flags().StringVar(&updateScheduleReq.Schedule.WarehouseId, "warehouse-id", updateScheduleReq.Schedule.WarehouseId, `The warehouse id to run the dashboard with for the schedule.`) + cmd.Flags().StringVar(&updateScheduleReq.Schedule.DisplayName, "display-name", updateScheduleReq.Schedule.DisplayName, `The name of the schedule, as shown in the dashboard's list of schedules.`) + cmd.Flags().Var(&updateScheduleReq.Schedule.PauseStatus, "pause-status", `Whether the schedule is paused. Supported values: [PAUSED, UNPAUSED]`) + cmd.Flags().StringVar(&updateScheduleReq.Schedule.WarehouseId, "warehouse-id", updateScheduleReq.Schedule.WarehouseId, `The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes.`) cmd.Use = "update-schedule DASHBOARD_ID SCHEDULE_ID CRON_SCHEDULE" cmd.Short = `Update dashboard schedule.` cmd.Long = `Update dashboard schedule. - Update dashboard schedule. + Updates a schedule. The request body replaces the stored schedule, so fields + omitted from the body are reset to their defaults. Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to Workspace access. @@ -1461,8 +1477,7 @@ func newUpdateSchedule() *cobra.Command { Arguments: DASHBOARD_ID: UUID identifying the dashboard to which the schedule belongs. SCHEDULE_ID: UUID identifying the schedule. - CRON_SCHEDULE: The cron expression describing the frequency of the periodic refresh for - this schedule.` + CRON_SCHEDULE: The cron expression and time zone that define when the schedule runs.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/lakewatch/lakewatch.go b/cmd/workspace/lakewatch/lakewatch.go index bf2d8f40a99..f9df53e491b 100644 --- a/cmd/workspace/lakewatch/lakewatch.go +++ b/cmd/workspace/lakewatch/lakewatch.go @@ -45,16 +45,28 @@ Manage Lakewatch: security-analytics data sources, detection rules, and // Add methods cmd.AddCommand(newCreateDatasource()) + cmd.AddCommand(newCreateParser()) + cmd.AddCommand(newCreateParserVersion()) cmd.AddCommand(newCreateRule()) cmd.AddCommand(newDeleteDatasource()) + cmd.AddCommand(newDeleteParser()) + cmd.AddCommand(newDeleteParserVersion()) cmd.AddCommand(newDeleteRule()) cmd.AddCommand(newGetAlertConfig()) + cmd.AddCommand(newGetBuiltinParser()) + cmd.AddCommand(newGetBuiltinParserVersion()) cmd.AddCommand(newGetCommonConfig()) cmd.AddCommand(newGetDatasource()) cmd.AddCommand(newGetDatasourceConfig()) + cmd.AddCommand(newGetParser()) + cmd.AddCommand(newGetParserVersion()) cmd.AddCommand(newGetRule()) cmd.AddCommand(newGetRuleConfig()) + cmd.AddCommand(newListBuiltinParserVersions()) + cmd.AddCommand(newListBuiltinParsers()) cmd.AddCommand(newListDatasources()) + cmd.AddCommand(newListParserVersions()) + cmd.AddCommand(newListParsers()) cmd.AddCommand(newListRules()) cmd.AddCommand(newUpdateAlertConfig()) cmd.AddCommand(newUpdateCommonConfig()) @@ -198,6 +210,211 @@ Create a datasource. return cmd } +// start create-parser 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 createParserOverrides []func( + *cobra.Command, + *lakewatch.CreateParserRequest, +) + +func newCreateParser() *cobra.Command { + cmd := &cobra.Command{} + + var createParserReq lakewatch.CreateParserRequest + createParserReq.Parser = lakewatch.Parser{} + var createParserJson flags.JsonFlag + + cmd.Flags().Var(&createParserJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + // TODO: complex arg: created_by + cmd.Flags().StringVar(&createParserReq.Parser.Description, "description", createParserReq.Parser.Description, `Description of version 1.`) + cmd.Flags().StringVar(&createParserReq.Parser.Name, "name", createParserReq.Parser.Name, `Resource name.`) + // TODO: complex arg: owner + + cmd.Use = "create-parser CATALOG_NAME SCHEMA_NAME PARSER_NAME SPEC" + cmd.Short = `*Beta* Create a parser.` + cmd.Long = `This command is in Beta and may change without notice. + +Create a parser. + + Creates a parser and its first version in one call. + + Arguments: + CATALOG_NAME: Name of the parent UC catalog, set on create. Reads return the value as + supplied; the current UC catalog name is reported in + effective_catalog_name. + SCHEMA_NAME: Name of the parent UC schema, set on create. Reads return the value as + supplied; the current UC schema name is reported in + effective_schema_name. + PARSER_NAME: Client-supplied parser name, stored as supplied and fixed at create time. + Must be a valid UC identifier. A custom parser is not currently a UC + securable and this field has no rename path. + SPEC: Spec of version 1, as a YAML document. Accepted only by CreateParser; + read a version's spec with GetParserVersion.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + if cmd.Flags().Changed("json") { + err := root.ExactArgs(0)(cmd, args) + if err != nil { + return errors.New("when --json flag is specified, no positional arguments are allowed. Provide 'catalog_name', 'schema_name', 'parser_name', 'spec' in your JSON input") + } + return nil + } + check := root.ExactArgs(4) + 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) + + if cmd.Flags().Changed("json") { + diags := createParserJson.Unmarshal(&createParserReq.Parser) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + if !cmd.Flags().Changed("json") { + createParserReq.Parser.CatalogName = args[0] + } + if !cmd.Flags().Changed("json") { + createParserReq.Parser.SchemaName = args[1] + } + if !cmd.Flags().Changed("json") { + createParserReq.Parser.ParserName = args[2] + } + if !cmd.Flags().Changed("json") { + createParserReq.Parser.Spec = args[3] + } + + response, err := w.Lakewatch.CreateParser(ctx, createParserReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 createParserOverrides { + fn(cmd, &createParserReq) + } + + return cmd +} + +// start create-parser-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 createParserVersionOverrides []func( + *cobra.Command, + *lakewatch.CreateParserVersionRequest, +) + +func newCreateParserVersion() *cobra.Command { + cmd := &cobra.Command{} + + var createParserVersionReq lakewatch.CreateParserVersionRequest + createParserVersionReq.ParserVersion = lakewatch.ParserVersion{} + var createParserVersionJson flags.JsonFlag + + cmd.Flags().Var(&createParserVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + // TODO: complex arg: created_by + cmd.Flags().StringVar(&createParserVersionReq.ParserVersion.Description, "description", createParserVersionReq.ParserVersion.Description, `Free-form description of this version, set when the version is created.`) + cmd.Flags().StringVar(&createParserVersionReq.ParserVersion.Name, "name", createParserVersionReq.ParserVersion.Name, `Resource name.`) + + cmd.Use = "create-parser-version PARENT SPEC" + cmd.Short = `*Beta* Create a parser version.` + cmd.Long = `This command is in Beta and may change without notice. + +Create a parser version. + + Appends a new immutable version, advancing the parser's latest-version + pointer. This is how a parser is edited; versions are never changed in place. + + Arguments: + PARENT: Resource name of the parser to append a version to. Format: + parsers/{parser_id}. + SPEC: The field definitions for this log source, as a YAML document. Validated + on write, so an invalid spec is never stored.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + if cmd.Flags().Changed("json") { + err := root.ExactArgs(1)(cmd, args) + if err != nil { + return errors.New("when --json flag is specified, provide only PARENT as positional arguments. Provide 'spec' in your JSON input") + } + return nil + } + check := root.ExactArgs(2) + 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) + + if cmd.Flags().Changed("json") { + diags := createParserVersionJson.Unmarshal(&createParserVersionReq.ParserVersion) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + createParserVersionReq.Parent = args[0] + if !cmd.Flags().Changed("json") { + createParserVersionReq.ParserVersion.Spec = args[1] + } + + response, err := w.Lakewatch.CreateParserVersion(ctx, createParserVersionReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 createParserVersionOverrides { + fn(cmd, &createParserVersionReq) + } + + return cmd +} + // start create-rule command // Slice with functions to override default command behavior. @@ -418,30 +635,31 @@ Delete a datasource. return cmd } -// start delete-rule command +// start delete-parser 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 deleteRuleOverrides []func( +var deleteParserOverrides []func( *cobra.Command, - *lakewatch.DeleteRuleRequest, + *lakewatch.DeleteParserRequest, ) -func newDeleteRule() *cobra.Command { +func newDeleteParser() *cobra.Command { cmd := &cobra.Command{} - var deleteRuleReq lakewatch.DeleteRuleRequest + var deleteParserReq lakewatch.DeleteParserRequest - cmd.Use = "delete-rule NAME" - cmd.Short = `*Beta* Delete a rule.` + cmd.Use = "delete-parser NAME" + cmd.Short = `*Beta* Delete a parser.` cmd.Long = `This command is in Beta and may change without notice. -Delete a rule. +Delete a parser. - Deletes a rule by its resource name. + Deletes a parser and all of its versions. Refused while any data source + references it. Arguments: - NAME: Resource name of the rule to delete. Format: rules/{rule_id}.` + NAME: Resource name of the parser. Format: parsers/{parser_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -457,9 +675,9 @@ Delete a rule. ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - deleteRuleReq.Name = args[0] + deleteParserReq.Name = args[0] - err = w.Lakewatch.DeleteRule(ctx, deleteRuleReq) + err = w.Lakewatch.DeleteParser(ctx, deleteParserReq) if err != nil { return err } @@ -471,34 +689,44 @@ Delete a rule. cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range deleteRuleOverrides { - fn(cmd, &deleteRuleReq) + for _, fn := range deleteParserOverrides { + fn(cmd, &deleteParserReq) } return cmd } -// start get-alert-config command +// start delete-parser-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 getAlertConfigOverrides []func( +var deleteParserVersionOverrides []func( *cobra.Command, - *lakewatch.GetAlertConfigRequest, + *lakewatch.DeleteParserVersionRequest, ) -func newGetAlertConfig() *cobra.Command { +func newDeleteParserVersion() *cobra.Command { cmd := &cobra.Command{} - var getAlertConfigReq lakewatch.GetAlertConfigRequest + var deleteParserVersionReq lakewatch.DeleteParserVersionRequest - cmd.Use = "get-alert-config NAME" - cmd.Short = `*Beta* Get the alert config for a catalog.` + cmd.Use = "delete-parser-version NAME" + cmd.Short = `*Beta* Delete a parser version.` cmd.Long = `This command is in Beta and may change without notice. -Get the alert config for a catalog. +Delete a parser version. - Returns the alert delivery configuration for a catalog.` + Deletes one version of a parser. Returns NOT_FOUND when the parser or the + version does not exist, and a conflict (HTTP 409) only while a data source + references the version. Deleting the last version leaves the parser in place + with no versions. + + Arguments: + NAME: Resource name of the version. Format: + parsers/{parser_id}/versions/{version}, where {version} is a version + number written without sign or leading zeros, such as 3. Unlike + GetParserVersion, the alias latest and forms such as 007 or +3 are + rejected, so a delete always names one fixed version.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -514,14 +742,13 @@ Get the alert config for a catalog. ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getAlertConfigReq.Name = args[0] + deleteParserVersionReq.Name = args[0] - response, err := w.Lakewatch.GetAlertConfig(ctx, getAlertConfigReq) + err = w.Lakewatch.DeleteParserVersion(ctx, deleteParserVersionReq) if err != nil { return err } - - return cmdio.Render(ctx, response) + return nil } // Disable completions since they are not applicable. @@ -529,34 +756,37 @@ Get the alert config for a catalog. cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range getAlertConfigOverrides { - fn(cmd, &getAlertConfigReq) + for _, fn := range deleteParserVersionOverrides { + fn(cmd, &deleteParserVersionReq) } return cmd } -// start get-common-config command +// start delete-rule 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 getCommonConfigOverrides []func( +var deleteRuleOverrides []func( *cobra.Command, - *lakewatch.GetCommonConfigRequest, + *lakewatch.DeleteRuleRequest, ) -func newGetCommonConfig() *cobra.Command { +func newDeleteRule() *cobra.Command { cmd := &cobra.Command{} - var getCommonConfigReq lakewatch.GetCommonConfigRequest + var deleteRuleReq lakewatch.DeleteRuleRequest - cmd.Use = "get-common-config NAME" - cmd.Short = `*Beta* Get the common config for a catalog.` + cmd.Use = "delete-rule NAME" + cmd.Short = `*Beta* Delete a rule.` cmd.Long = `This command is in Beta and may change without notice. -Get the common config for a catalog. +Delete a rule. - Returns the common Lakewatch configuration for a catalog.` + Deletes a rule by its resource name. + + Arguments: + NAME: Resource name of the rule to delete. Format: rules/{rule_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -572,14 +802,13 @@ Get the common config for a catalog. ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getCommonConfigReq.Name = args[0] + deleteRuleReq.Name = args[0] - response, err := w.Lakewatch.GetCommonConfig(ctx, getCommonConfigReq) + err = w.Lakewatch.DeleteRule(ctx, deleteRuleReq) if err != nil { return err } - - return cmdio.Render(ctx, response) + return nil } // Disable completions since they are not applicable. @@ -587,34 +816,34 @@ Get the common config for a catalog. cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range getCommonConfigOverrides { - fn(cmd, &getCommonConfigReq) + for _, fn := range deleteRuleOverrides { + fn(cmd, &deleteRuleReq) } return cmd } -// start get-datasource command +// start get-alert-config 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 getDatasourceOverrides []func( +var getAlertConfigOverrides []func( *cobra.Command, - *lakewatch.GetDatasourceRequest, + *lakewatch.GetAlertConfigRequest, ) -func newGetDatasource() *cobra.Command { +func newGetAlertConfig() *cobra.Command { cmd := &cobra.Command{} - var getDatasourceReq lakewatch.GetDatasourceRequest + var getAlertConfigReq lakewatch.GetAlertConfigRequest - cmd.Use = "get-datasource NAME" - cmd.Short = `*Beta* Get a datasource.` + cmd.Use = "get-alert-config NAME" + cmd.Short = `*Beta* Get the alert config for a catalog.` cmd.Long = `This command is in Beta and may change without notice. -Get a datasource. +Get the alert config for a catalog. - Returns a single datasource by its resource name.` + Returns the alert delivery configuration for a catalog.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -630,9 +859,9 @@ Get a datasource. ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getDatasourceReq.Name = args[0] + getAlertConfigReq.Name = args[0] - response, err := w.Lakewatch.GetDatasource(ctx, getDatasourceReq) + response, err := w.Lakewatch.GetAlertConfig(ctx, getAlertConfigReq) if err != nil { return err } @@ -645,34 +874,38 @@ Get a datasource. cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range getDatasourceOverrides { - fn(cmd, &getDatasourceReq) + for _, fn := range getAlertConfigOverrides { + fn(cmd, &getAlertConfigReq) } return cmd } -// start get-datasource-config command +// start get-builtin-parser 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 getDatasourceConfigOverrides []func( +var getBuiltinParserOverrides []func( *cobra.Command, - *lakewatch.GetDatasourceConfigRequest, + *lakewatch.GetBuiltinParserRequest, ) -func newGetDatasourceConfig() *cobra.Command { +func newGetBuiltinParser() *cobra.Command { cmd := &cobra.Command{} - var getDatasourceConfigReq lakewatch.GetDatasourceConfigRequest + var getBuiltinParserReq lakewatch.GetBuiltinParserRequest - cmd.Use = "get-datasource-config NAME" - cmd.Short = `*Beta* Get the datasource config for a catalog.` + cmd.Use = "get-builtin-parser NAME" + cmd.Short = `*Beta* Get a built-in parser.` cmd.Long = `This command is in Beta and may change without notice. -Get the datasource config for a catalog. +Get a built-in parser. - Returns the datasource ingestion configuration for a catalog.` + Returns a built-in parser's identity and latest-version pointer. Does not + return the spec. + + Arguments: + NAME: Resource name. Format: builtin-parsers/{parser_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -688,9 +921,9 @@ Get the datasource config for a catalog. ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getDatasourceConfigReq.Name = args[0] + getBuiltinParserReq.Name = args[0] - response, err := w.Lakewatch.GetDatasourceConfig(ctx, getDatasourceConfigReq) + response, err := w.Lakewatch.GetBuiltinParser(ctx, getBuiltinParserReq) if err != nil { return err } @@ -703,26 +936,389 @@ Get the datasource config for a catalog. cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range getDatasourceConfigOverrides { - fn(cmd, &getDatasourceConfigReq) + for _, fn := range getBuiltinParserOverrides { + fn(cmd, &getBuiltinParserReq) } return cmd } -// start get-rule command +// start get-builtin-parser-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 getRuleOverrides []func( +var getBuiltinParserVersionOverrides []func( *cobra.Command, - *lakewatch.GetRuleRequest, + *lakewatch.GetBuiltinParserVersionRequest, ) -func newGetRule() *cobra.Command { +func newGetBuiltinParserVersion() *cobra.Command { cmd := &cobra.Command{} - var getRuleReq lakewatch.GetRuleRequest + var getBuiltinParserVersionReq lakewatch.GetBuiltinParserVersionRequest + + cmd.Use = "get-builtin-parser-version NAME" + cmd.Short = `*Beta* Get a built-in parser version.` + cmd.Long = `This command is in Beta and may change without notice. + +Get a built-in parser version. + + Returns one version of a built-in parser, including its spec. + + Arguments: + NAME: Resource name of the version. Format: + builtin-parsers/{parser_id}/versions/{version}, where {version} is + either a version number or the alias latest.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getBuiltinParserVersionReq.Name = args[0] + + response, err := w.Lakewatch.GetBuiltinParserVersion(ctx, getBuiltinParserVersionReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getBuiltinParserVersionOverrides { + fn(cmd, &getBuiltinParserVersionReq) + } + + return cmd +} + +// start get-common-config 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 getCommonConfigOverrides []func( + *cobra.Command, + *lakewatch.GetCommonConfigRequest, +) + +func newGetCommonConfig() *cobra.Command { + cmd := &cobra.Command{} + + var getCommonConfigReq lakewatch.GetCommonConfigRequest + + cmd.Use = "get-common-config NAME" + cmd.Short = `*Beta* Get the common config for a catalog.` + cmd.Long = `This command is in Beta and may change without notice. + +Get the common config for a catalog. + + Returns the common Lakewatch configuration for a catalog.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getCommonConfigReq.Name = args[0] + + response, err := w.Lakewatch.GetCommonConfig(ctx, getCommonConfigReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getCommonConfigOverrides { + fn(cmd, &getCommonConfigReq) + } + + return cmd +} + +// start get-datasource 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 getDatasourceOverrides []func( + *cobra.Command, + *lakewatch.GetDatasourceRequest, +) + +func newGetDatasource() *cobra.Command { + cmd := &cobra.Command{} + + var getDatasourceReq lakewatch.GetDatasourceRequest + + cmd.Use = "get-datasource NAME" + cmd.Short = `*Beta* Get a datasource.` + cmd.Long = `This command is in Beta and may change without notice. + +Get a datasource. + + Returns a single datasource by its resource name.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getDatasourceReq.Name = args[0] + + response, err := w.Lakewatch.GetDatasource(ctx, getDatasourceReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getDatasourceOverrides { + fn(cmd, &getDatasourceReq) + } + + return cmd +} + +// start get-datasource-config 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 getDatasourceConfigOverrides []func( + *cobra.Command, + *lakewatch.GetDatasourceConfigRequest, +) + +func newGetDatasourceConfig() *cobra.Command { + cmd := &cobra.Command{} + + var getDatasourceConfigReq lakewatch.GetDatasourceConfigRequest + + cmd.Use = "get-datasource-config NAME" + cmd.Short = `*Beta* Get the datasource config for a catalog.` + cmd.Long = `This command is in Beta and may change without notice. + +Get the datasource config for a catalog. + + Returns the datasource ingestion configuration for a catalog.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getDatasourceConfigReq.Name = args[0] + + response, err := w.Lakewatch.GetDatasourceConfig(ctx, getDatasourceConfigReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getDatasourceConfigOverrides { + fn(cmd, &getDatasourceConfigReq) + } + + return cmd +} + +// start get-parser 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 getParserOverrides []func( + *cobra.Command, + *lakewatch.GetParserRequest, +) + +func newGetParser() *cobra.Command { + cmd := &cobra.Command{} + + var getParserReq lakewatch.GetParserRequest + + cmd.Use = "get-parser NAME" + cmd.Short = `*Beta* Get a parser.` + cmd.Long = `This command is in Beta and may change without notice. + +Get a parser. + + Returns a parser's identity and latest-version pointer. Does not return the + spec; read a spec with GetParserVersion. + + Arguments: + NAME: Resource name of the parser. Format: parsers/{parser_id}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getParserReq.Name = args[0] + + response, err := w.Lakewatch.GetParser(ctx, getParserReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getParserOverrides { + fn(cmd, &getParserReq) + } + + return cmd +} + +// start get-parser-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 getParserVersionOverrides []func( + *cobra.Command, + *lakewatch.GetParserVersionRequest, +) + +func newGetParserVersion() *cobra.Command { + cmd := &cobra.Command{} + + var getParserVersionReq lakewatch.GetParserVersionRequest + + cmd.Use = "get-parser-version NAME" + cmd.Short = `*Beta* Get a parser version.` + cmd.Long = `This command is in Beta and may change without notice. + +Get a parser version. + + Returns one version of a parser, including its spec. + + Arguments: + NAME: Resource name of the version. Format: + parsers/{parser_id}/versions/{version}, where {version} is either a + version number or the alias latest. latest is NOT_FOUND when every + version of the parser has been deleted.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + getParserVersionReq.Name = args[0] + + response, err := w.Lakewatch.GetParserVersion(ctx, getParserVersionReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // 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 getParserVersionOverrides { + fn(cmd, &getParserVersionReq) + } + + return cmd +} + +// start get-rule 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 getRuleOverrides []func( + *cobra.Command, + *lakewatch.GetRuleRequest, +) + +func newGetRule() *cobra.Command { + cmd := &cobra.Command{} + + var getRuleReq lakewatch.GetRuleRequest cmd.Use = "get-rule NAME" cmd.Short = `*Beta* Get a rule.` @@ -829,6 +1425,158 @@ Get the rule config for a catalog. return cmd } +// start list-builtin-parser-versions 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 listBuiltinParserVersionsOverrides []func( + *cobra.Command, + *lakewatch.ListBuiltinParserVersionsRequest, +) + +func newListBuiltinParserVersions() *cobra.Command { + cmd := &cobra.Command{} + + var listBuiltinParserVersionsReq lakewatch.ListBuiltinParserVersionsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listBuiltinParserVersionsLimit int + + cmd.Flags().IntVar(&listBuiltinParserVersionsReq.PageSize, "page-size", listBuiltinParserVersionsReq.PageSize, `Maximum number of results to return in one page.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listBuiltinParserVersionsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listBuiltinParserVersionsReq.PageToken, "page-token", listBuiltinParserVersionsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-builtin-parser-versions PARENT" + cmd.Short = `*Beta* List built-in parser versions.` + cmd.Long = `This command is in Beta and may change without notice. + +List built-in parser versions. + + Lists a built-in parser's published versions, oldest first (ascending + 1..resource_revision), without their specs. + + Arguments: + PARENT: Resource name of the built-in parser whose versions are listed. Format: + builtin-parsers/{parser_id}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + listBuiltinParserVersionsReq.Parent = args[0] + + response := w.Lakewatch.ListBuiltinParserVersions(ctx, listBuiltinParserVersionsReq) + if listBuiltinParserVersionsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listBuiltinParserVersionsLimit) + } + if listBuiltinParserVersionsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listBuiltinParserVersionsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // 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 listBuiltinParserVersionsOverrides { + fn(cmd, &listBuiltinParserVersionsReq) + } + + return cmd +} + +// start list-builtin-parsers 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 listBuiltinParsersOverrides []func( + *cobra.Command, + *lakewatch.ListBuiltinParsersRequest, +) + +func newListBuiltinParsers() *cobra.Command { + cmd := &cobra.Command{} + + var listBuiltinParsersReq lakewatch.ListBuiltinParsersRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listBuiltinParsersLimit int + + cmd.Flags().StringVar(&listBuiltinParsersReq.Filter, "filter", listBuiltinParsersReq.Filter, `AIP-160 filter expression.`) + cmd.Flags().IntVar(&listBuiltinParsersReq.PageSize, "page-size", listBuiltinParsersReq.PageSize, `Maximum number of results to return in one page.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listBuiltinParsersLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listBuiltinParsersReq.PageToken, "page-token", listBuiltinParsersReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-builtin-parsers" + cmd.Short = `*Beta* List built-in parsers.` + cmd.Long = `This command is in Beta and may change without notice. + +List built-in parsers. + + Lists the built-in parsers Databricks publishes, without their specs.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(0) + 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) + + response := w.Lakewatch.ListBuiltinParsers(ctx, listBuiltinParsersReq) + if listBuiltinParsersLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listBuiltinParsersLimit) + } + if listBuiltinParsersLimit > 0 { + ctx = cmdio.WithLimit(ctx, listBuiltinParsersLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // 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 listBuiltinParsersOverrides { + fn(cmd, &listBuiltinParsersReq) + } + + return cmd +} + // start list-datasources command // Slice with functions to override default command behavior. @@ -912,6 +1660,166 @@ List datasources. return cmd } +// start list-parser-versions 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 listParserVersionsOverrides []func( + *cobra.Command, + *lakewatch.ListParserVersionsRequest, +) + +func newListParserVersions() *cobra.Command { + cmd := &cobra.Command{} + + var listParserVersionsReq lakewatch.ListParserVersionsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listParserVersionsLimit int + + cmd.Flags().IntVar(&listParserVersionsReq.PageSize, "page-size", listParserVersionsReq.PageSize, `Maximum number of results to return in one page.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listParserVersionsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listParserVersionsReq.PageToken, "page-token", listParserVersionsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-parser-versions PARENT" + cmd.Short = `*Beta* List parser versions.` + cmd.Long = `This command is in Beta and may change without notice. + +List parser versions. + + Lists a parser's versions, oldest first, without their specs. + + Arguments: + PARENT: Resource name of the parser whose versions are listed. Format: + parsers/{parser_id}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + listParserVersionsReq.Parent = args[0] + + response := w.Lakewatch.ListParserVersions(ctx, listParserVersionsReq) + if listParserVersionsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listParserVersionsLimit) + } + if listParserVersionsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listParserVersionsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // 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 listParserVersionsOverrides { + fn(cmd, &listParserVersionsReq) + } + + return cmd +} + +// start list-parsers 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 listParsersOverrides []func( + *cobra.Command, + *lakewatch.ListParsersRequest, +) + +func newListParsers() *cobra.Command { + cmd := &cobra.Command{} + + var listParsersReq lakewatch.ListParsersRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listParsersLimit int + + cmd.Flags().StringVar(&listParsersReq.Filter, "filter", listParsersReq.Filter, `AIP-160 filter expression.`) + cmd.Flags().IntVar(&listParsersReq.PageSize, "page-size", listParsersReq.PageSize, `Maximum number of results to return in one page.`) + cmd.Flags().StringVar(&listParsersReq.SchemaName, "schema-name", listParsersReq.SchemaName, `Name of the parent UC schema.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listParsersLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listParsersReq.PageToken, "page-token", listParsersReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-parsers CATALOG_NAME" + cmd.Short = `*Beta* List parsers.` + cmd.Long = `This command is in Beta and may change without notice. + +List parsers. + + Lists parsers in a catalog, without their specs. + + Arguments: + CATALOG_NAME: Name of the parent UC catalog to list parsers from. Required: List is + scoped to a single catalog, mirroring the Unity Catalog tables/functions + APIs, which take catalog_name as a request field (bound to a query + parameter) rather than a catalog path segment.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + 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) + + listParsersReq.CatalogName = args[0] + + response := w.Lakewatch.ListParsers(ctx, listParsersReq) + if listParsersLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listParsersLimit) + } + if listParsersLimit > 0 { + ctx = cmdio.WithLimit(ctx, listParsersLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // 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 listParsersOverrides { + fn(cmd, &listParsersReq) + } + + return cmd +} + // start list-rules command // Slice with functions to override default command behavior. diff --git a/cmd/workspace/libraries/libraries.go b/cmd/workspace/libraries/libraries.go index 2ea301001c0..e22db2b47d5 100644 --- a/cmd/workspace/libraries/libraries.go +++ b/cmd/workspace/libraries/libraries.go @@ -87,8 +87,11 @@ func newAllClusterStatuses() *cobra.Command { cmd.Short = `Get all statuses.` cmd.Long = `Get all statuses. - Get the status of all libraries on all clusters. A status is returned for all - libraries installed on this cluster via the API or the libraries UI.` + Get the status of all libraries on all clusters in the workspace. A status is + returned for all libraries installed on each cluster via the API or the + libraries UI. If the workspace has more library statuses than the response + limit allows, the request fails; call the per-cluster status method for each + cluster instead.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -153,7 +156,7 @@ func newClusterStatus() *cobra.Command { of returned libraries is as follows: 1. Libraries set to be installed on this cluster, in the order that the libraries were added to the cluster, are returned first. 2. Libraries that were previously requested to be installed on - this cluster or, but are now marked for removal, in no particular order, are + this cluster but are now marked for removal, in no particular order, are returned last. Arguments: diff --git a/cmd/workspace/model-registry/model-registry.go b/cmd/workspace/model-registry/model-registry.go index 3d3076f8891..715df48bc2e 100644 --- a/cmd/workspace/model-registry/model-registry.go +++ b/cmd/workspace/model-registry/model-registry.go @@ -395,8 +395,8 @@ func newCreateModelVersion() *cobra.Command { cmd.Flags().Var(&createModelVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createModelVersionReq.Description, "description", createModelVersionReq.Description, `Optional description for model version.`) - cmd.Flags().StringVar(&createModelVersionReq.RunId, "run-id", createModelVersionReq.RunId, `MLflow run ID for correlation, if source was generated by an experiment run in MLflow tracking server.`) + cmd.Flags().StringVar(&createModelVersionReq.Description, "description", createModelVersionReq.Description, `Description of the model version.`) + cmd.Flags().StringVar(&createModelVersionReq.RunId, "run-id", createModelVersionReq.RunId, `ID of the MLflow run that produced the model artifacts, if source comes from a run in the MLflow tracking server.`) cmd.Flags().StringVar(&createModelVersionReq.RunLink, "run-link", createModelVersionReq.RunLink, `MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.`) // TODO: array: tags @@ -407,8 +407,11 @@ func newCreateModelVersion() *cobra.Command { Creates a model version. Arguments: - NAME: Register model under this name - SOURCE: URI indicating the location of the model artifacts.` + NAME: Name of the existing registered model to create the version under. + SOURCE: URI of the model artifacts to register, such as the artifact path of an + MLflow run or a models:// URI of an existing + READY model version. The registry copies the artifacts asynchronously, + so the new version starts in PENDING_REGISTRATION status.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1898,7 +1901,7 @@ func newSearchModelVersions() *cobra.Command { // branches, so the method-call path is always reached. var searchModelVersionsLimit int - cmd.Flags().StringVar(&searchModelVersionsReq.Filter, "filter", searchModelVersionsReq.Filter, `String filter condition, like "name='my-model-name'".`) + cmd.Flags().StringVar(&searchModelVersionsReq.Filter, "filter", searchModelVersionsReq.Filter, `Filter condition on name, run_id, source or tags..`) cmd.Flags().Int64Var(&searchModelVersionsReq.MaxResults, "max-results", searchModelVersionsReq.MaxResults, `Maximum number of models desired.`) // TODO: array: order_by @@ -2697,13 +2700,13 @@ func newUpdateModelVersion() *cobra.Command { cmd.Flags().Var(&updateModelVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateModelVersionReq.Description, "description", updateModelVersionReq.Description, `If provided, updates the description for this registered_model.`) + cmd.Flags().StringVar(&updateModelVersionReq.Description, "description", updateModelVersionReq.Description, `New description for the model version.`) cmd.Use = "update-model-version NAME VERSION" cmd.Short = `Update model version.` cmd.Long = `Update model version. - Updates the model version. + Updates the description of a model version. Arguments: NAME: Name of the registered model diff --git a/cmd/workspace/postgres/postgres.go b/cmd/workspace/postgres/postgres.go index 17382929833..23703bc25ed 100644 --- a/cmd/workspace/postgres/postgres.go +++ b/cmd/workspace/postgres/postgres.go @@ -1167,7 +1167,7 @@ func newCreateMigration() *cobra.Command { DATABASE_MAPPINGS: Required. Mappings from source databases to target databases. MIGRATION_TYPE: Required. Immutable. The intended migration mode, selected when the migration is created. - Supported values: [MIGRATION_TYPE_ONE_TIME_COPY, MIGRATION_TYPE_ONLINE]` + Supported values: [MIGRATION_TYPE_ONE_TIME_COPY]` // This command is being previewed; hide from help output. cmd.Hidden = true @@ -1560,7 +1560,8 @@ func newCreateSnapshot() *cobra.Command { cmd.Long = `Create a Snapshot. Creates a snapshot, an immutable point-in-time copy of a branch's data, within - the project. + the project. Returns a long-running operation. Poll it until done is true; its + response holds the new snapshot. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -1570,7 +1571,10 @@ func newCreateSnapshot() *cobra.Command { Arguments: PARENT: The project in which to create the snapshot. Format: projects/{project_id} SNAPSHOT_ID: Client-chosen ID for the snapshot. It becomes the final segment of the - snapshot resource name and cannot be changed after creation.` + snapshot resource name and cannot be changed after creation. The ID must + be 3 to 63 characters long, start with a lowercase letter, end with a + lowercase letter or digit, and contain only lowercase letters, digits, and + hyphens.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1675,7 +1679,7 @@ func newCreateSyncedTable() *cobra.Command { cmd.Flags().Var(&createSyncedTableJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createSyncedTableReq.SyncedTable.Name, "name", createSyncedTableReq.SyncedTable.Name, `Output only.`) + cmd.Flags().StringVar(&createSyncedTableReq.SyncedTable.Name, "name", createSyncedTableReq.SyncedTable.Name, `The full resource name of the synced table, where (catalog, schema, table) are the Unity Catalog names of the synced table.`) // TODO: complex arg: spec // TODO: complex arg: status @@ -1683,7 +1687,9 @@ func newCreateSyncedTable() *cobra.Command { cmd.Short = `Create a Synced Database Table.` cmd.Long = `Create a Synced Database Table. - Create a Synced Table. + Create a Synced Table. Creates the synced table in Unity Catalog and the + Postgres table on the branch, and starts the pipeline that loads the initial + data from the source table. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -2226,6 +2232,8 @@ func newDeleteDatabase() *cobra.Command { cmd.Short = `Delete a Database.` cmd.Long = `Delete a Database. + Deletes the specified Postgres database. + This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw operation details. The operation's 'name' field can then be used to poll for @@ -2745,7 +2753,8 @@ func newDeleteSnapshot() *cobra.Command { cmd.Short = `Delete a Snapshot.` cmd.Long = `Delete a Snapshot. - Deletes the specified snapshot. + Deletes the specified snapshot. A deleted snapshot cannot be recovered. + Returns a long-running operation. Poll it until done is true. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -2847,7 +2856,9 @@ func newDeleteSyncedTable() *cobra.Command { cmd.Short = `Delete a Synced Database Table.` cmd.Long = `Delete a Synced Database Table. - Delete a Synced Table. + Delete a Synced Table. Drops the Postgres table, removes the synced table from + its pipeline, and deletes it from Unity Catalog. The pipeline itself is + deleted when no other synced table uses it. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -3427,6 +3438,8 @@ func newGetDatabase() *cobra.Command { cmd.Short = `Get a Database.` cmd.Long = `Get a Database. + Retrieves information about the specified Postgres database. + Arguments: NAME: The name of the Database to retrieve. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}` @@ -4300,7 +4313,7 @@ func newListDatabases() *cobra.Command { cmd.Short = `List postgres databases in a branch.` cmd.Long = `List postgres databases in a branch. - List Databases. + Returns a list of Postgres databases in the branch. Arguments: PARENT: The Branch that owns this collection of databases. Format: @@ -5493,6 +5506,9 @@ func newUpdateDatabase() *cobra.Command { cmd.Short = `Update a Database.` cmd.Long = `Update a Database. + Updates the specified Postgres database. Only the fields named in + update_mask change. + This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw operation details. The operation's 'name' field can then be used to poll for @@ -5501,7 +5517,8 @@ func newUpdateDatabase() *cobra.Command { Arguments: NAME: The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id} - UPDATE_MASK: The list of fields to update.` + UPDATE_MASK: The list of fields to update. The updatable fields are spec.role and + spec.postgres_database.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -5766,7 +5783,7 @@ func newUpdateMigration() *cobra.Command { DATABASE_MAPPINGS: Required. Mappings from source databases to target databases. MIGRATION_TYPE: Required. Immutable. The intended migration mode, selected when the migration is created. - Supported values: [MIGRATION_TYPE_ONE_TIME_COPY, MIGRATION_TYPE_ONLINE]` + Supported values: [MIGRATION_TYPE_ONE_TIME_COPY]` // This command is being previewed; hide from help output. cmd.Hidden = true diff --git a/cmd/workspace/providers/providers.go b/cmd/workspace/providers/providers.go index 6c95001e02f..01f28d063d5 100644 --- a/cmd/workspace/providers/providers.go +++ b/cmd/workspace/providers/providers.go @@ -386,6 +386,7 @@ func newListProviderShareAssets() *cobra.Command { cmd.Flags().IntVar(&listProviderShareAssetsReq.FunctionMaxResults, "function-max-results", listProviderShareAssetsReq.FunctionMaxResults, `Maximum number of functions to return.`) cmd.Flags().IntVar(&listProviderShareAssetsReq.NotebookMaxResults, "notebook-max-results", listProviderShareAssetsReq.NotebookMaxResults, `Maximum number of notebooks to return.`) + cmd.Flags().IntVar(&listProviderShareAssetsReq.SkillMaxResults, "skill-max-results", listProviderShareAssetsReq.SkillMaxResults, `Maximum number of skills to return.`) cmd.Flags().IntVar(&listProviderShareAssetsReq.TableMaxResults, "table-max-results", listProviderShareAssetsReq.TableMaxResults, `Maximum number of tables to return.`) cmd.Flags().IntVar(&listProviderShareAssetsReq.VolumeMaxResults, "volume-max-results", listProviderShareAssetsReq.VolumeMaxResults, `Maximum number of volumes to return.`) diff --git a/cmd/workspace/schemas/schemas.go b/cmd/workspace/schemas/schemas.go index c6aebf2c4ce..4be2c42b493 100644 --- a/cmd/workspace/schemas/schemas.go +++ b/cmd/workspace/schemas/schemas.go @@ -71,9 +71,9 @@ 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.Comment, "comment", createReq.Comment, `User-provided free-form text description.`) - cmd.Flags().Int64Var(&createReq.CustomMaxRetentionHours, "custom-max-retention-hours", createReq.CustomMaxRetentionHours, `Custom maximum retention period in hours for the schema.`) + cmd.Flags().Int64Var(&createReq.CustomMaxRetentionHours, "custom-max-retention-hours", createReq.CustomMaxRetentionHours, `Dropped objects in the schema remain recoverable for this number of hours before they are permanently purged.`) // TODO: map via StringToStringVar: properties - cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Storage root URL for managed tables within schema.`) + cmd.Flags().StringVar(&createReq.StorageRoot, "storage-root", createReq.StorageRoot, `Managed tables and volumes in the schema are stored under this storage root URL.`) cmd.Use = "create NAME CATALOG_NAME" cmd.Short = `Create a schema.` @@ -171,7 +171,7 @@ func newDelete() *cobra.Command { owner of the schema or an owner of the parent catalog. Arguments: - FULL_NAME: Full name of the schema.` + FULL_NAME: Full name of the schema, in the form catalog_name.schema_name.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -222,7 +222,7 @@ func newGet() *cobra.Command { var getReq catalog.GetSchemaRequest - cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&getReq.IncludeBrowse, "include-browse", getReq.IncludeBrowse, `Whether to return the schema when the principal can only access selective metadata for it through the BROWSE privilege.`) cmd.Use = "get FULL_NAME" cmd.Short = `Get a schema.` @@ -233,7 +233,7 @@ func newGet() *cobra.Command { privilege on the schema. Arguments: - FULL_NAME: Full name of the schema.` + FULL_NAME: Full name of the schema, in the form catalog_name.schema_name.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -289,7 +289,7 @@ func newList() *cobra.Command { // branches, so the method-call path is always reached. var listLimit int - cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include schemas in the response for which the principal can only access selective metadata for.`) + cmd.Flags().BoolVar(&listReq.IncludeBrowse, "include-browse", listReq.IncludeBrowse, `Whether to include schemas for which the principal can only access selective metadata through the BROWSE privilege.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) @@ -378,10 +378,10 @@ 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.Comment, "comment", updateReq.Comment, `User-provided free-form text description.`) - cmd.Flags().Int64Var(&updateReq.CustomMaxRetentionHours, "custom-max-retention-hours", updateReq.CustomMaxRetentionHours, `Custom maximum retention period in hours for the schema.`) - cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization should be enabled for this object and objects under it. Supported values: [DISABLE, ENABLE, INHERIT]`) + cmd.Flags().Int64Var(&updateReq.CustomMaxRetentionHours, "custom-max-retention-hours", updateReq.CustomMaxRetentionHours, `Dropped objects in the schema remain recoverable for this number of hours before they are permanently purged.`) + cmd.Flags().Var(&updateReq.EnablePredictiveOptimization, "enable-predictive-optimization", `Whether predictive optimization is enabled for this schema and the objects under it. Supported values: [DISABLE, ENABLE, INHERIT]`) cmd.Flags().StringVar(&updateReq.NewName, "new-name", updateReq.NewName, `New name for the schema.`) - cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `Username of current owner of schema.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The user or group that owns the schema.`) // TODO: map via StringToStringVar: properties cmd.Use = "update FULL_NAME" @@ -395,7 +395,7 @@ func newUpdate() *cobra.Command { the parent catalog. Arguments: - FULL_NAME: Full name of the schema.` + FULL_NAME: Full name of the schema, in the form catalog_name.schema_name.` 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 6519d7d49b6..cb9ed89bf08 100644 --- a/cmd/workspace/secrets/secrets.go +++ b/cmd/workspace/secrets/secrets.go @@ -403,12 +403,6 @@ func newDeleteSecret() *cobra.Command { Deletes the secret stored in this secret scope. You must have WRITE or MANAGE permission on the Secret Scope. - Example request: - - .. code:: - - { "scope": "my-secret-scope", "key": "my-secret-key" } - 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 @@ -569,33 +563,20 @@ func newGetSecret() *cobra.Command { cmd.Short = `Get a secret.` cmd.Long = `Get a secret. - Gets a secret for a given key and scope. This API can only be called from the - DBUtils interface. Users need the READ permission to make this call. - - Example response: - - .. code:: - - { "key": "my-string-key", "value": } + Gets the bytes representation of a secret value for the specified scope and + key. Users need the READ permission to make this call. - Note that the secret value returned is in bytes. The interpretation of the - bytes is determined by the caller in DBUtils and the type the data is decoded - into. + The secret value is returned as bytes regardless of whether it was written + with string_value or bytes_value, so the caller decides how to decode + it. Values returned by this API are not redacted. Throws RESOURCE_DOES_NOT_EXIST if no such secret or secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this - API call. - - Note: This is explicitly an undocumented API. It also doesn't need to be - supported for the /preview prefix, because it's not a customer-facing API - (i.e. only used for DBUtils SecretUtils to fetch secrets). - - Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists. - Throws BAD_REQUEST if normal user calls get secret outside of a notebook. - AKV specific errors: Throws INVALID_PARAMETER_VALUE if secret name is not - alphanumeric or too long. Throws PERMISSION_DENIED if secret manager - cannot access AKV with 403 error Throws MALFORMED_REQUEST if secret - manager cannot access AKV with any other 4xx error + API call. Azure Key Vault-backed scopes can also return the following errors: + Throws INVALID_PARAMETER_VALUE if the secret name is not alphanumeric or + is too long. Throws PERMISSION_DENIED if Databricks cannot access the key + vault (HTTP 403). Throws MALFORMED_REQUEST if Databricks cannot access the + key vault with any other 4xx error. Arguments: SCOPE: The name of the scope that contains the secret. @@ -820,16 +801,6 @@ func newListSecrets() *cobra.Command { operation; secret data cannot be retrieved using this API. Users need the READ permission to make this call. - Example response: - - .. code:: - - { "secrets": [ { "key": "my-string-key"", "last_updated_timestamp": - "1520467595000" }, { "key": "my-byte-key", "last_updated_timestamp": - "1520467595000" }, ] } - - The lastUpdatedTimestamp returned is in milliseconds since epoch. - 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. diff --git a/cmd/workspace/software-artifacts/software-artifacts.go b/cmd/workspace/software-artifacts/software-artifacts.go index 3befe46d9d9..f2826554a33 100644 --- a/cmd/workspace/software-artifacts/software-artifacts.go +++ b/cmd/workspace/software-artifacts/software-artifacts.go @@ -74,7 +74,8 @@ func newGetSoftwareArtifact() *cobra.Command { Get a software artifact. - Gets a software artifact. + Gets a software artifact by its resource name. Returns NOT_FOUND if the + artifact does not exist. Arguments: NAME: Resource name of the artifact, of the form @@ -136,11 +137,13 @@ func newGetSoftwareArtifactVersion() *cobra.Command { Get a software artifact version. - Gets a software artifact version. + Gets a software artifact version by its resource name. Returns NOT_FOUND if + the version does not exist. Arguments: NAME: Resource name of the version, of the form - software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}.` + software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}, + where {version} is the version's content digest.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -357,11 +360,15 @@ func newResolveSoftwareArtifactVersion() *cobra.Command { Resolve a software artifact version. - Resolves a software artifact version from its tag alias. + Resolves a software artifact version from its tag alias. Returns NOT_FOUND + if the artifact or the alias does not exist. Arguments: - PARENT: Resource name of the software artifact containing the alias. - ALIAS: Image tag alias selecting the version.` + PARENT: Resource name of the software artifact containing the alias, of the form + software-artifacts/{catalog}.{schema}.{artifact}. + ALIAS: Image tag alias selecting the version. The alias must be a valid OCI image + tag of at most 128 characters, made of letters, digits, underscores, + periods, and hyphens, and must not start with a period or hyphen.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -440,7 +447,7 @@ func newUpdateSoftwareArtifact() *cobra.Command { cmd.Flags().Var(&updateSoftwareArtifactJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().StringVar(&updateSoftwareArtifactReq.SoftwareArtifact.Name, "name", updateSoftwareArtifactReq.SoftwareArtifact.Name, `Resource name of the artifact, of the form software-artifacts/{catalog}.{schema}.{artifact}.`) - cmd.Flags().StringVar(&updateSoftwareArtifactReq.SoftwareArtifact.Owner, "owner", updateSoftwareArtifactReq.SoftwareArtifact.Owner, `Principal name (a user, service principal, or group) that owns this artifact.`) + cmd.Flags().StringVar(&updateSoftwareArtifactReq.SoftwareArtifact.Owner, "owner", updateSoftwareArtifactReq.SoftwareArtifact.Owner, `Principal that owns the artifact, given as a user's email address, a service principal's application ID, or a group name.`) cmd.Use = "update-software-artifact NAME UPDATE_MASK" cmd.Short = `*Public Preview* Update a software artifact.` diff --git a/cmd/workspace/system-schemas/system-schemas.go b/cmd/workspace/system-schemas/system-schemas.go index 438587a6740..0c074f94d35 100644 --- a/cmd/workspace/system-schemas/system-schemas.go +++ b/cmd/workspace/system-schemas/system-schemas.go @@ -75,7 +75,7 @@ Disable a system schema. Arguments: METASTORE_ID: The metastore ID under which the system schema lives. - SCHEMA_NAME: Full name of the system schema.` + SCHEMA_NAME: Name of the system schema, without the catalog prefix.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -130,7 +130,7 @@ func newEnable() *cobra.Command { cmd.Flags().Var(&enableJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&enableReq.CatalogName, "catalog-name", enableReq.CatalogName, `the catalog for which the system schema is to enabled in.`) + cmd.Flags().StringVar(&enableReq.CatalogName, "catalog-name", enableReq.CatalogName, `Name of the catalog in which to enable the system schema.`) cmd.Use = "enable METASTORE_ID SCHEMA_NAME" cmd.Short = `*Public Preview* Enable a system schema.` @@ -143,7 +143,7 @@ Enable a system schema. Arguments: METASTORE_ID: The metastore ID under which the system schema lives. - SCHEMA_NAME: Full name of the system schema.` + SCHEMA_NAME: Name of the system schema, without the catalog prefix.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" diff --git a/cmd/workspace/tables/tables.go b/cmd/workspace/tables/tables.go index 60445f0bbe1..85086c4291f 100644 --- a/cmd/workspace/tables/tables.go +++ b/cmd/workspace/tables/tables.go @@ -114,7 +114,14 @@ Create a table. NAME: Name of table, relative to parent schema. CATALOG_NAME: Name of parent catalog. SCHEMA_NAME: Name of parent schema relative to its parent catalog. - TABLE_TYPE: + TABLE_TYPE: The type of the table. MANAGED tables store their data in storage that + Unity Catalog manages, EXTERNAL tables store it in a registered external + location, FOREIGN tables mirror objects of an external database through a + connection, and the shallow clone types reference the data files of a base + table. VIEW, MATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are + defined by a view definition. See + https://docs.databricks.com/aws/en/tables/ for an overview of the table + types. Supported values: [ EXTERNAL, EXTERNAL_SHALLOW_CLONE, @@ -126,7 +133,9 @@ Create a table. STREAMING_TABLE, VIEW, ] - DATA_SOURCE_FORMAT: + DATA_SOURCE_FORMAT: The format of the data that backs the table, such as DELTA, PARQUET, CSV + or JSON. Foreign tables report the external system that holds them, for + example SNOWFLAKE_FORMAT or MYSQL_FORMAT. Supported values: [ AVRO, BIGQUERY_FORMAT, @@ -159,7 +168,11 @@ Create a table. VECTOR_INDEX_FORMAT, WORKDAY_RAAS_FORMAT, ] - STORAGE_LOCATION: Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).` + STORAGE_LOCATION: The cloud storage URL under which the data files of the table are stored. + For an EXTERNAL table, it must be set on creation to a path within an + existing external location. For a MANAGED table, the server assigns a path + under the managed storage location of the parent schema, catalog or + metastore and returns it in this field. Views have no storage location.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_PREVIEW" @@ -647,7 +660,7 @@ 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.Owner, "owner", updateReq.Owner, `Username of current owner of table.`) + cmd.Flags().StringVar(&updateReq.Owner, "owner", updateReq.Owner, `The user or group that owns the table.`) cmd.Use = "update FULL_NAME" cmd.Short = `Update a table owner.` diff --git a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go index a1613dc23a1..7f18ec44feb 100644 --- a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go +++ b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go @@ -587,20 +587,22 @@ func newRetrieveUserVisibleMetrics() *cobra.Command { cmd.Flags().Var(&retrieveUserVisibleMetricsJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.EndTime, "end-time", retrieveUserVisibleMetricsReq.EndTime, `End time for metrics query.`) - cmd.Flags().IntVar(&retrieveUserVisibleMetricsReq.GranularityInSeconds, "granularity-in-seconds", retrieveUserVisibleMetricsReq.GranularityInSeconds, `Granularity in seconds.`) + cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.EndTime, "end-time", retrieveUserVisibleMetricsReq.EndTime, `End of the time range.`) + cmd.Flags().IntVar(&retrieveUserVisibleMetricsReq.GranularityInSeconds, "granularity-in-seconds", retrieveUserVisibleMetricsReq.GranularityInSeconds, `Requested interval between data points, in seconds.`) // TODO: array: metrics - cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.PageToken, "page-token", retrieveUserVisibleMetricsReq.PageToken, `Token for pagination.`) - cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.StartTime, "start-time", retrieveUserVisibleMetricsReq.StartTime, `Start time for metrics query.`) + cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.PageToken, "page-token", retrieveUserVisibleMetricsReq.PageToken, `Not used.`) + cmd.Flags().StringVar(&retrieveUserVisibleMetricsReq.StartTime, "start-time", retrieveUserVisibleMetricsReq.StartTime, `Start of the time range.`) cmd.Use = "retrieve-user-visible-metrics NAME" cmd.Short = `Retrieve user-visible metrics for an endpoint.` cmd.Long = `Retrieve user-visible metrics for an endpoint. - Retrieve user-visible metrics for an endpoint + Retrieve time series of usage and health metrics for an endpoint and its + indexes, such as request counts, request latency percentiles and endpoint + utilization. Arguments: - NAME: AI Search endpoint name` + NAME: Name of the endpoint whose metrics to retrieve.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/vector-search-indexes/vector-search-indexes.go b/cmd/workspace/vector-search-indexes/vector-search-indexes.go index 818b510e50c..85fcb71bfd3 100644 --- a/cmd/workspace/vector-search-indexes/vector-search-indexes.go +++ b/cmd/workspace/vector-search-indexes/vector-search-indexes.go @@ -87,13 +87,18 @@ func newCreateIndex() *cobra.Command { cmd.Short = `Create an index.` cmd.Long = `Create an index. - Create a new index. + Create a new index on an endpoint. Creating a Delta Sync index also creates + the pipeline that populates it from the source table; a Direct Vector Access + index starts empty and is populated through Upsert data into an index. Arguments: - NAME: Name of the index + NAME: Three-level Unity Catalog name of the index to create. ENDPOINT_NAME: Name of the endpoint to be used for serving the index - PRIMARY_KEY: Primary key of the index - INDEX_TYPE: + PRIMARY_KEY: Name of the column that uniquely identifies each row. For a Delta Sync + index it is a column of the source table; for a Direct Vector Access index + it must be declared in schema_json. It cannot be the embedding source or + embedding vector column. + INDEX_TYPE: Type of index to create, which determines which spec field is required. Supported values: [DELTA_SYNC, DIRECT_ACCESS]` cmd.Annotations = make(map[string]string) @@ -187,7 +192,9 @@ func newDeleteDataVectorIndex() *cobra.Command { cmd.Short = `Delete data from index.` cmd.Long = `Delete data from index. - Handles the deletion of data from a specified vector index. + Delete rows from a Direct Vector Access index by primary key. The response + reports how many rows were deleted and the primary keys of the rows that + failed. Arguments: INDEX_NAME: Name of the vector index where data is to be deleted. Must be a Direct @@ -261,8 +268,11 @@ func newDeleteIndex() *cobra.Command { cmd.Short = `Delete an index.` cmd.Long = `Delete an index. + Delete an index and the data it holds. The source table of a Delta Sync index + is not affected. + Arguments: - INDEX_NAME: Name of the index` + INDEX_NAME: Three-level Unity Catalog name of the index.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -320,7 +330,7 @@ func newGetIndex() *cobra.Command { cmd.Long = `Get an index. Arguments: - INDEX_NAME: Name of the index` + INDEX_NAME: Three-level Unity Catalog name of the index.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -390,7 +400,7 @@ func newListIndexes() *cobra.Command { List all indexes in the given endpoint. Arguments: - ENDPOINT_NAME: Name of the endpoint` + ENDPOINT_NAME: Name of the endpoint whose indexes to list.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -450,10 +460,10 @@ func newQueryIndex() *cobra.Command { // TODO: array: columns_to_rerank // TODO: array: facets - cmd.Flags().StringVar(&queryIndexReq.FiltersJson, "filters-json", queryIndexReq.FiltersJson, `JSON string representing query filters.`) - cmd.Flags().IntVar(&queryIndexReq.NumResults, "num-results", queryIndexReq.NumResults, `Number of results to return.`) + cmd.Flags().StringVar(&queryIndexReq.FiltersJson, "filters-json", queryIndexReq.FiltersJson, `Filters to apply to the results, as a JSON object serialized to a string.`) + cmd.Flags().IntVar(&queryIndexReq.NumResults, "num-results", queryIndexReq.NumResults, `Maximum number of results to return.`) // TODO: array: query_columns - cmd.Flags().StringVar(&queryIndexReq.QueryText, "query-text", queryIndexReq.QueryText, `Query text.`) + cmd.Flags().StringVar(&queryIndexReq.QueryText, "query-text", queryIndexReq.QueryText, `Text to search for.`) cmd.Flags().StringVar(&queryIndexReq.QueryType, "query-type", queryIndexReq.QueryType, `The query type to use.`) // TODO: array: query_vector // TODO: complex arg: reranker @@ -464,7 +474,8 @@ func newQueryIndex() *cobra.Command { cmd.Short = `Query an index.` cmd.Long = `Query an index. - Query the specified vector index. + Query an index with a vector, text, or both, and return the requested columns + of the best-matching rows. Arguments: INDEX_NAME: Name of the vector index to query.` @@ -536,7 +547,7 @@ func newQueryNextPage() *cobra.Command { cmd.Flags().Var(&queryNextPageJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&queryNextPageReq.EndpointName, "endpoint-name", queryNextPageReq.EndpointName, `Name of the endpoint.`) + cmd.Flags().StringVar(&queryNextPageReq.EndpointName, "endpoint-name", queryNextPageReq.EndpointName, `Name of the endpoint that serves the index.`) cmd.Flags().StringVar(&queryNextPageReq.PageToken, "page-token", queryNextPageReq.PageToken, `Page token returned from previous QueryVectorIndex or QueryVectorIndexNextPage API.`) cmd.Use = "query-next-page INDEX_NAME" @@ -621,8 +632,9 @@ func newScanIndex() *cobra.Command { cmd.Short = `Scan an index.` cmd.Long = `Scan an index. - Scan the specified vector index and return the first num_results entries - after the exclusive primary_key. + Scan an index and return the first num_results rows after the exclusive + last_primary_key. Repeat the call with the returned last_primary_key to + read the whole index. Arguments: INDEX_NAME: Name of the vector index to scan.` @@ -693,7 +705,9 @@ func newSyncIndex() *cobra.Command { cmd.Short = `Synchronize an index.` cmd.Long = `Synchronize an index. - Triggers a synchronization process for a specified vector index. + Start a sync of a Delta Sync index with a TRIGGERED pipeline from its source + table. An index with a CONTINUOUS pipeline syncs automatically and rejects + manual syncs. Arguments: INDEX_NAME: Name of the vector index to synchronize. Must be a Delta Sync Index.` @@ -754,12 +768,17 @@ func newUpsertDataVectorIndex() *cobra.Command { cmd.Short = `Upsert data into an index.` cmd.Long = `Upsert data into an index. - Handles the upserting of data into a specified vector index. + Insert rows into a Direct Vector Access index, replacing existing rows that + have the same primary key. The response reports how many rows succeeded and + the primary keys of the rows that failed. Arguments: INDEX_NAME: Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index. - INPUTS_JSON: JSON string representing the data to be upserted.` + INPUTS_JSON: Rows to upsert, as a JSON array of objects serialized to a string. Each + object maps column names from schema_json to values and must include the + primary key. A row whose primary key already exists in the index is + replaced.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/workspace-entity-tag-assignments/workspace-entity-tag-assignments.go b/cmd/workspace/workspace-entity-tag-assignments/workspace-entity-tag-assignments.go index e6a73b6e747..57746fba194 100644 --- a/cmd/workspace/workspace-entity-tag-assignments/workspace-entity-tag-assignments.go +++ b/cmd/workspace/workspace-entity-tag-assignments/workspace-entity-tag-assignments.go @@ -389,17 +389,9 @@ func newUpdateTagAssignment() *cobra.Command { entity_id is the app name TAG_KEY: The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed - 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.` + UPDATE_MASK: The comma-separated list of fields to update. Only tag_value can be + updated, because the entity type, entity ID and tag key identify the tag + assignment.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go index cbee25a2def..1f216ca57c3 100644 --- a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go +++ b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go @@ -203,7 +203,7 @@ func newCreateGroupProxy() *cobra.Command { cmd.Flags().StringVar(&createGroupProxyReq.Parent, "parent", createGroupProxyReq.Parent, `The resource name of the account to create the group in, in the format accounts/{account_id}.`) cmd.Flags().StringVar(&createGroupProxyReq.Group.ExternalId, "external-id", createGroupProxyReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) - cmd.Flags().StringVar(&createGroupProxyReq.Group.GroupName, "group-name", createGroupProxyReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&createGroupProxyReq.Group.GroupName, "group-name", createGroupProxyReq.Group.GroupName, `The display name of the group.`) cmd.Flags().StringVar(&createGroupProxyReq.Group.Name, "name", createGroupProxyReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "create-group-proxy" @@ -2538,7 +2538,7 @@ func newUpdateGroupProxy() *cobra.Command { cmd.Flags().Var(&updateGroupProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) cmd.Flags().StringVar(&updateGroupProxyReq.Group.ExternalId, "external-id", updateGroupProxyReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) - cmd.Flags().StringVar(&updateGroupProxyReq.Group.GroupName, "group-name", updateGroupProxyReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&updateGroupProxyReq.Group.GroupName, "group-name", updateGroupProxyReq.Group.GroupName, `The display name of the group.`) cmd.Flags().StringVar(&updateGroupProxyReq.Group.Name, "name", updateGroupProxyReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "update-group-proxy NAME UPDATE_MASK" diff --git a/go.mod b/go.mod index 4fac774805a..1c6562f5ad4 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.200.0 // Apache-2.0 + github.com/databricks/databricks-sdk-go v0.201.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 6ed77785c7d..351293ac058 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.200.0 h1:RyqG9llLKTQ4izNBK7JpPNhkOYZJerhtrcDlHAF+Ug4= -github.com/databricks/databricks-sdk-go v0.200.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= +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/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/cluster_policies/_models/library.py b/python/databricks/bundles/cluster_policies/_models/library.py index 42781f4ccb5..b33ebba30e6 100644 --- a/python/databricks/bundles/cluster_policies/_models/library.py +++ b/python/databricks/bundles/cluster_policies/_models/library.py @@ -25,16 +25,20 @@ @dataclass(kw_only=True) class Library: - """""" + """ + A library to install on a cluster. Exactly one of the library-type fields must be set. + """ cran: VariableOrOptional[RCranLibrary] = None """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] = None """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] = None @@ -54,14 +58,15 @@ class Library: pypi: VariableOrOptional[PythonPyPiLibrary] = None """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] = None """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] = None @@ -86,12 +91,14 @@ class LibraryDict(TypedDict, total=False): cran: VariableOrOptional[RCranLibraryParam] """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] @@ -111,14 +118,15 @@ class LibraryDict(TypedDict, total=False): pypi: VariableOrOptional[PythonPyPiLibraryParam] """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] diff --git a/python/databricks/bundles/cluster_policies/_models/maven_library.py b/python/databricks/bundles/cluster_policies/_models/maven_library.py index 25be1599c28..4997ae6e399 100644 --- a/python/databricks/bundles/cluster_policies/_models/maven_library.py +++ b/python/databricks/bundles/cluster_policies/_models/maven_library.py @@ -26,7 +26,7 @@ class MavenLibrary: exclusions: VariableOrList[str] = field(default_factory=list) """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. @@ -56,7 +56,7 @@ class MavenLibraryDict(TypedDict, total=False): exclusions: VariableOrList[str] """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. diff --git a/python/databricks/bundles/cluster_policies/_models/python_py_pi_library.py b/python/databricks/bundles/cluster_policies/_models/python_py_pi_library.py index 037c2029f50..6bb88de00e8 100644 --- a/python/databricks/bundles/cluster_policies/_models/python_py_pi_library.py +++ b/python/databricks/bundles/cluster_policies/_models/python_py_pi_library.py @@ -17,7 +17,7 @@ class PythonPyPiLibrary: package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ @@ -40,7 +40,7 @@ class PythonPyPiLibraryDict(TypedDict, total=False): package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ diff --git a/python/databricks/bundles/clusters/_models/azure_attributes.py b/python/databricks/bundles/clusters/_models/azure_attributes.py index f5c5cbee36d..69250bc1b13 100644 --- a/python/databricks/bundles/clusters/_models/azure_attributes.py +++ b/python/databricks/bundles/clusters/_models/azure_attributes.py @@ -60,7 +60,8 @@ class AzureAttributes: log_analytics_info: VariableOrOptional[LogAnalyticsInfo] = None """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] = None @@ -117,7 +118,8 @@ class AzureAttributesDict(TypedDict, total=False): log_analytics_info: VariableOrOptional[LogAnalyticsInfoParam] """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] diff --git a/python/databricks/bundles/clusters/_models/cluster.py b/python/databricks/bundles/clusters/_models/cluster.py index c66737c8a65..049d70ab2f0 100644 --- a/python/databricks/bundles/clusters/_models/cluster.py +++ b/python/databricks/bundles/clusters/_models/cluster.py @@ -92,7 +92,7 @@ class Cluster(Resource): """ Automatically terminates the cluster after it is inactive for this time in minutes. If not set, this cluster will not be automatically terminated. If specified, the threshold must be between - 10 and 10000 minutes. + 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable automatic termination. """ @@ -140,8 +140,9 @@ class Cluster(Resource): from a cluster. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. The following modes are legacy aliases for the above modes: @@ -154,7 +155,7 @@ class Cluster(Resource): * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. - * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled. """ dependency_mode: VariableOrOptional[DependencyMode] = None @@ -166,7 +167,8 @@ class Cluster(Resource): docker_image: VariableOrOptional[DockerImage] = None """ - Custom docker image BYOC + Custom Docker image for the cluster's nodes, used with + [Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html). """ driver_instance_pool_id: VariableOrOptional[str] = None @@ -231,8 +233,8 @@ class Cluster(Resource): Depending on `kind`, different validations and default values will be applied. Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. - * [is_single_node](/api/workspace/clusters/create#is_single_node) - * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. """ @@ -353,7 +355,8 @@ class Cluster(Resource): workload_type: VariableOrOptional[WorkloadType] = None """ - Cluster Attributes showing for clusters workload types. + Types of workloads that can use the cluster, such as notebooks or jobs. + If omitted, the cluster can be used for both notebooks and jobs. """ @classmethod @@ -382,7 +385,7 @@ class ClusterDict(TypedDict, total=False): """ Automatically terminates the cluster after it is inactive for this time in minutes. If not set, this cluster will not be automatically terminated. If specified, the threshold must be between - 10 and 10000 minutes. + 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable automatic termination. """ @@ -430,8 +433,9 @@ class ClusterDict(TypedDict, total=False): from a cluster. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. The following modes are legacy aliases for the above modes: @@ -444,7 +448,7 @@ class ClusterDict(TypedDict, total=False): * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. - * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled. """ dependency_mode: VariableOrOptional[DependencyModeParam] @@ -456,7 +460,8 @@ class ClusterDict(TypedDict, total=False): docker_image: VariableOrOptional[DockerImageParam] """ - Custom docker image BYOC + Custom Docker image for the cluster's nodes, used with + [Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html). """ driver_instance_pool_id: VariableOrOptional[str] @@ -521,8 +526,8 @@ class ClusterDict(TypedDict, total=False): Depending on `kind`, different validations and default values will be applied. Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. - * [is_single_node](/api/workspace/clusters/create#is_single_node) - * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. """ @@ -643,7 +648,8 @@ class ClusterDict(TypedDict, total=False): workload_type: VariableOrOptional[WorkloadTypeParam] """ - Cluster Attributes showing for clusters workload types. + Types of workloads that can use the cluster, such as notebooks or jobs. + If omitted, the cluster can be used for both notebooks and jobs. """ diff --git a/python/databricks/bundles/clusters/_models/docker_basic_auth.py b/python/databricks/bundles/clusters/_models/docker_basic_auth.py index 552ea90a83b..64782d3ae00 100644 --- a/python/databricks/bundles/clusters/_models/docker_basic_auth.py +++ b/python/databricks/bundles/clusters/_models/docker_basic_auth.py @@ -17,12 +17,12 @@ class DockerBasicAuth: password: VariableOrOptional[str] = None """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] = None """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ @classmethod @@ -38,12 +38,12 @@ class DockerBasicAuthDict(TypedDict, total=False): password: VariableOrOptional[str] """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ diff --git a/python/databricks/bundles/clusters/_models/library.py b/python/databricks/bundles/clusters/_models/library.py index 8961f8fe744..bfa68dec570 100644 --- a/python/databricks/bundles/clusters/_models/library.py +++ b/python/databricks/bundles/clusters/_models/library.py @@ -25,16 +25,20 @@ @dataclass(kw_only=True) class Library: - """""" + """ + A library to install on a cluster. Exactly one of the library-type fields must be set. + """ cran: VariableOrOptional[RCranLibrary] = None """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] = None """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] = None @@ -54,14 +58,15 @@ class Library: pypi: VariableOrOptional[PythonPyPiLibrary] = None """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] = None """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] = None @@ -86,12 +91,14 @@ class LibraryDict(TypedDict, total=False): cran: VariableOrOptional[RCranLibraryParam] """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] @@ -111,14 +118,15 @@ class LibraryDict(TypedDict, total=False): pypi: VariableOrOptional[PythonPyPiLibraryParam] """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] diff --git a/python/databricks/bundles/clusters/_models/maven_library.py b/python/databricks/bundles/clusters/_models/maven_library.py index 25be1599c28..4997ae6e399 100644 --- a/python/databricks/bundles/clusters/_models/maven_library.py +++ b/python/databricks/bundles/clusters/_models/maven_library.py @@ -26,7 +26,7 @@ class MavenLibrary: exclusions: VariableOrList[str] = field(default_factory=list) """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. @@ -56,7 +56,7 @@ class MavenLibraryDict(TypedDict, total=False): exclusions: VariableOrList[str] """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. diff --git a/python/databricks/bundles/clusters/_models/python_py_pi_library.py b/python/databricks/bundles/clusters/_models/python_py_pi_library.py index 037c2029f50..6bb88de00e8 100644 --- a/python/databricks/bundles/clusters/_models/python_py_pi_library.py +++ b/python/databricks/bundles/clusters/_models/python_py_pi_library.py @@ -17,7 +17,7 @@ class PythonPyPiLibrary: package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ @@ -40,7 +40,7 @@ class PythonPyPiLibraryDict(TypedDict, total=False): package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ diff --git a/python/databricks/bundles/experiments/_models/experiment_tag.py b/python/databricks/bundles/experiments/_models/experiment_tag.py index 2c78a181b17..fc64662b642 100644 --- a/python/databricks/bundles/experiments/_models/experiment_tag.py +++ b/python/databricks/bundles/experiments/_models/experiment_tag.py @@ -19,12 +19,12 @@ class ExperimentTag: key: VariableOrOptional[str] = None """ - The tag key. + The tag key. Keys are at most 255 characters long. """ value: VariableOrOptional[str] = None """ - The tag value. + The tag value. Values are at most 65535 characters long. """ @classmethod @@ -40,12 +40,12 @@ class ExperimentTagDict(TypedDict, total=False): key: VariableOrOptional[str] """ - The tag key. + The tag key. Keys are at most 255 characters long. """ value: VariableOrOptional[str] """ - The tag value. + The tag value. Values are at most 65535 characters long. """ diff --git a/python/databricks/bundles/experiments/_models/mlflow_experiment.py b/python/databricks/bundles/experiments/_models/mlflow_experiment.py index bafe167f2f8..1ad77d9d252 100644 --- a/python/databricks/bundles/experiments/_models/mlflow_experiment.py +++ b/python/databricks/bundles/experiments/_models/mlflow_experiment.py @@ -35,13 +35,18 @@ class MlflowExperiment(Resource): name: VariableOr[str] """ - Experiment name. + Name of the experiment, as an absolute path in the workspace. Experiments cannot be created + under `/Repos`. """ artifact_location: VariableOrOptional[str] = None """ - Location where all artifacts for the experiment are stored. - If not provided, the remote server will select an appropriate default. + URI of the location where the artifacts of the experiment's runs are stored, such as a Unity + Catalog volume path of the form `dbfs:/Volumes////`. The URI + must have a scheme other than `file` and must not point under the MLflow-managed prefix + `dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed + storage. See https://docs.databricks.com/aws/en/mlflow/experiments for the supported + locations. """ lifecycle: VariableOrOptional[Lifecycle] = None @@ -58,10 +63,8 @@ class MlflowExperiment(Resource): tags: VariableOrList[ExperimentTag] = field(default_factory=list) """ - A collection of tags to set on the experiment. Maximum tag size and number of tags per request - depends on the storage backend. All storage backends are guaranteed to support tag keys up - to 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also - guaranteed to support up to 20 tags per request. + Tags to set on the new experiment, as key-value pairs. A request can include at most 100 + tags. """ trace_location: VariableOrOptional[ExperimentTraceLocation] = None @@ -87,13 +90,18 @@ class MlflowExperimentDict(TypedDict, total=False): name: VariableOr[str] """ - Experiment name. + Name of the experiment, as an absolute path in the workspace. Experiments cannot be created + under `/Repos`. """ artifact_location: VariableOrOptional[str] """ - Location where all artifacts for the experiment are stored. - If not provided, the remote server will select an appropriate default. + URI of the location where the artifacts of the experiment's runs are stored, such as a Unity + Catalog volume path of the form `dbfs:/Volumes////`. The URI + must have a scheme other than `file` and must not point under the MLflow-managed prefix + `dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed + storage. See https://docs.databricks.com/aws/en/mlflow/experiments for the supported + locations. """ lifecycle: VariableOrOptional[LifecycleParam] @@ -108,10 +116,8 @@ class MlflowExperimentDict(TypedDict, total=False): tags: VariableOrList[ExperimentTagParam] """ - A collection of tags to set on the experiment. Maximum tag size and number of tags per request - depends on the storage backend. All storage backends are guaranteed to support tag keys up - to 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also - guaranteed to support up to 20 tags per request. + Tags to set on the new experiment, as key-value pairs. A request can include at most 100 + tags. """ trace_location: VariableOrOptional[ExperimentTraceLocationParam] diff --git a/python/databricks/bundles/instance_pools/_models/docker_basic_auth.py b/python/databricks/bundles/instance_pools/_models/docker_basic_auth.py index 552ea90a83b..64782d3ae00 100644 --- a/python/databricks/bundles/instance_pools/_models/docker_basic_auth.py +++ b/python/databricks/bundles/instance_pools/_models/docker_basic_auth.py @@ -17,12 +17,12 @@ class DockerBasicAuth: password: VariableOrOptional[str] = None """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] = None """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ @classmethod @@ -38,12 +38,12 @@ class DockerBasicAuthDict(TypedDict, total=False): password: VariableOrOptional[str] """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ diff --git a/python/databricks/bundles/job_runs/_models/job_run.py b/python/databricks/bundles/job_runs/_models/job_run.py index e7f5a0b3f71..dff71948fd8 100644 --- a/python/databricks/bundles/job_runs/_models/job_run.py +++ b/python/databricks/bundles/job_runs/_models/job_run.py @@ -54,7 +54,7 @@ class JobRun(Resource): job_parameters: VariableOrDict[str] = field(default_factory=dict) """ - Job-level parameters used in the run. for example `"param": "overriding_val"` + Job-level parameters used in the run, for example `"param": "overriding_val"`. """ lifecycle: VariableOrOptional[JobRunLifecycle] = None @@ -118,7 +118,7 @@ class JobRunDict(TypedDict, total=False): job_parameters: VariableOrDict[str] """ - Job-level parameters used in the run. for example `"param": "overriding_val"` + Job-level parameters used in the run, for example `"param": "overriding_val"`. """ lifecycle: VariableOrOptional[JobRunLifecycleParam] diff --git a/python/databricks/bundles/jobs/_models/azure_attributes.py b/python/databricks/bundles/jobs/_models/azure_attributes.py index 64509dcd040..a89d3368ca6 100644 --- a/python/databricks/bundles/jobs/_models/azure_attributes.py +++ b/python/databricks/bundles/jobs/_models/azure_attributes.py @@ -60,7 +60,8 @@ class AzureAttributes: log_analytics_info: VariableOrOptional[LogAnalyticsInfo] = None """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] = None @@ -117,7 +118,8 @@ class AzureAttributesDict(TypedDict, total=False): log_analytics_info: VariableOrOptional[LogAnalyticsInfoParam] """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] diff --git a/python/databricks/bundles/jobs/_models/cluster_spec.py b/python/databricks/bundles/jobs/_models/cluster_spec.py index c3ade14be4a..0b473b0d2da 100644 --- a/python/databricks/bundles/jobs/_models/cluster_spec.py +++ b/python/databricks/bundles/jobs/_models/cluster_spec.py @@ -79,7 +79,7 @@ class ClusterSpec: """ Automatically terminates the cluster after it is inactive for this time in minutes. If not set, this cluster will not be automatically terminated. If specified, the threshold must be between - 10 and 10000 minutes. + 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable automatic termination. """ @@ -127,8 +127,9 @@ class ClusterSpec: from a cluster. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. The following modes are legacy aliases for the above modes: @@ -141,7 +142,7 @@ class ClusterSpec: * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. - * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled. """ dependency_mode: VariableOrOptional[DependencyMode] = None @@ -153,7 +154,8 @@ class ClusterSpec: docker_image: VariableOrOptional[DockerImage] = None """ - Custom docker image BYOC + Custom Docker image for the cluster's nodes, used with + [Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html). """ driver_instance_pool_id: VariableOrOptional[str] = None @@ -218,8 +220,8 @@ class ClusterSpec: Depending on `kind`, different validations and default values will be applied. Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. - * [is_single_node](/api/workspace/clusters/create#is_single_node) - * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. """ @@ -325,7 +327,8 @@ class ClusterSpec: workload_type: VariableOrOptional[WorkloadType] = None """ - Cluster Attributes showing for clusters workload types. + Types of workloads that can use the cluster, such as notebooks or jobs. + If omitted, the cluster can be used for both notebooks and jobs. """ @classmethod @@ -354,7 +357,7 @@ class ClusterSpecDict(TypedDict, total=False): """ Automatically terminates the cluster after it is inactive for this time in minutes. If not set, this cluster will not be automatically terminated. If specified, the threshold must be between - 10 and 10000 minutes. + 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable automatic termination. """ @@ -402,8 +405,9 @@ class ClusterSpecDict(TypedDict, total=False): from a cluster. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. The following modes are legacy aliases for the above modes: @@ -416,7 +420,7 @@ class ClusterSpecDict(TypedDict, total=False): * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. - * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn't have UC or passthrough enabled. """ dependency_mode: VariableOrOptional[DependencyModeParam] @@ -428,7 +432,8 @@ class ClusterSpecDict(TypedDict, total=False): docker_image: VariableOrOptional[DockerImageParam] """ - Custom docker image BYOC + Custom Docker image for the cluster's nodes, used with + [Databricks Container Services](https://docs.databricks.com/compute/custom-containers.html). """ driver_instance_pool_id: VariableOrOptional[str] @@ -493,8 +498,8 @@ class ClusterSpecDict(TypedDict, total=False): Depending on `kind`, different validations and default values will be applied. Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. - * [is_single_node](/api/workspace/clusters/create#is_single_node) - * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + * [is_single_node](https://docs.databricks.com/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime) By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. """ @@ -600,7 +605,8 @@ class ClusterSpecDict(TypedDict, total=False): workload_type: VariableOrOptional[WorkloadTypeParam] """ - Cluster Attributes showing for clusters workload types. + Types of workloads that can use the cluster, such as notebooks or jobs. + If omitted, the cluster can be used for both notebooks and jobs. """ diff --git a/python/databricks/bundles/jobs/_models/docker_basic_auth.py b/python/databricks/bundles/jobs/_models/docker_basic_auth.py index 552ea90a83b..64782d3ae00 100644 --- a/python/databricks/bundles/jobs/_models/docker_basic_auth.py +++ b/python/databricks/bundles/jobs/_models/docker_basic_auth.py @@ -17,12 +17,12 @@ class DockerBasicAuth: password: VariableOrOptional[str] = None """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] = None """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ @classmethod @@ -38,12 +38,12 @@ class DockerBasicAuthDict(TypedDict, total=False): password: VariableOrOptional[str] """ - Password of the user + Password for authenticating to the Docker registry that hosts the image. """ username: VariableOrOptional[str] """ - Name of the user + User name for authenticating to the Docker registry that hosts the image. """ diff --git a/python/databricks/bundles/jobs/_models/git_source.py b/python/databricks/bundles/jobs/_models/git_source.py index 4ddd1d83764..67e8dbd9be3 100644 --- a/python/databricks/bundles/jobs/_models/git_source.py +++ b/python/databricks/bundles/jobs/_models/git_source.py @@ -52,6 +52,9 @@ class GitSource: """ sparse_checkout: VariableOrOptional[SparseCheckout] = None + """ + Sparse checkout settings for the repository. When set, only the directories listed in `patterns` are checked out. + """ @classmethod def from_dict(cls, value: "GitSourceDict") -> "Self": @@ -90,6 +93,9 @@ class GitSourceDict(TypedDict, total=False): """ sparse_checkout: VariableOrOptional[SparseCheckoutParam] + """ + Sparse checkout settings for the repository. When set, only the directories listed in `patterns` are checked out. + """ GitSourceParam = GitSourceDict | GitSource diff --git a/python/databricks/bundles/jobs/_models/job_completion_trigger_configuration_monitored_job.py b/python/databricks/bundles/jobs/_models/job_completion_trigger_configuration_monitored_job.py index 377008f2908..11170875a63 100644 --- a/python/databricks/bundles/jobs/_models/job_completion_trigger_configuration_monitored_job.py +++ b/python/databricks/bundles/jobs/_models/job_completion_trigger_configuration_monitored_job.py @@ -31,7 +31,6 @@ class JobCompletionTriggerConfigurationMonitoredJob: [Beta] The ID of the workspace containing the upstream job. This can differ from the caller's workspace and downstream services enforce correct entitlements and CAN_VIEW permissions for the user + job combination. - SDR: https://databricks.atlassian.net/browse/SDR-5267 """ @classmethod @@ -61,7 +60,6 @@ class JobCompletionTriggerConfigurationMonitoredJobDict(TypedDict, total=False): [Beta] The ID of the workspace containing the upstream job. This can differ from the caller's workspace and downstream services enforce correct entitlements and CAN_VIEW permissions for the user + job combination. - SDR: https://databricks.atlassian.net/browse/SDR-5267 """ diff --git a/python/databricks/bundles/jobs/_models/job_environment.py b/python/databricks/bundles/jobs/_models/job_environment.py index c71ee45dbd6..57a3f119ffe 100644 --- a/python/databricks/bundles/jobs/_models/job_environment.py +++ b/python/databricks/bundles/jobs/_models/job_environment.py @@ -23,8 +23,7 @@ class JobEnvironment: spec: VariableOrOptional[Environment] = None """ - The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines. - In this minimal environment spec, only pip and java dependencies are supported. + The environment specification, including the environment version and the dependencies to install before a task runs. """ @classmethod @@ -45,8 +44,7 @@ class JobEnvironmentDict(TypedDict, total=False): spec: VariableOrOptional[EnvironmentParam] """ - The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines. - In this minimal environment spec, only pip and java dependencies are supported. + The environment specification, including the environment version and the dependencies to install before a task runs. """ diff --git a/python/databricks/bundles/jobs/_models/jobs_health_rules.py b/python/databricks/bundles/jobs/_models/jobs_health_rules.py index daf613406b5..56dc6d1fc94 100644 --- a/python/databricks/bundles/jobs/_models/jobs_health_rules.py +++ b/python/databricks/bundles/jobs/_models/jobs_health_rules.py @@ -22,6 +22,9 @@ class JobsHealthRules: """ rules: VariableOrList[JobsHealthRule] = field(default_factory=list) + """ + The health rules to evaluate for each run. + """ @classmethod def from_dict(cls, value: "JobsHealthRulesDict") -> "Self": @@ -35,6 +38,9 @@ class JobsHealthRulesDict(TypedDict, total=False): """""" rules: VariableOrList[JobsHealthRuleParam] + """ + The health rules to evaluate for each run. + """ JobsHealthRulesParam = JobsHealthRulesDict | JobsHealthRules diff --git a/python/databricks/bundles/jobs/_models/library.py b/python/databricks/bundles/jobs/_models/library.py index 29d4c5b1fdd..eb5a9870960 100644 --- a/python/databricks/bundles/jobs/_models/library.py +++ b/python/databricks/bundles/jobs/_models/library.py @@ -25,16 +25,20 @@ @dataclass(kw_only=True) class Library: - """""" + """ + A library to install on a cluster. Exactly one of the library-type fields must be set. + """ cran: VariableOrOptional[RCranLibrary] = None """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] = None """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] = None @@ -54,14 +58,15 @@ class Library: pypi: VariableOrOptional[PythonPyPiLibrary] = None """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] = None """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] = None @@ -86,12 +91,14 @@ class LibraryDict(TypedDict, total=False): cran: VariableOrOptional[RCranLibraryParam] """ - Specification of a CRAN library to be installed as part of the library + Specification of a CRAN library to be installed. """ egg: VariableOrOptional[str] """ - [DEPRECATED] Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. + [DEPRECATED] Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above. + Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file + to install. """ jar: VariableOrOptional[str] @@ -111,14 +118,15 @@ class LibraryDict(TypedDict, total=False): pypi: VariableOrOptional[PythonPyPiLibraryParam] """ - Specification of a PyPi library to be installed. For example: + Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` """ requirements: VariableOrOptional[str] """ URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported. - For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }` + For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }` or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. + Installing a requirements file requires Databricks Runtime 15.0 or above. """ whl: VariableOrOptional[str] diff --git a/python/databricks/bundles/jobs/_models/maven_library.py b/python/databricks/bundles/jobs/_models/maven_library.py index 25be1599c28..4997ae6e399 100644 --- a/python/databricks/bundles/jobs/_models/maven_library.py +++ b/python/databricks/bundles/jobs/_models/maven_library.py @@ -26,7 +26,7 @@ class MavenLibrary: exclusions: VariableOrList[str] = field(default_factory=list) """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. @@ -56,7 +56,7 @@ class MavenLibraryDict(TypedDict, total=False): exclusions: VariableOrList[str] """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. diff --git a/python/databricks/bundles/jobs/_models/python_py_pi_library.py b/python/databricks/bundles/jobs/_models/python_py_pi_library.py index 037c2029f50..6bb88de00e8 100644 --- a/python/databricks/bundles/jobs/_models/python_py_pi_library.py +++ b/python/databricks/bundles/jobs/_models/python_py_pi_library.py @@ -17,7 +17,7 @@ class PythonPyPiLibrary: package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ @@ -40,7 +40,7 @@ class PythonPyPiLibraryDict(TypedDict, total=False): package: VariableOr[str] """ - The name of the pypi package to install. An optional exact version specification is also + The name of the PyPI package to install. An optional exact version specification is also supported. Examples: "simplejson" and "simplejson==3.8.0". """ diff --git a/python/databricks/bundles/jobs/_models/sparse_checkout.py b/python/databricks/bundles/jobs/_models/sparse_checkout.py index a42a78e49f1..664a4c47641 100644 --- a/python/databricks/bundles/jobs/_models/sparse_checkout.py +++ b/python/databricks/bundles/jobs/_models/sparse_checkout.py @@ -17,7 +17,7 @@ class SparseCheckout: patterns: VariableOrList[str] = field(default_factory=list) """ - List of patterns to include for sparse checkout. + List of patterns to include for sparse checkout. Each pattern is the path of a directory relative to the repository root. """ @classmethod @@ -33,7 +33,7 @@ class SparseCheckoutDict(TypedDict, total=False): patterns: VariableOrList[str] """ - List of patterns to include for sparse checkout. + List of patterns to include for sparse checkout. Each pattern is the path of a directory relative to the repository root. """ diff --git a/python/databricks/bundles/jobs/_models/sql_condition_configuration.py b/python/databricks/bundles/jobs/_models/sql_condition_configuration.py index 3115d708f59..d588b8a4b2c 100644 --- a/python/databricks/bundles/jobs/_models/sql_condition_configuration.py +++ b/python/databricks/bundles/jobs/_models/sql_condition_configuration.py @@ -19,18 +19,19 @@ class SqlConditionConfiguration: """""" - sql_query_id: VariableOr[str] + warehouse_id: VariableOr[str] """ :meta private: [EXPERIMENTAL] - [Beta] The ID of the SQL query to evaluate as the trigger condition. + [Beta] The canonical identifier of the SQL warehouse to run the condition query against. """ - warehouse_id: VariableOr[str] + sql_query_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - [Beta] The canonical identifier of the SQL warehouse to run the condition query against. + [Beta] The ID of the SQL query to evaluate as the trigger condition. + Exactly one of `sql_query_id` or `file` must be set. """ trigger_mode: VariableOrOptional[SqlConditionTriggerMode] = None @@ -55,18 +56,19 @@ def as_dict(self) -> "SqlConditionConfigurationDict": class SqlConditionConfigurationDict(TypedDict, total=False): """""" - sql_query_id: VariableOr[str] + warehouse_id: VariableOr[str] """ :meta private: [EXPERIMENTAL] - [Beta] The ID of the SQL query to evaluate as the trigger condition. + [Beta] The canonical identifier of the SQL warehouse to run the condition query against. """ - warehouse_id: VariableOr[str] + sql_query_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - [Beta] The canonical identifier of the SQL warehouse to run the condition query against. + [Beta] The ID of the SQL query to evaluate as the trigger condition. + Exactly one of `sql_query_id` or `file` must be set. """ trigger_mode: VariableOrOptional[SqlConditionTriggerModeParam] diff --git a/python/databricks/bundles/jobs/_models/task.py b/python/databricks/bundles/jobs/_models/task.py index d86cb6d38ab..e058b6d5035 100644 --- a/python/databricks/bundles/jobs/_models/task.py +++ b/python/databricks/bundles/jobs/_models/task.py @@ -234,7 +234,7 @@ class Task: health: VariableOrOptional[JobsHealthRules] = None """ - An optional set of health rules that can be defined for this job. + An optional set of health rules that can be defined for this task. """ job_cluster_key: VariableOrOptional[str] = None @@ -488,7 +488,7 @@ class TaskDict(TypedDict, total=False): health: VariableOrOptional[JobsHealthRulesParam] """ - An optional set of health rules that can be defined for this job. + An optional set of health rules that can be defined for this task. """ job_cluster_key: VariableOrOptional[str] diff --git a/python/databricks/bundles/jobs/_models/trigger_settings.py b/python/databricks/bundles/jobs/_models/trigger_settings.py index 97168198063..6b247879980 100644 --- a/python/databricks/bundles/jobs/_models/trigger_settings.py +++ b/python/databricks/bundles/jobs/_models/trigger_settings.py @@ -78,6 +78,9 @@ class TriggerSettings: """ table_update: VariableOrOptional[TableUpdateTriggerConfiguration] = None + """ + Table update trigger settings. + """ @classmethod def from_dict(cls, value: "TriggerSettingsDict") -> "Self": @@ -128,6 +131,9 @@ class TriggerSettingsDict(TypedDict, total=False): """ table_update: VariableOrOptional[TableUpdateTriggerConfigurationParam] + """ + Table update trigger settings. + """ TriggerSettingsParam = TriggerSettingsDict | TriggerSettings diff --git a/python/databricks/bundles/jobs/_models/webhook.py b/python/databricks/bundles/jobs/_models/webhook.py index 17a391ac2c2..4cfa3978cd2 100644 --- a/python/databricks/bundles/jobs/_models/webhook.py +++ b/python/databricks/bundles/jobs/_models/webhook.py @@ -16,6 +16,9 @@ class Webhook: """""" id: VariableOr[str] + """ + The ID of the notification destination to call. Must be a UUID. + """ @classmethod def from_dict(cls, value: "WebhookDict") -> "Self": @@ -29,6 +32,9 @@ class WebhookDict(TypedDict, total=False): """""" id: VariableOr[str] + """ + The ID of the notification destination to call. Must be a UUID. + """ WebhookParam = WebhookDict | Webhook diff --git a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config.py b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config.py index 9c183cb2a3a..ceca6888657 100644 --- a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config.py +++ b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config.py @@ -81,34 +81,39 @@ class ModelProviderServiceConfig: ModelProviderServiceConfigAmazonBedrockProviderConfig ] = None """ - Amazon Bedrock provider configuration. + Configuration for Amazon Bedrock. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK`. """ anthropic: VariableOrOptional[ModelProviderServiceConfigAnthropicProviderConfig] = ( None ) """ - Anthropic provider configuration. Exactly one of `direct` or `relayed` must - be set on Create; the two are mutually exclusive. + Configuration for Anthropic. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC`. """ azure_openai: VariableOrOptional[ ModelProviderServiceConfigAzureOpenAiProviderConfig ] = None """ - Azure OpenAI provider configuration. + Configuration for Azure OpenAI. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI`. """ bedrock_mantle: VariableOrOptional[ ModelProviderServiceConfigAmazonBedrockProviderConfig ] = None """ - Amazon Bedrock provider configuration. + Configuration for Amazon Bedrock Mantle, with the same fields as + `amazon_bedrock`. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE`. """ custom: VariableOrOptional[ModelProviderServiceConfigCustomProviderConfig] = None """ - Custom OpenAI-compatible provider configuration. + Configuration for a custom OpenAI-compatible provider. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM`. """ forward_headers: VariableOrOptional[bool] = None @@ -141,7 +146,8 @@ class ModelProviderServiceConfig: ModelProviderServiceConfigGeminiEnterpriseProviderConfig ] = None """ - Gemini Enterprise provider configuration. + Configuration for Google Gemini Enterprise. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE`. """ inference_table: VariableOrOptional[InferenceTableConfig] = None @@ -155,12 +161,14 @@ class ModelProviderServiceConfig: ModelProviderServiceConfigMicrosoftFoundryProviderConfig ] = None """ - Microsoft Foundry provider configuration. + Configuration for Microsoft Foundry. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY`. """ openai: VariableOrOptional[ModelProviderServiceConfigOpenAiProviderConfig] = None """ - OpenAI provider configuration. + Configuration for OpenAI. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI`. """ pricing: VariableOrOptional[ModelProviderServiceConfigProviderPricingConfig] = None @@ -220,34 +228,39 @@ class ModelProviderServiceConfigDict(TypedDict, total=False): ModelProviderServiceConfigAmazonBedrockProviderConfigParam ] """ - Amazon Bedrock provider configuration. + Configuration for Amazon Bedrock. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK`. """ anthropic: VariableOrOptional[ ModelProviderServiceConfigAnthropicProviderConfigParam ] """ - Anthropic provider configuration. Exactly one of `direct` or `relayed` must - be set on Create; the two are mutually exclusive. + Configuration for Anthropic. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC`. """ azure_openai: VariableOrOptional[ ModelProviderServiceConfigAzureOpenAiProviderConfigParam ] """ - Azure OpenAI provider configuration. + Configuration for Azure OpenAI. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI`. """ bedrock_mantle: VariableOrOptional[ ModelProviderServiceConfigAmazonBedrockProviderConfigParam ] """ - Amazon Bedrock provider configuration. + Configuration for Amazon Bedrock Mantle, with the same fields as + `amazon_bedrock`. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE`. """ custom: VariableOrOptional[ModelProviderServiceConfigCustomProviderConfigParam] """ - Custom OpenAI-compatible provider configuration. + Configuration for a custom OpenAI-compatible provider. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM`. """ forward_headers: VariableOrOptional[bool] @@ -280,7 +293,8 @@ class ModelProviderServiceConfigDict(TypedDict, total=False): ModelProviderServiceConfigGeminiEnterpriseProviderConfigParam ] """ - Gemini Enterprise provider configuration. + Configuration for Google Gemini Enterprise. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE`. """ inference_table: VariableOrOptional[InferenceTableConfigParam] @@ -294,12 +308,14 @@ class ModelProviderServiceConfigDict(TypedDict, total=False): ModelProviderServiceConfigMicrosoftFoundryProviderConfigParam ] """ - Microsoft Foundry provider configuration. + Configuration for Microsoft Foundry. Set this field when + `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY`. """ openai: VariableOrOptional[ModelProviderServiceConfigOpenAiProviderConfigParam] """ - OpenAI provider configuration. + Configuration for OpenAI. Set this field when `provider_type` is + `EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI`. """ pricing: VariableOrOptional[ModelProviderServiceConfigProviderPricingConfigParam] diff --git a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_custom_provider_api_key_header_auth.py b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_custom_provider_api_key_header_auth.py index 78865d1c8f2..e69731acac9 100644 --- a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_custom_provider_api_key_header_auth.py +++ b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_custom_provider_api_key_header_auth.py @@ -33,7 +33,7 @@ class ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth: api_key_value: VariableOrOptional[ModelProviderServiceConfigProviderSecret] = None """ Secret value forwarded under the `api_key_name` header on outbound - requests. Supplied as inline plaintext via `ProviderSecret.plaintext`. + requests. Supply the value in `api_key_value.plaintext`. """ @classmethod @@ -61,7 +61,7 @@ class ModelProviderServiceConfigCustomProviderApiKeyHeaderAuthDict( api_key_value: VariableOrOptional[ModelProviderServiceConfigProviderSecretParam] """ Secret value forwarded under the `api_key_name` header on outbound - requests. Supplied as inline plaintext via `ProviderSecret.plaintext`. + requests. Supply the value in `api_key_value.plaintext`. """ diff --git a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_provider_secret.py b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_provider_secret.py index fd6cef72cf8..b87c3dbc240 100644 --- a/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_provider_secret.py +++ b/python/databricks/bundles/model_provider_services/_models/model_provider_service_config_provider_secret.py @@ -26,9 +26,10 @@ class ModelProviderServiceConfigProviderSecret: plaintext: VariableOrOptional[str] = None """ - Inline plaintext credential. INPUT_ONLY: the value never round-trips on - reads. Get and List responses omit `plaintext`; the enclosing secret - object remains present to indicate that a secret is configured. + Inline plaintext credential. The value is write-only and never + round-trips on reads. Get and List responses omit `plaintext`; the + enclosing secret object remains present to indicate that a secret is + configured. """ secret_reference: VariableOrOptional[ModelProviderServiceConfigSecretReference] = ( @@ -56,9 +57,10 @@ class ModelProviderServiceConfigProviderSecretDict(TypedDict, total=False): plaintext: VariableOrOptional[str] """ - Inline plaintext credential. INPUT_ONLY: the value never round-trips on - reads. Get and List responses omit `plaintext`; the enclosing secret - object remains present to indicate that a secret is configured. + Inline plaintext credential. The value is write-only and never + round-trips on reads. Get and List responses omit `plaintext`; the + enclosing secret object remains present to indicate that a secret is + configured. """ secret_reference: VariableOrOptional[ModelProviderServiceConfigSecretReferenceParam] diff --git a/python/databricks/bundles/pipelines/_models/azure_attributes.py b/python/databricks/bundles/pipelines/_models/azure_attributes.py index 7caff90e481..b85c3f09cf0 100644 --- a/python/databricks/bundles/pipelines/_models/azure_attributes.py +++ b/python/databricks/bundles/pipelines/_models/azure_attributes.py @@ -60,7 +60,8 @@ class AzureAttributes: log_analytics_info: VariableOrOptional[LogAnalyticsInfo] = None """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] = None @@ -117,7 +118,8 @@ class AzureAttributesDict(TypedDict, total=False): log_analytics_info: VariableOrOptional[LogAnalyticsInfoParam] """ - Defines values necessary to configure and run Azure Log Analytics agent + Defines values necessary to configure and run Azure Log Analytics agent. + Both `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither. """ spot_bid_max_price: VariableOrOptional[float] diff --git a/python/databricks/bundles/pipelines/_models/connector_options.py b/python/databricks/bundles/pipelines/_models/connector_options.py index 09e00d227f5..40af5daf9e2 100644 --- a/python/databricks/bundles/pipelines/_models/connector_options.py +++ b/python/databricks/bundles/pipelines/_models/connector_options.py @@ -196,9 +196,7 @@ class ConnectorOptions: tiktok_ads_options: VariableOrOptional[TikTokAdsOptions] = None """ - :meta private: [EXPERIMENTAL] - - [Beta] TikTok Ads specific options for ingestion + [Public Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptions] = None @@ -328,9 +326,7 @@ class ConnectorOptionsDict(TypedDict, total=False): tiktok_ads_options: VariableOrOptional[TikTokAdsOptionsParam] """ - :meta private: [EXPERIMENTAL] - - [Beta] TikTok Ads specific options for ingestion + [Public Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptionsParam] diff --git a/python/databricks/bundles/pipelines/_models/maven_library.py b/python/databricks/bundles/pipelines/_models/maven_library.py index 25be1599c28..4997ae6e399 100644 --- a/python/databricks/bundles/pipelines/_models/maven_library.py +++ b/python/databricks/bundles/pipelines/_models/maven_library.py @@ -26,7 +26,7 @@ class MavenLibrary: exclusions: VariableOrList[str] = field(default_factory=list) """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. @@ -56,7 +56,7 @@ class MavenLibraryDict(TypedDict, total=False): exclusions: VariableOrList[str] """ - List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. + List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`. Maven dependency exclusions: https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html. diff --git a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py index 9b26ea5d1dc..aa2cc95ea7c 100644 --- a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py @@ -44,52 +44,38 @@ class TikTokAdsOptions: data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevel] = None """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.data_level instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.data_level instead. """ dimensions: VariableOrList[str] = field(default_factory=list) """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.dimensions instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.dimensions instead. """ lookback_window_days: VariableOrOptional[int] = None """ - :meta private: [EXPERIMENTAL] - - [Beta] (Optional) Number of days to look back for report tables during incremental sync + [Public Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. """ metrics: VariableOrList[str] = field(default_factory=list) """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.metrics instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.metrics instead. """ query_lifetime: VariableOrOptional[bool] = None """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.query_lifetime instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.query_lifetime instead. """ report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportType] = None """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.report_type instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.report_type instead. """ sync_start_date: VariableOrOptional[str] = None """ - :meta private: [EXPERIMENTAL] - - [Beta] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Public Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. """ @@ -119,52 +105,38 @@ class TikTokAdsOptionsDict(TypedDict, total=False): data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevelParam] """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.data_level instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.data_level instead. """ dimensions: VariableOrList[str] """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.dimensions instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.dimensions instead. """ lookback_window_days: VariableOrOptional[int] """ - :meta private: [EXPERIMENTAL] - - [Beta] (Optional) Number of days to look back for report tables during incremental sync + [Public Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. """ metrics: VariableOrList[str] """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.metrics instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.metrics instead. """ query_lifetime: VariableOrOptional[bool] """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.query_lifetime instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.query_lifetime instead. """ report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportTypeParam] """ - :meta private: [EXPERIMENTAL] - - [DEPRECATED] [Beta] Deprecated. Use custom_report_options.report_type instead. + [DEPRECATED] [Public Preview] Deprecated. Use custom_report_options.report_type instead. """ sync_start_date: VariableOrOptional[str] """ - :meta private: [EXPERIMENTAL] - - [Beta] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Public Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. """ diff --git a/python/databricks/bundles/schemas/_models/schema.py b/python/databricks/bundles/schemas/_models/schema.py index 32ff22c8227..f8a8809f120 100644 --- a/python/databricks/bundles/schemas/_models/schema.py +++ b/python/databricks/bundles/schemas/_models/schema.py @@ -43,7 +43,9 @@ class Schema(Resource): custom_max_retention_hours: VariableOrOptional[int] = None """ - [Public Preview] Custom maximum retention period in hours for the schema. + [Public Preview] Dropped objects in the schema remain recoverable for this number of hours before they are permanently + purged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set + their own value inherit the parent catalog's value. """ grants: VariableOrList[PrivilegeAssignment] = field(default_factory=list) @@ -63,7 +65,11 @@ class Schema(Resource): storage_root: VariableOrOptional[str] = None """ - Storage root URL for managed tables within schema. + Managed tables and volumes in the schema are stored under this storage root URL. The path must be + inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted, + managed data is stored under the parent catalog's storage root, or under the metastore's root storage + location when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and + schemas in a federated Hive metastore catalog must set one. """ @classmethod @@ -94,7 +100,9 @@ class SchemaDict(TypedDict, total=False): custom_max_retention_hours: VariableOrOptional[int] """ - [Public Preview] Custom maximum retention period in hours for the schema. + [Public Preview] Dropped objects in the schema remain recoverable for this number of hours before they are permanently + purged. The value must be 0 or within the range allowed for the metastore. Schemas that do not set + their own value inherit the parent catalog's value. """ grants: VariableOrList[PrivilegeAssignmentParam] @@ -114,7 +122,11 @@ class SchemaDict(TypedDict, total=False): storage_root: VariableOrOptional[str] """ - Storage root URL for managed tables within schema. + Managed tables and volumes in the schema are stored under this storage root URL. The path must be + inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If omitted, + managed data is stored under the parent catalog's storage root, or under the metastore's root storage + location when the catalog has none. Schemas in Delta Sharing catalogs cannot have a storage root, and + schemas in a federated Hive metastore catalog must set one. """ diff --git a/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py b/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py index 5219f6443cc..c3b91e849b5 100644 --- a/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py +++ b/python/databricks/bundles/sql_warehouses/_models/sql_warehouse.py @@ -45,7 +45,8 @@ class SqlWarehouse(Resource): RUNNING queries) before it is automatically stopped. Supported values: - - Must be == 0 or >= 10 mins + - Must be == 0 or >= 1 min for serverless warehouses. + - Must be == 0 or >= 10 mins for classic and pro warehouses. - 0 indicates no autostop. Defaults to 120 mins @@ -175,9 +176,7 @@ class SqlWarehouse(Resource): statement_timeout: VariableOrOptional[int] = None """ - :meta private: [EXPERIMENTAL] - - [Beta] Warehouse statement timeout in seconds. + [Public Preview] Warehouse statement timeout in seconds. """ tags: VariableOrOptional[EndpointTags] = None @@ -212,7 +211,8 @@ class SqlWarehouseDict(TypedDict, total=False): RUNNING queries) before it is automatically stopped. Supported values: - - Must be == 0 or >= 10 mins + - Must be == 0 or >= 1 min for serverless warehouses. + - Must be == 0 or >= 10 mins for classic and pro warehouses. - 0 indicates no autostop. Defaults to 120 mins @@ -342,9 +342,7 @@ class SqlWarehouseDict(TypedDict, total=False): statement_timeout: VariableOrOptional[int] """ - :meta private: [EXPERIMENTAL] - - [Beta] Warehouse statement timeout in seconds. + [Public Preview] Warehouse statement timeout in seconds. """ tags: VariableOrOptional[EndpointTagsParam] diff --git a/python/databricks/bundles/vector_search_indexes/_models/delta_sync_vector_index_spec_request.py b/python/databricks/bundles/vector_search_indexes/_models/delta_sync_vector_index_spec_request.py index b7af851711b..77996d287eb 100644 --- a/python/databricks/bundles/vector_search_indexes/_models/delta_sync_vector_index_spec_request.py +++ b/python/databricks/bundles/vector_search_indexes/_models/delta_sync_vector_index_spec_request.py @@ -46,14 +46,18 @@ class DeltaSyncVectorIndexSpecRequest: default_factory=list ) """ - The columns that contain the embedding source. + The source table column whose text Databricks embeds, together with the embedding model + endpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of + `embedding_source_columns` or `embedding_vector_columns` must be specified unless the index + subtype is `FULL_TEXT`, and only one column is supported. """ embedding_vector_columns: VariableOrList[EmbeddingVectorColumn] = field( default_factory=list ) """ - The columns that contain the embedding vectors. + The source table column that contains precomputed embedding vectors. Set this instead of + `embedding_source_columns` for an index with self-managed embeddings. """ embedding_writeback_table: VariableOrOptional[str] = None @@ -70,7 +74,7 @@ class DeltaSyncVectorIndexSpecRequest: source_table: VariableOrOptional[str] = None """ - The name of the source table. + Three-level Unity Catalog name of the source table that the index is synced from. """ @classmethod @@ -101,12 +105,16 @@ class DeltaSyncVectorIndexSpecRequestDict(TypedDict, total=False): embedding_source_columns: VariableOrList[EmbeddingSourceColumnParam] """ - The columns that contain the embedding source. + The source table column whose text Databricks embeds, together with the embedding model + endpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of + `embedding_source_columns` or `embedding_vector_columns` must be specified unless the index + subtype is `FULL_TEXT`, and only one column is supported. """ embedding_vector_columns: VariableOrList[EmbeddingVectorColumnParam] """ - The columns that contain the embedding vectors. + The source table column that contains precomputed embedding vectors. Set this instead of + `embedding_source_columns` for an index with self-managed embeddings. """ embedding_writeback_table: VariableOrOptional[str] @@ -123,7 +131,7 @@ class DeltaSyncVectorIndexSpecRequestDict(TypedDict, total=False): source_table: VariableOrOptional[str] """ - The name of the source table. + Three-level Unity Catalog name of the source table that the index is synced from. """ diff --git a/python/databricks/bundles/vector_search_indexes/_models/direct_access_vector_index_spec.py b/python/databricks/bundles/vector_search_indexes/_models/direct_access_vector_index_spec.py index 76ef31b4b30..11a9dc07375 100644 --- a/python/databricks/bundles/vector_search_indexes/_models/direct_access_vector_index_spec.py +++ b/python/databricks/bundles/vector_search_indexes/_models/direct_access_vector_index_spec.py @@ -27,21 +27,25 @@ class DirectAccessVectorIndexSpec: default_factory=list ) """ - The columns that contain the embedding source. The format should be array[double]. + Embedding source configuration used to embed `query_text` when the index is queried with text, + naming the embedding model endpoint to use. The index stores the vectors you supply through + upsert; this setting never computes embeddings for them. """ embedding_vector_columns: VariableOrList[EmbeddingVectorColumn] = field( default_factory=list ) """ - The columns that contain the embedding vectors. The format should be array[double]. + The column that holds the embedding vectors you write to the index. Exactly one column must be + specified, and `schema_json` must declare it as `array` or `array`. """ schema_json: VariableOrOptional[str] = None """ - The schema of the index in JSON format. + JSON object that maps each column name of the index to its type, serialized to a string. The + primary key and the embedding vector column must be present. Supported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`. - Supported types for vector column: `array`, `array`,`. + Supported types for vector column: `array`, `array`. """ @classmethod @@ -57,19 +61,23 @@ class DirectAccessVectorIndexSpecDict(TypedDict, total=False): embedding_source_columns: VariableOrList[EmbeddingSourceColumnParam] """ - The columns that contain the embedding source. The format should be array[double]. + Embedding source configuration used to embed `query_text` when the index is queried with text, + naming the embedding model endpoint to use. The index stores the vectors you supply through + upsert; this setting never computes embeddings for them. """ embedding_vector_columns: VariableOrList[EmbeddingVectorColumnParam] """ - The columns that contain the embedding vectors. The format should be array[double]. + The column that holds the embedding vectors you write to the index. Exactly one column must be + specified, and `schema_json` must declare it as `array` or `array`. """ schema_json: VariableOrOptional[str] """ - The schema of the index in JSON format. + JSON object that maps each column name of the index to its type, serialized to a string. The + primary key and the embedding vector column must be present. Supported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`. - Supported types for vector column: `array`, `array`,`. + Supported types for vector column: `array`, `array`. """ diff --git a/python/databricks/bundles/vector_search_indexes/_models/embedding_source_column.py b/python/databricks/bundles/vector_search_indexes/_models/embedding_source_column.py index 7debdc3f104..3fd996c8af0 100644 --- a/python/databricks/bundles/vector_search_indexes/_models/embedding_source_column.py +++ b/python/databricks/bundles/vector_search_indexes/_models/embedding_source_column.py @@ -27,7 +27,7 @@ class EmbeddingSourceColumn: name: VariableOrOptional[str] = None """ - Name of the column + Name of the column that contains the text to embed. """ @classmethod @@ -53,7 +53,7 @@ class EmbeddingSourceColumnDict(TypedDict, total=False): name: VariableOrOptional[str] """ - Name of the column + Name of the column that contains the text to embed. """ diff --git a/python/databricks/bundles/vector_search_indexes/_models/embedding_vector_column.py b/python/databricks/bundles/vector_search_indexes/_models/embedding_vector_column.py index b8efd6b4f0c..86996e5bc27 100644 --- a/python/databricks/bundles/vector_search_indexes/_models/embedding_vector_column.py +++ b/python/databricks/bundles/vector_search_indexes/_models/embedding_vector_column.py @@ -22,7 +22,7 @@ class EmbeddingVectorColumn: name: VariableOrOptional[str] = None """ - Name of the column + Name of the column that contains the embedding vectors. """ @classmethod @@ -43,7 +43,7 @@ class EmbeddingVectorColumnDict(TypedDict, total=False): name: VariableOrOptional[str] """ - Name of the column + Name of the column that contains the embedding vectors. """ diff --git a/python/databricks/bundles/vector_search_indexes/_models/vector_search_index.py b/python/databricks/bundles/vector_search_indexes/_models/vector_search_index.py index dba21478b1f..06c7fe610e5 100644 --- a/python/databricks/bundles/vector_search_indexes/_models/vector_search_index.py +++ b/python/databricks/bundles/vector_search_indexes/_models/vector_search_index.py @@ -51,19 +51,19 @@ class VectorSearchIndex(Resource): index_type: VariableOr[VectorIndexType] """ - There are 2 types of AI Search indexes: - - `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates. + Type of index to create, which determines which spec field is required. """ name: VariableOr[str] """ - Name of the index + Three-level Unity Catalog name of the index to create. """ primary_key: VariableOr[str] """ - Primary key of the index + Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of + the source table; for a Direct Vector Access index it must be declared in `schema_json`. It + cannot be the embedding source or embedding vector column. """ delta_sync_index_spec: VariableOrOptional[DeltaSyncVectorIndexSpecRequest] = None @@ -111,19 +111,19 @@ class VectorSearchIndexDict(TypedDict, total=False): index_type: VariableOr[VectorIndexTypeParam] """ - There are 2 types of AI Search indexes: - - `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates. + Type of index to create, which determines which spec field is required. """ name: VariableOr[str] """ - Name of the index + Three-level Unity Catalog name of the index to create. """ primary_key: VariableOr[str] """ - Primary key of the index + Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of + the source table; for a Direct Vector Access index it must be declared in `schema_json`. It + cannot be the embedding source or embedding vector column. """ delta_sync_index_spec: VariableOrOptional[DeltaSyncVectorIndexSpecRequestParam] From 07faa91d9ac5710166539b8b038fc6df3fbbb5d7 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Wed, 18 Nov 2026 13:25:06 +0000 Subject: [PATCH 2/2] Complete the Go SDK v0.201.0 bump Merge main, regenerate (`generate-check` and `test-update` produce no further changes), and finish what the bumper could not: - Restore the acceptance goldens for cmd/pypi-wheel, cmd/workspace/apps/run-local-node and ssh/agent-launchers to their `main` content: the bumper's image has no uvx, node or sshd, so `test-update` baked those environment errors into them. - Append the PR link to the changelog fragment. - Hand fix: suppress staticcheck SA1019 on the three `compute.Library.Egg` uses (bundle/direct/dresources/cluster.go, bundle/libraries/helpers.go and its test). The SDK deprecates the field, but `egg` remains a supported bundle library type, matching how the other deprecated SDK fields are handled. Co-authored-by: Isaac --- .../dependency-updates/go-sdk-v0.201.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 ++++++++++++++++++- bundle/direct/dresources/cluster.go | 1 + bundle/libraries/helpers.go | 1 + bundle/libraries/helpers_test.go | 2 +- 7 files changed, 77 insertions(+), 7 deletions(-) diff --git a/.nextchanges/dependency-updates/go-sdk-v0.201.0.md b/.nextchanges/dependency-updates/go-sdk-v0.201.0.md index d1d2662700a..7bd8159abb2 100644 --- a/.nextchanges/dependency-updates/go-sdk-v0.201.0.md +++ b/.nextchanges/dependency-updates/go-sdk-v0.201.0.md @@ -1 +1 @@ -* Update the Go SDK to [v0.201.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.201.0). +* Update the Go SDK to [v0.201.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.201.0). ([#7769](https://github.com/databricks/cli/pull/7769)) 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 diff --git a/bundle/direct/dresources/cluster.go b/bundle/direct/dresources/cluster.go index 82167080c4d..f1e85872cc7 100644 --- a/bundle/direct/dresources/cluster.go +++ b/bundle/direct/dresources/cluster.go @@ -634,6 +634,7 @@ func libraryWaitKey(l compute.Library) (string, string) { return "whl", l.Whl case l.Jar != "": return "jar", l.Jar + //nolint:staticcheck // SA1019: egg libraries are deprecated in the SDK but remain a supported bundle config field case l.Egg != "": return "egg", l.Egg case l.Requirements != "": diff --git a/bundle/libraries/helpers.go b/bundle/libraries/helpers.go index 5a1a9511c2d..6d6e88d5cc0 100644 --- a/bundle/libraries/helpers.go +++ b/bundle/libraries/helpers.go @@ -13,6 +13,7 @@ func libraryPath(library *compute.Library) (string, error) { if library.Jar != "" { return library.Jar, nil } + //nolint:staticcheck // SA1019: egg libraries are deprecated in the SDK but remain a supported bundle config field if library.Egg != "" { return library.Egg, nil } diff --git a/bundle/libraries/helpers_test.go b/bundle/libraries/helpers_test.go index ac4993c6df1..1ba10e6ee53 100644 --- a/bundle/libraries/helpers_test.go +++ b/bundle/libraries/helpers_test.go @@ -18,7 +18,7 @@ func TestLibraryPath(t *testing.T) { assert.Equal(t, path, p) assert.NoError(t, err) - p, err = libraryPath(&compute.Library{Egg: path}) + p, err = libraryPath(&compute.Library{Egg: path}) //nolint:staticcheck // SA1019: egg libraries are deprecated in the SDK but remain a supported bundle config field assert.Equal(t, path, p) assert.NoError(t, err)